Checkout API
Genera links de checkout para tus clientes utilizando nuestra API. Recibe notificaciones cuando cambie el estado de una transacción. Crea cobros directos a tarjetas guardadas.
Esta sección cubre los conceptos básicos de los servicios y los detalles técnicos de la API REST de Directo Pago. Contiene ejemplos funcionales de las solicitudes y observaciones importantes que deben tenerse en cuenta durante la integración.
Todas las llamadas a la API devolverán respuestas JSON, incluidos errores.
Es recomendable que la integración se realice creando una cuenta en nuestro ambiente de pruebas, más información aquí.

Servicios

post
https://checkout-api.directopago.com
/v1/checkout
Checkout Creation

Example request:

1
curl -X POST \
2
-H 'Content-Type: application/json' \
3
-H 'Authorization: Bearer PGickJNyZHrcNWZjZbewzLDtdoOrpuIM' \
4
-d '{body}'
5
https://checkout-api.directopago.com/v1/checkout
Copied!

Simplest request Body (Creates a checkout for every supported country in USD):

1
{
2
"amount": 10
3
}
Copied!

Request Body for a specific country and currency:

1
{
2
"amount": 10,
3
"currency": "USD",
4
"country": "MX"
5
}
Copied!

Cobros con cardId

Para realizar un cobro con un cardId guardado previamente mediante nuestra solución de Tokenización, se debe hacer de la siguiente manera:

Request Body:

1
{
2
"amount": "100",
3
"currency": "USD",
4
"cardToken": "CID-6051f971-1193-4f59-8aa3-f03bdba3adc6"
5
}
Copied!

Response Body:

1
{
2
"invoiceId": "126307563352994",
3
"country": "MX",
4
"amount": 100,
5
"currency": "USD",
6
"localAmount": 2000,
7
"localCurrency": "MXN",
8
"createdDate": "2021-07-08T17:36:44.191553",
9
"status": "COMPLETED"
10
}
Copied!

Borrar tarjeta guardada:

1
curl -X DELETE \
2
-H 'Content-Type: application/json' \
3
-H 'Authorization: Bearer PGickJNyZHrcNWZjZbewzLDtdoOrpuIM' \
4
https://checkout-api.directopago.com/v1/cards/CID-6051f971-1193-4f59-8aa3-f03bdba3adc6
Copied!
Puedes consultar los posibles códigos de error de este servicio aquí.

Notificaciones de cambios de estado

Al crear un checkout, se permite enviar una URL a la cual se notificarán los cambios de estado que ocurran sobre la transacción creada.
post
https://checkout-api.directopago.com
/v1/checkout
Checkout creation with notification URL

Example request:

1
curl -X POST \
2
-H 'Content-Type: application/json' \
3
-H 'Authorization: Bearer PGickJNyZHrcNWZjZbewzLDtdoOrpuIM' \
4
-d '{body}'
5
https://checkout-api.directopago.com/v1/checkout
Copied!

Request body:

1
{
2
"amount": 10,
3
"currency": "USD",
4
"country": "MX",
5
"notificationUrl": "https://www.yoursite.com/directopago/ipn"
6
}
Copied!

Ejemplo de notificación

post
https://www.yoursite.com
/directopago/ipn
Cuando se recibe una notificación de cambio de estado, se debe consultar al siguiente servicio con su API Key correspondiente.
get
https://checkout-api.directopago.com
/v1/transactions/{invoiceId}
Transaction status

Example request:

1
curl -X GET \
2
-H 'Content-Type: application/json' \
3
-H 'Authorization: Bearer PGickJNyZHrcNWZjZbewzLDtdoOrpuIM' \
4
https://checkout-api.directopago.com/v1/transactions/12033902754885
Copied!
Estados posibles para una transacción: PENDING, COMPLETED, CANCELLED, DECLINED.
Puedes consultar los posibles códigos de error de este servicio aquí.
Para ver qué moneda y tipos de documento son válidos para cada país, accede aquí.
Última actualización 1mo ago