API Orden de Pago - Deprecated
El API de Orden de Pago le permite al Merchant crear una orden de pago única para cada cliente.
Flujo API
Merchant: Por medio de su ERP o software de facturación consume API Pagoralia para crear una orden de pago.
Este proceso crea una nueva orden de pago única dentro del perfil del cliente, la cual permanecerá disponible para su pago hasta que efectivamente sea pagada por el cliente o cancelada por el ERP, por medio de la API Cancelación orden de pago.
En caso exitoso la API devolverá la URL única perteneciente al perfil del cliente para que realice el pago por el método que él elija.
Para integrarte con el API de Orden de Pago, apunta tus peticiones a las siguientes URLs de acuerdo con tu ambiente.
API Orden de Pago
Orden de Pago
POST https://{merchant-abrev}.pagoralia.live/api/v2/orders
Este endpoint te permite crear órdenes de pago.
Headers
Authorization*
Bearer {merchant-token}
String
Ejemplo Respuesta
Variables para la Petición
language
Alfanumérico
2
Idioma utilizado en la petición, este idioma se utiliza para mostrar los mensajes de error generados. Por ahora solo soportado español es.
Sí
transaction
Este objeto tiene los datos de la transacción.
Sí
transaction > paymentCountry
Alfanumérico
3
Asigna MEX para México.
Sí
transaction > deviceSessionId
Alfanumérico
Max:255
Identificador de la sesión del dispositivo donde el cliente realiza la transacción.
No
transaction > ipAddress
Alfanumérico
Max:39
Dirección IP del dispositivo donde el cliente realiza la transacción.
Sí
transaction > cookie
Alfanumérico
Max:255
Cookie almacenada por el dispositivo donde el cliente realiza la transacción.
No
transaction > userAgent
Alfanumérico
Max:255
User agent del navegador donde el cliente realiza la transacción.
Sí
transaction > payer
Información del pagador.
Sí
transaction > payer > merchantPayerId
Alfanumérico
Max:100
Identificador del pagador en tu sistema.
Sí
transaction > payer > dniNumber
Alfanumérico
Max:50
Número de identificación del pagador.
No
transaction > payer > document_type
Alfanumérico
5
Tipo de identificación del pagador.
No
transaction > payer > firstName
Alfanumérico
Max:150
Nombre del pagador.
Sí
transaction > payer > lastName
Alfanumérico
Max:150
Apellido del pagador.
Sí
transaction > payer > emailAddress
Alfanumérico
Max:255
Correo electrónico del pagador.
Sí
transaction > payer > contactPhone
Alfanumérico
Max:20
Número de teléfono del pagador.
No
transaction > payer > birthdate
Date
Format: yyyy-mm-dd
Fecha de nacimiento del pagador.
No
transaction > payer > billingAddress
Dirección de facturación.
Sí
transaction > payer > billingAddress > street1
Alfanumérico
Max:100
Línea 1 de la dirección de facturación.
Sí
transaction > payer > billingAddress > street2
Alfanumérico
Max:100
Línea 2 de la dirección de facturación.
Sí
transaction > payer > billingAddress > city
Alfanumérico
Max:50
Ciudad de la dirección de facturación.
Sí
transaction > payer > billingAddress > state
Alfanumérico
Max:40
Estado o provincia de la dirección de facturación.
No
transaction > payer > billingAddress > country
Alfanumérico
3
País de la dirección de facturación en formato ISO 3166-1 Alpha-3.
No
transaction > creditCard
Información de la tarjeta de crédito. Si procesas utilizando tarjeta débito, no envíes este parámetro.
No
transaction > extraParameters
Parámetros adicionales o datos asociados a la petición.
No
transaction > order
Este objeto tiene los datos de la orden.
Sí
transaction > order > referenceCode
Alfanumérico
Min:1 Max:255
Representa el identificador de la orden en tu sistema.
Sí
transaction > order > additionalValues >
64
Monto de la orden y sus valores asociados.
Sí
transaction > order > additionalValues > TX_VALUE > value
Numérico
12, 2
Especifica el monto de la transacción, este valor puede tener dos dígitos decimales (Ej. 10000.00 o 10000).
Sí
transaction > order > additionalValues > TX_VALUE > currency
Alfanumérico
3
Código ISO de la moneda.
Sí
transaction > order > description
Alfanumérico
Max:255
Descripción de la orden.
No
transaction > order > buyer
Información del comprador.
Sí
transaction > order > buyer > merchantBuyerId
Alfanumérico
Max:100
Identificador del comprador en tu sistema.
Sí
transaction > order > buyer > dniNumber
Alfanumérico
Max:50
Número de identificación del comprador.
No
transaction > order > buyer > document_type
Alfanumérico
5
Tipo de identificación del pagador.
No
transaction > order > buyer > firstName
Alfanumérico
Max:150
Nombre del comprador.
Sí
transaction > order > buyer > lastName
Alfanumérico
Max:150
Apellido del comprador.
Sí
transaction > order > buyer > emailAddress
Alfanumérico
Max:255
Correo electrónico de comprador.
No
transaction > order > buyer > contactPhone
Alfanumérico
Max:20
Teléfono del comprador.
No
transaction > order > buyer > shippingAddress
Alfanumérico
Dirección de envío del comprador.
Sí
transaction > order > buyer > shippingAddress > street1
Alfanumérico
Max:150
Línea de dirección 1 del comprador.
Sí
transaction > order > buyer > shippingAddress > street2
Alfanumérico
Max:150
Línea de dirección 2 del comprador.
Sí
transaction > order > buyer > shippingAddress > city
Alfanumérico
Max:50
Ciudad de la dirección del comprador.
Sí
transaction > order > buyer > shippingAddress > state
Alfanumérico
Max:40
Estado o provincia de la dirección del comprador.
No
transaction > order > buyer > shippingAddress > country
Alfanumérico
3
País de la dirección del comprador en formato ISO 3166-1 alpha-3.
Sí
Respuesta
406
La Moneda no es compatible con el servicio
423
La Orden ya existe
422
Validaciones de datos de solicitud | json mal formado
401
Token not provided | Invalid token
200
Satisfactorio
BODY Respuesta
data
Contiene todos los datos de respuesta.
data > id
Numérico
Id de orden generado.
data > payer_id
Numérico
Id del pagador.
data > total
Numérico
Total pagado.
data > currency
Alfanumérico
Código ISO de la moneda.
data > reference
Alfanumérico
Código de referencia.
data > notes
Texto
Notas de respuesta.
data > status
Alfanumérico
Estado de la orden de pago.
data > redirect_url
URL
Url de redirección para el pago.
data > created_at
Date
Fecha de creación de la orden de pago.
data > updated_at
Date
Fecha de actualización de la orden de pago.
Ejemplo Json
Last updated