Debi (anteriormente TuCuota) tiene una API REST. Nuestra API tiene direcciones URL predecibles orientadas a los recursos, acepta solicitudes JSON, devuelve respuestas JSON y utiliza códigos de respuesta, autenticación y verbos HTTP estándar.
Las URLs de la API de Debi API son:
- Producción: https://api.debi.pro/
- Sandbox: https://api.debi-test.pro/
Content type
La API de Debi sólo soporta JSON
. No te olvides de incluir el siguiente header en tus requests.
Content-Type Header
Content-Type: "application/json"
La API solo está disponible a través de HTTPS. Intentar acceder a la API a través de una conexión HTTP no segura devolverá un error tls_required
.
Crear una clave API
Para crear nuevas claves API, visite la sección de desarrolladores de nuestro sitio.
Para cada entorno (producción y sandbox), encontrará dos tipos de claves de API:
- Pública (
pk_...
): puede aparecer en su código del lado del cliente para tokenizar los métodos de pago. - Secreta (
sk_...
): Para ser utilizado en el lado del servidor. Debe ser secreto y almacenarse de forma segura en el código de su aplicación para comunicarse con la API de Debi.
Para autenticarse, debe utilizar la clave de API en un Header del request HTTP al realizar solicitudes en la API.
Example Authentication Header
Authorization: Bearer sk_live_...
Todas las solicitudes de API deben realizarse a través de HTTPS. Las llamadas realizadas a través de HTTP fallarán. Las solicitudes de API sin autenticación también fallarán.
This API uses HTTP status codes to communicate with the API consumer.
200 OK
- Response to a successful GET, PUT, PATCH or DELETE.201 Created
- Response to a POST that results in a creation.204 No Content
- Response to a successful request that won't be returning a body (like a DELETE request).400 Bad Request
- Malformed request.401 Unauthorized
- When no or invalid authentication details are provided.403 Forbidden
- When authentication succeeded but authenticated user doesn't have access to the resource.404 Not Found
- When a non-existent resource is requested.405 Method Not Allowed
- Method not allowed.406 Not Acceptable
- Could not satisfy the request Accept header.415 Unsupported Media Type
- Unsupported media type in request.422 Unprocessable Entity
- Form validation errors.
Respuestas de Error
Esta API devuelve códigos de error legibles por máquina y mensajes de error legibles por humanos cuando hay un error.
Ejemplos
Error de Validación
{
"message": "The given data was invalid.",
"errors": {
"organization_name": ["El campo debe tener algún valor."],
"mobile_number": ["El campo debe tener algún valor."],
"province": ["El campo debe tener algún valor."],
"locality": ["El campo debe tener algún valor."],
"address": ["El campo debe tener algún valor."]
}
}
Error Genérico
{
"message": "Unauthenticated."
}
La API admite la idempotencia para volver a intentar solicitudes de forma segura sin realizar accidentalmente la misma operación dos veces. Esto es útil cuando una llamada API se interrumpe en tránsito y no recibe una respuesta. Por ejemplo, si una solicitud para crear un pago no responde debido a un error de conexión a la red, puede volver a intentar la solicitud con la misma clave de idempotencia para garantizar que no se cree más de un cargo.
Para realizar una solicitud idempotente, envía un encabezado Idempotency-Key: <key>
adicional en la llamada HTTP.
La idempotencia funciona guardando el código de estado y el contenido de la primera solicitud realizada para cualquier clave de idempotencia dada, independientemente de si tuvo éxito o no. Las solicitudes posteriores con la misma clave devuelven el mismo resultado, incluidos los errores 500.
Una clave de idempotencia es un valor único generado por el cliente que el servidor utiliza para reconocer reintentos posteriores de la misma solicitud. La forma en que crea claves únicas depende de usted, pero sugerimos usar UUID V4 u otra cadena aleatoria con suficiente entropía para evitar colisiones.
Las claves son elegibles para eliminarse del sistema después de que tengan al menos 24 horas de antigüedad, y se genera una nueva solicitud si una clave se reutiliza después de que se eliminó la original. La capa de idempotencia compara los parámetros entrantes con los de la solicitud original y los errores a menos que sean los mismos para evitar el uso indebido accidental.
Los resultados solo se guardan si un extremo de la API comenzó a ejecutarse. Si los parámetros entrantes fallaron en la validación o la solicitud entró en conflicto con otra que se estaba ejecutando al mismo tiempo, no se guarda ningún resultado idempotente porque ningún extremo de la API comenzó a ejecutarse. Es seguro volver a intentar estas solicitudes.
Todas las solicitudes POST
aceptan claves de idempotencia. El envío de claves de idempotencia en solicitudes GET
y DELETE
no tiene ningún efecto y debe evitarse, ya que estas solicitudes son idempotentes por definición.
Los siguientes objetos tienen un parámetro metadata
que puedes usar para guardar pares de clave-valor:
La metadata es útil para almacenar información estructurada adicional sobre un objeto.
No almacene información confidencial (números de cuentas bancarias, detalles de tarjetas, etc.) como metadata.
Todos los recursos de la API pueden listarse a través de métodos de la API. Por ejemplo, puede obtener pagos, obtener clientes y obtener suscripciones. Estos métodos API de lista comparten una estructura común, tomando al menos estos tres parámetros: limit
, starting_after
y ending_before
.
La respuesta de un método API de lista representa una sola página en un orden cronológico inverso. Si no especificas starting_after
o ending_before
, recibirás la primera página de este objecto, que contiene los objetos más nuevos. Puede especificar un ID en el campo starting_after
para obtener la página de objetos más antiguos que aparecen inmediatamente después del objeto en cuestión. De manera similar, puedes especificar ending_before
para recibir una página de objetos más nuevos que ocurren inmediatamente antes del objeto en cuestión. Los objetos de una página siempre aparecen en orden cronológico inverso. Solo se puede usar starting_after
o ending_before
.
Cada request a la API tiene un identificador de request asociado. Puede encontrar este valor en el header Request-Id
. También puede encontrar estos IDs en logs de requests en su Panel.
Notational Conventions
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC2119.
HTTP Methods
This API uses HTTP verbs (methods) as following:
GET
- Read - used to read (or retrieve) a representation of a resource,POST
- Create - used to create new resources. In particular, it's used to create subordinate resources.PUT
- Update/Replace - used for update capabilities, PUT-ing to a known resource URI with the request body containing the newly-updated representation of the original resource. On successful request, replaces identified resource with the request body.PATCH
- Update/Modify - used for modify capabilities. The PATCH request only needs to contain the changes to the resource, not the complete resource.DELETE
- Delete - used to delete a resource identified by a URI.
Representation of Date and Time
All exchange of date and time-related data MUST be done according to RFC339 standard.
Versioning
This API uses Api-Version
header to identify requested version. Every minor version SHOULD be backward compatible. However, major versions MAY introduce breaking changes.
Api-Version:
This header SHOULD be present in every request. If not, API MUST use the newest available major release.
If requested version is not available, API SHOULD try to fall back to the next available minor release.
When backwards-incompatible changes are made to the API, a new, dated version is released. The current version of the API is 2022-02-14
.
Resource IDs
This API uses short non-sequential url-friendly unique ids. Every resource id MUST consists of 12 url-friendly characters: A-Z
, a-z
, 0-9
, _
and -
.
Example
PY6b3Rr6nRMo
En modo sandbox, las siguientes tarjetas de prueba y cuentas bancarias se pueden usar para crear pagos que producen respuestas específicas útiles para probar diferentes escenarios.
Number | Type | Status | Network | Funding |
---|---|---|---|---|
4242424242424242 | card | approved | visa | credit |
4000056655665556 | card | approved | visa | debit |
4507990000004905 | card | approved | visa | credit |
5555555555554444 | card | approved | mastercard | credit |
5896570000000008 | card | approved | mastercard | credit |
2223003122003222 | card | approved | mastercard | credit |
5200828282828210 | card | approved | mastercard | debit |
5105105105105100 | card | approved | mastercard | prepaid |
6042451111111117 | card | approved | discover | credit |
6011111111111117 | card | approved | discover | credit |
6011000990139424 | card | approved | discover | credit |
6011981111111113 | card | approved | discover | debit |
5299910010000015 | card | approved | discover | credit |
3056930009020004 | card | approved | diners | credit |
36227206271667 | card | approved | diners | credit |
3566002020360505 | card | approved | jcb | credit |
378282246310005 | card | approved | amex | credit |
371449635398431 | card | approved | amex | credit |
4000000000005126 | card | submitted | visa | credit |
4000000000003220 | card | submitted | visa | credit |
5895622082273045 | card | approved | naranja | credit |
5895622082273044 | card | rejected | naranja | credit |
2859363672283668188432 | cbu | approved | ||
3220001823000055910025 | cbu | approved | ||
8258975011100070754947 | cbu | rejected | ||
1212000002283668188432 | cbu | rejected | ||
4000000000000002 | card | rejected | visa | credit |
4338308001478538 | card | rejected | visa | credit |
4000000000009995 | card | rejected | visa | credit |
4000000000009987 | card | rejected | visa | credit |
4000000000009979 | card | rejected | visa | credit |
371449635398432 | card | rejected | amex | credit |
ES9314651865289152293582 | sepa_debit | approved | ||
ES9520808952147978933326 | sepa_debit | rejected | ||
NL69ABNA4040435087 | sepa_debit | approved | ||
NL57INGB4461857859 | sepa_debit | rejected | ||
GB81BARC20038047151643 | sepa_debit | approved | ||
GB75BARC20039513113527 | sepa_debit | rejected |
Si creas una tarjeta con el número 4000000320000021
, recibirás un evento payment_method.automatically_updated
similar al que recibirías durante una renovación de una tarjeta de crédito.
Los webhooks son URLs que puedes configurar para recibir notificaciones sobre eventos que suceden en tu cuenta de Debi. La mayoría de los usuarios configuran los webhooks desde el panel, que proporciona una interfaz de usuario para registrar y probar sus webhooks.
Webhook de ejemplo:
{
"id": "EVPYeJeyeJ7r",
"created_at": "2019-05-23T20:18:28-0300",
"data": {
"object": {
"id": "CS9PL8eeo8aB",
"paid": false,
"amount": 1600,
"status": "pending_submission",
"gateway": "GWd1e9nQwK7v",
"currency": "ARS",
"customer": {
"id": "CS9PL8eeo8aB",
"name": "Máximo Irizarry",
"email": "mirrizarry@paez.com",
"livemode": true,
"metadata": { "key": "value" },
"created_at": "2018-05-01T11:45:14-0300",
"updated_at": "2018-05-01T11:45:14-0300",
"gateway_identifier": "001234",
"mobile_number": "+5493812596655",
"identification_type": "",
"identification_number": ""
},
"livemode": true,
"metadata": { "key": "value" },
"retryable": false,
"created_at": "2018-05-01T11:45:14-0300",
"updated_at": "2018-05-01T11:45:14-0300",
"charge_date": "2019-05-15",
"description": "Pago extra",
"subscription": null,
"name": "Máximo Irizarry",
"email": "mirrizarry@paez.com",
"gateway_identifier": "456700",
"mobile_number": "+5493812596655",
"identification_type": "",
"identification_number": ""
}
},
"livemode": true,
"resource": "payment",
"resource_id": "PY6b3Rr6nRMo",
"type": "payment.retrying"
}
Cuando ocurre un evento en su cuenta, lo enviaremos a cada webhook habilitado como una solicitud POST.
Tipos de eventos de Webhooks
checkout.session.async_payment_failed
checkout.session.async_payment_succeeded
checkout.session.completed
checkout.session.expired
customer.created
customer.disabled
customer.restored
customer.updated
gateway.created
gateway.disabled
gateway.enabled
gateway.updated
import.processed
mandate.created
mandate.restored
mandate.revoked
payment.cancelled
payment.created
payment.retrying
payment.updated
payment_method.automatically_updated
payment_method.created
payment_method.updated
refund.approved
refund.created
refund.failed
subscription.automatically_paused
subscription.cancelled
subscription.created
subscription.finished
subscription.paused
subscription.resumed
subscription.updated
user.updated_available_brands
Prueba de los webhooks en entornos locales
You can easy create test webhooks using https://webhook.site/ With that you will be able to see what we are sending to our API consumers.
Also, to start integrating the webhooks, your code will need to be accessible from the internet so Debi can reach it with HTTP requests. If you’re working locally, the easiest way to do this is with ngrok.
Asegurando los Webhooks
Debi signs the webhook events it sends to your endpoints by including a signature in each event’s Debi-Signature header. This allows you to verify that the events were sent by Debi, not by a third party.
Before you can verify signatures, you need to retrieve your endpoint’s secret "Secreto webhook" from your webhooks in our developers panel. Add or select the endpoint you want to obtain the secret for, then click the "mostrar" button.
Debi generates a unique secret key for each endpoint. If you use the same endpoint for both test and live API keys, note that the secret is different for each one. Additionally, if you use multiple endpoints, you must obtain a secret for each one you want to verify signatures on. After this setup, Debi starts to sign each webhook it sends to the endpoint.
Webhooks authenticity validation steps
Debi generates signatures using a hash-based message authentication code (HMAC) with SHA-256. To prevent downgrade attacks.
Step 1: Extract the timestamp and signatures from the header
Split the header, using the , character as the separator, to get a list of elements. Then split each element, using the = character as the separator, to get a prefix and value pair.
The value for the prefix t corresponds to the timestamp, and v1 corresponds to the signature (or signatures). You can discard all other elements.
Step 2: Prepare the signed_payload string
The signed_payload string is created by concatenating:
The timestamp (as a string) The character . The actual JSON payload (that is, the request body)
Step 3: Determine the expected signature
Compute an HMAC with the SHA256 hash function. Use the endpoint’s signing secret as the key, and use the signed_payload string as the message.
Step 4: Compare the signatures
Compare the signature (or signatures) in the header to the expected signature. For an equality match, compute the difference between the current timestamp and the received timestamp, then decide if the difference is within your tolerance.
To protect against timing attacks, use a constant-time string comparison to compare the expected signature to each of the received signatures.
Este objeto representa a un cliente de su organización. Le permite crear suscripciones y realizar un seguimiento de los pagos que pertenecen al mismo cliente.
id required | string Identificador único del Cliente. |
name required | null or string El nombre completo del cliente. |
email required | null or string El email del cliente. |
object required | string Value: "customer" |
livemode required | boolean Tiene el valor |
metadata required | object or null Conjunto de pares clave/valor que puede adjuntar
a un objeto. Esto puede ser útil para almacenar información
sobre el objeto en un formato estructurado.
Todas las claves se pueden borrar publicando un valor |
mobile_number required | null or string Número de teléfono válido del cliente (con código de área). |
default_payment_method_id | null or string |
gateway_identifier required | null or string La referencia del cliente en los extractos bancarios. |
identification_number required | null or string Número del Documento del cliente. |
identification_type required | null or string Tipo de Documento del cliente. |
created_at | string <date-time> Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: |
updated_at required | string <date-time> Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: |
deleted_at required | null or string <date-time> Hora en la que se eliminó el objeto. Formato: RFC339. Ejemplo: |
{- "id": "CS3Z25Agp708",
- "object": "customer",
- "gateway_identifier": 1723393503,
- "name": "Andrés Bahena Tercero",
- "email": "andres37@calvillo.info",
- "identification_type": null,
- "identification_number": null,
- "mobile_number": "+5481934863501",
- "metadata": {
- "external_id": "0Qk3IJY5"
}, - "livemode": true,
- "created_at": "2021-07-05T12:24:32-03:00",
- "updated_at": "2021-07-05T12:24:32-03:00",
- "deleted_at": null
}
Obtener todos los clientes
Por defecto, los clientes más nuevos serán los primeros en la lista.
Authorizations:
query Parameters
all | boolean Incluye clientes archivados. |
object (range_query_specs) Un filtro en la lista, basado en el campo | |
ending_before | string Un cursor para utilizar en la paginación. |
limit | integer Example: limit=20 Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25. |
starting_after | string Un cursor para utilizar en la paginación. |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request GET \ --url 'https://api.debi.pro/v1/customers?all=SOME_BOOLEAN_VALUE&created_at=SOME_OBJECT_VALUE&ending_before=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE' \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 200
- 401
{- "data": [
- {
- "id": "CS3Z25Agp708",
- "object": "customer",
- "gateway_identifier": "1723393503",
- "name": "Andrés Bahena Tercero",
- "email": "andres37@calvillo.info",
- "identification_type": null,
- "identification_number": null,
- "mobile_number": "+5481934863501",
- "metadata": {
- "external_id": "0Qk3IJY5"
}, - "livemode": true,
- "created_at": "2021-07-05T12:24:32-03:00",
- "updated_at": "2021-07-05T12:24:32-03:00",
- "deleted_at": null
}
], - "links": {
- "first": null,
- "last": null,
- "prev": null
},
}
Crear un cliente
Crear un cliente.
Authorizations:
Request Body schema: application/jsonrequired
name | null or string El nombre completo del cliente. |
null or string El email del cliente. | |
gateway_identifier | null or string La referencia del cliente en los extractos bancarios. |
identification_type | null or string Tipo de Documento del cliente. |
identification_number | null or string Número del Documento del cliente. |
metadata | object or null Conjunto de pares clave/valor que puede adjuntar
a un objeto. Esto puede ser útil para almacenar información
sobre el objeto en un formato estructurado.
Todas las claves se pueden borrar publicando un valor |
Responses
Request samples
- Payload
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
{- "name": "Pedro Lombardo",
- "email": "pedrolombardo@email.com",
- "gateway_identifier": "1234",
- "identification_type": "DNI",
- "identification_number": "237767265",
- "metadata": {
- "some": "value"
}
}
Response samples
- 201
- 401
- 422
{- "data": {
- "id": "CS3Z25Agp708",
- "object": "customer",
- "gateway_identifier": "1234",
- "name": "Pedro Lombardo",
- "email": "pedrolombardo@email.com",
- "identification_type": "DNI",
- "identification_number": "237767265",
- "mobile_number": null,
- "metadata": {
- "some": "value"
}, - "livemode": true,
- "created_at": "2021-07-05T12:24:32-03:00",
- "updated_at": "2021-07-05T12:24:32-03:00",
- "deleted_at": null
}
}
Obtener un cliente
Obtener un cliente.
Authorizations:
path Parameters
id required |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request GET \ --url https://api.debi.pro/v1/customers/CS9PL8eeo8aB \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 200
- 401
- 404
{- "data": {
- "id": "CSljikas98",
- "name": "Jorgelina Castro",
- "email": "mail@example.com",
- "object": "customer",
- "livemode": true,
- "metadata": {
- "some": "metadata"
}, - "mobile_number": "5491164531234",
- "default_payment_method_id": "PMBja4YZ2GDR.",
- "gateway_identifier": "383473",
- "identification_number": "15.555.324",
- "identification_type": "DNI",
- "created_at": "2022-02-11T23:19:22-03:00",
- "updated_at": "2022-02-11T23:19:22-03:00",
- "deleted_at": "2022-02-11T23:19:22-03:00"
}
}
Actualiza un cliente
Actualiza un cliente.
Authorizations:
path Parameters
id required |
Request Body schema: application/jsonrequired
name | null or string El nombre completo del cliente. |
null or string El email del cliente. | |
gateway_identifier | null or string La referencia del cliente en los extractos bancarios. |
identification_type | null or string Tipo de Documento del cliente. |
identification_number | null or string Número del Documento del cliente. |
metadata | object or null Conjunto de pares clave/valor que puede adjuntar
a un objeto. Esto puede ser útil para almacenar información
sobre el objeto en un formato estructurado.
Todas las claves se pueden borrar publicando un valor |
Responses
Request samples
- Payload
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
{- "name": "Pedro Lombardo",
- "email": "pedrolombardo@email.com"
}
Response samples
- 200
- 401
- 404
- 422
{- "data": {
- "id": "CSljikas98",
- "name": "Jorgelina Castro",
- "email": "mail@example.com",
- "object": "customer",
- "livemode": true,
- "metadata": {
- "some": "metadata"
}, - "mobile_number": "5491164531234",
- "default_payment_method_id": "PMBja4YZ2GDR.",
- "gateway_identifier": "383473",
- "identification_number": "15.555.324",
- "identification_type": "DNI",
- "created_at": "2022-02-11T23:19:22-03:00",
- "updated_at": "2022-02-11T23:19:22-03:00",
- "deleted_at": "2022-02-11T23:19:22-03:00"
}
}
Archivar un cliente
Archivar un cliente y cancelar suscripciones y pagos en proceso.
Authorizations:
path Parameters
id required |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request POST \ --url https://api.debi.pro/v1/customers/CS9PL8eeo8aB/actions/archive \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 200
- 401
- 404
{- "message": "Archived successfully"
}
Restaurar un cliente
Restaurar inmediatamente un cliente.
Authorizations:
path Parameters
id required |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request POST \ --url https://api.debi.pro/v1/customers/CS9PL8eeo8aB/actions/restore \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 200
- 401
- 404
{- "message": "Restored successfully"
}
Buscar clientes
Buscar clientes.
Authorizations:
query Parameters
q required | |
limit | integer Example: limit=20 Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25. |
page required | string Example: page=john doe Un cursor para la paginación en varias páginas de resultados. No incluya este parámetro en la primera llamada. Utilice el valor de |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request GET \ --url 'https://api.debi.pro/v1/customers/search?q=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&page=SOME_STRING_VALUE' \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 200
- 401
{- "data": [
- {
- "id": "CS3Z25Agp708",
- "object": "customer",
- "gateway_identifier": "1723393503",
- "name": "Andrés Bahena Tercero",
- "email": "andres37@calvillo.info",
- "identification_type": null,
- "identification_number": null,
- "mobile_number": "+5481934863501",
- "metadata": {
- "external_id": "0Qk3IJY5"
}, - "livemode": true,
- "created_at": "2021-07-05T12:24:32-03:00",
- "updated_at": "2021-07-05T12:24:32-03:00",
- "deleted_at": null
}
], - "links": {
}, - "meta": {
- "per_page": 25,
- "total": 2500
}
}
Los eventos son nuestra forma de avisarte cuando sucede algo interesante en tu cuenta. Cuando ocurre un evento, creamos un nuevo objeto Evento. Por ejemplo, cuando se actualiza un pago, creamos un evento de pago actualizado. Tenga en cuenta que muchas solicitudes de API pueden provocar la creación de varios eventos. Por ejemplo, si crea una nueva suscripción para un cliente, recibirá un evento creado por la suscripción del cliente y un evento creado por el pago.
Los eventos ocurren cuando cambia el estado de otro recurso API. El estado del recurso al momento del cambio está embebido en el campo data
del evento. Por ejemplo, un evento de payment.updated
contendrá un pago y un evento customer.created
contendrá un cliente.
id | string Identificador único del Evento. |
object | string Value: "event" |
created_at | string <date-time> Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: |
object | |
delivered_at | null or string <date-time> Hora en que se entregó el evento. Formato: RFC339. Ejemplo: |
livemode | boolean Tiene el valor |
resource | string Enum: "customer" "gateway" "import" "mandate" "payment" "payment_method" "subscription" Recurso relacionado con el evento. |
resource_id | string ID del recurso relacionado con el evento. |
type | string Enum: "checkout.session.async_payment_failed" "checkout.session.async_payment_succeeded" "checkout.session.completed" "checkout.session.expired" "customer.created" "customer.disabled" "customer.restored" "customer.updated" "gateway.created" "gateway.disabled" "gateway.enabled" "gateway.updated" "import.processed" "mandate.created" "mandate.restored" "mandate.revoked" "payment.cancelled" "payment.created" "payment.retrying" "payment.updated" "payment_method.automatically_updated" "payment_method.created" "payment_method.updated" "refund.approved" "refund.created" "refund.failed" "subscription.automatically_paused" "subscription.cancelled" "subscription.created" "subscription.finished" "subscription.paused" "subscription.resumed" "subscription.updated" "user.updated_available_brands" Tipo de evento. |
{- "created_at": "2022-02-05T01:42:13-03:00",
- "data": {
- "object": {
- "created_at": "2022-02-05T01:42:13-03:00",
- "deleted_at": null,
- "email": "john@doe.com",
- "gateway_identifier": "383473",
- "id": "CSnlZxyY3jwr",
- "identification_number": null,
- "identification_type": null,
- "livemode": true,
- "metadata": null,
- "mobile_number": "5491154876503",
- "name": "John Doe",
- "updated_at": "2022-02-05T01:42:13-03:00"
}
}, - "delivered_at": "2022-02-11T20:11:38-03:00",
- "id": "EVaX3JagwR6x",
- "livemode": true,
- "object": "event",
- "resource": "customer",
- "resource_id": "CSnlZxyY3jwr",
- "type": "customer.created"
}
Obtener eventos
Obtener una lista páginada por cursor de tus eventos.
Authorizations:
query Parameters
delivery_success | boolean Filtre los eventos seg ún si todos los webhooks se entregaron correctamente. Si es falso, se muestran eventos que aún están pendientes o cuyos intentos intentos de entrega hayan fallado. |
related_object | string <= 255 characters Example: related_object=CS9PL8eeo8aB Filtra eventos para un objeto en particular. Puede recibir cualquier ID de cualquier objecto. |
type | string <= 255 characters Puede contener un nombre de evento específico o un grupo de eventos utilizando |
object (range_query_specs) Un filtro en la lista, basado en el campo | |
ending_before | string Un cursor para utilizar en la paginación. |
limit | integer Example: limit=20 Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25. |
starting_after | string Un cursor para utilizar en la paginación. |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request GET \ --url 'https://api.debi.pro/v1/events?delivery_success=SOME_BOOLEAN_VALUE&related_object=SOME_STRING_VALUE&type=SOME_STRING_VALUE&created_at=SOME_OBJECT_VALUE&ending_before=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE' \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 200
- 401
{- "data": [
- {
- "created_at": "2022-02-05T01:42:13-03:00",
- "data": {
- "object": {
- "created_at": "2022-02-05T01:42:13-03:00",
- "deleted_at": null,
- "email": "john@doe.com",
- "gateway_identifier": "383473",
- "id": "CSnlZxyY3jwr",
- "identification_number": null,
- "identification_type": null,
- "livemode": true,
- "metadata": null,
- "mobile_number": "5491154876503",
- "name": "John Doe",
- "updated_at": "2022-02-05T01:42:13-03:00"
}
}, - "delivered_at": "2022-02-11T20:11:38-03:00",
- "id": "EVaX3JagwR6x",
- "livemode": true,
- "object": "event",
- "resource": "customer",
- "resource_id": "CSnlZxyY3jwr",
- "type": "customer.created"
}
], - "links": {
- "first": null,
- "last": null,
},
}
Obtener un evento
Obtener un evento.
Authorizations:
path Parameters
id required |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request GET \ --url https://api.debi.pro/v1/events/EVaX3JagwR6x \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 200
- 401
- 404
{- "data": {
- "id": "EVm3RnKn3knw",
- "object": "event",
- "created_at": "2022-02-11T23:19:22-03:00",
- "data": {
- "object": { }
}, - "delivered_at": "2022-02-11T23:19:22-03:00",
- "livemode": true,
- "resource": "customer",
- "resource_id": "CS12312d1d1dl",
- "type": "customer.created"
}
}
Un gateway es una institución que autoriza y facilita los pagos. Puede ser un procesador de pagos, un banco o una red de tarjetas. En Debi, el objeto gateway representa la configuración específica y las credenciales que tu empresa utiliza para acceder a cada servicio.
approved_at | string <date-time> Hora en la que el gateway se marcó como aprobado. Formato: RFC339. Ejemplo: |
code_length | null or number Longitud del código |
created_at | string <date-time> Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: |
disabled | boolean Declara si el gateway está deshabilitado. |
id | string Identificador único del Gateway. |
livemode | boolean Tiene el valor |
number | string Identificador para el procesador. |
number_bank_retries | null or number Número de reintentos bancarios. |
object | string Value: "gateway" |
provider | string Enum: "amex" "bac" "banamex" "banistmo" "banorte" "cabal" "cbu-bind" "cbu-galicia" "cbu-patagonia" "favacard" "fiserv-argentina" "fiserv-mexico" "mercado-pago" "naranja" "payway" "prisma-visa" "prisma-visa-debit" "prisma-mastercard" "wompi" Proveedor. |
object Medios de pago soportados por este Gateway. | |
updated_at | string <date-time> Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: |
username | string Nombre de usuario actual del Gateway. |
{- "approved_at": "2023-02-14T11:41:40-03:00",
- "code_length": null,
- "created_at": "2023-01-31T16:18:31-03:00",
- "disabled": false,
- "id": "GWM8DK6VKoG3",
- "livemode": false,
- "number": "1203764444",
- "number_bank_retries": null,
- "object": "gateway",
- "provider": "mercado-pago",
- "supported_payment_methods": {
- "card": {
- "networks": [
- "diners",
- "jcb",
- "mastercard",
- "visa"
], - "required_fields": [
- "security_code"
]
}
}, - "updated_at": "2023-02-01T16:36:06-03:00",
- "username": "user@name.com"
}
Listado de Gateways
Obtener una lista de todas sus gateways.
Authorizations:
query Parameters
ending_before | string Un cursor para utilizar en la paginación. |
limit | integer Example: limit=20 Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25. |
starting_after | string Un cursor para utilizar en la paginación. |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request GET \ --url 'https://api.debi.pro/v1/gateways?ending_before=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE' \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 200
- 401
{- "data": [
- {
- "approved_at": "2023-02-14T11:41:40-03:00",
- "code_length": null,
- "created_at": "2023-02-01T16:33:19-03:00",
- "disabled": false,
- "id": "GWBZqKYEK7Y2",
- "livemode": false,
- "number": "12345",
- "number_bank_retries": null,
- "object": "gateway",
- "provider": "wompi",
- "supported_payment_methods": {
- "card": {
- "networks": [
- "diners",
- "jcb",
- "mastercard",
- "visa"
], - "required_fields": [ ]
}
}, - "updated_at": "2023-02-02T01:35:53-03:00",
- "username": "WS8112000000032._.1"
}, - {
- "approved_at": "2023-02-14T11:41:40-03:00",
- "code_length": null,
- "created_at": "2023-01-31T16:18:31-03:00",
- "disabled": false,
- "id": "GWM8DK6VKoG3",
- "livemode": false,
- "number": "1203764444",
- "number_bank_retries": null,
- "object": "gateway",
- "provider": "mercado-pago",
- "supported_payment_methods": {
- "card": {
- "networks": [
- "diners",
- "jcb",
- "mastercard",
- "visa"
], - "required_fields": [
- "security_code"
]
}
}, - "updated_at": "2023-02-01T16:36:06-03:00",
- "username": "user@name.com"
}
], - "links": {
}, - "meta": {
- "next_cursor": null,
- "per_page": 25,
- "prev_cursor": null,
- "total": 7
}
}
Una Importación es un objeto que contiene datos para ser creados en Debi. Como estos objetos pueden ser grandes, se crearán y procesarán más tarde. Puede comprobar el estado de la importación.
id | string Identificador único de la Importación. |
batch_job | object |
cancelled_at | null or string <date-time> Hora en la que se canceló la importación. Formato: RFC339. Ejemplo: |
invalid_at | null or string <date-time> Hora en la que la importación se marcó como inválida. Formato: RFC339. Ejemplo: |
processed_at | null or string <date-time> Hora en la que la importación se marcó como procesada. Formato: RFC339. Ejemplo: |
ready_at | null or string <date-time> Hora en la que la importación se marcó como lista. Formato: RFC339. Ejemplo: |
invalid_rows_count | number Cantidad de filas no válido |
valid_rows_count | number Cantidad de filas válidas |
rows_count | number Cantidad de filas |
livemode | boolean Tiene el valor |
original_filename | string |
type | string Tipo de importación |
status | string Estado de importación |
created_at | string <date-time> Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: |
updated_at | string <date-time> Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: |
{- "batch_job": {
- "created_at": "2021-06-08T12:49:06-03:00",
- "failed_jobs": 0,
- "finished_at": "2021-06-08T12:49:06-03:00",
- "pending_jobs": 0,
- "progress": 100,
- "total_jobs": 2
}, - "cancelled_at": null,
- "created_at": "2021-06-08T09:49:04-03:00",
- "id": "IMB1rRDqkM5X",
- "invalid_at": null,
- "invalid_rows_count": 0,
- "livemode": true,
- "original_filename": "subscriptions-import-template.csv",
- "processed_at": "2021-06-08T09:49:06-03:00",
- "ready_at": "2021-06-08T09:49:05-03:00",
- "rows_count": 2,
- "status": "processed",
- "type": "subscriptions",
- "updated_at": "2021-06-08T09:49:06-03:00",
- "valid_rows_count": 2
}
Listado de Importaciones
Obtener una lista de todas sus importaciones.
Authorizations:
query Parameters
search | string Example: search=foo@bar.com Search. |
status | string Example: status=ready Valores permitidos: |
object (range_query_specs) Un filtro en la lista, basado en el campo | |
ending_before | string Un cursor para utilizar en la paginación. |
limit | integer Example: limit=20 Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25. |
starting_after | string Un cursor para utilizar en la paginación. |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request GET \ --url 'https://api.debi.pro/v1/imports?search=SOME_STRING_VALUE&status=SOME_STRING_VALUE&created_at=SOME_OBJECT_VALUE&ending_before=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE' \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 200
- 401
{- "data": [
- {
- "id": "IMKd7zlGJAna",
- "type": "customers",
- "status": "invalid",
- "livemode": true,
- "rows_count": 2,
- "valid_rows_count": 0,
- "invalid_rows_count": 2,
- "created_at": "2020-11-20T02:38:14-03:00",
- "updated_at": "2020-11-20T02:38:14-03:00",
- "invalid_at": "2020-11-20T02:38:14-03:00"
}, - {
- "id": "IMGdOz9vReVZ",
- "type": "customers",
- "status": "ready",
- "livemode": true,
- "rows_count": 2,
- "valid_rows_count": 2,
- "invalid_rows_count": 0,
- "created_at": "2020-11-20T02:37:48-03:00",
- "updated_at": "2020-11-20T02:37:49-03:00",
- "ready_at": "2020-11-20T02:37:49-03:00"
}
], - "links": {
}, - "meta": {
- "next_cursor": null,
- "per_page": 25,
- "prev_cursor": null,
- "total": 7
}
}
Crear una importación
Crear una importación.
Authorizations:
Request Body schema: application/jsonrequired
type | string |
filename | string |
original_filename | string |
auto | boolean |
metadata | object or null Conjunto de pares clave/valor que puede adjuntar
a un objeto. Esto puede ser útil para almacenar información
sobre el objeto en un formato estructurado.
Todas las claves se pueden borrar publicando un valor |
Responses
Request samples
- Payload
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
{- "type": "customers",
- "filename": "a.csv",
- "original_filename": "a.csv",
- "auto": true
}
Response samples
- 201
- 401
- 422
{- "data": {
- "id": "IM129038120h",
- "batch_job": { },
- "cancelled_at": "2022-02-11T23:19:22-03:00",
- "invalid_at": "2022-02-11T23:19:22-03:00",
- "processed_at": "2022-02-11T23:19:22-03:00",
- "ready_at": "2022-02-11T23:19:22-03:00",
- "invalid_rows_count": 0,
- "valid_rows_count": 0,
- "rows_count": 0,
- "livemode": true,
- "original_filename": "subscriptions-import-template.csv",
- "type": "subscriptions",
- "status": "processed",
- "created_at": "2022-02-11T23:19:22-03:00",
- "updated_at": "2022-02-11T23:19:22-03:00"
}
}
Obtener una importación
Obtener una importación.
Authorizations:
path Parameters
id required | string Example: IMKd7zlGJAna Import ID. |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request GET \ --url https://api.debi.pro/v1/imports/IMKd7zlGJAna \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 200
- 401
- 404
{- "data": {
- "id": "IM129038120h",
- "batch_job": { },
- "cancelled_at": "2022-02-11T23:19:22-03:00",
- "invalid_at": "2022-02-11T23:19:22-03:00",
- "processed_at": "2022-02-11T23:19:22-03:00",
- "ready_at": "2022-02-11T23:19:22-03:00",
- "invalid_rows_count": 0,
- "valid_rows_count": 0,
- "rows_count": 0,
- "livemode": true,
- "original_filename": "subscriptions-import-template.csv",
- "type": "subscriptions",
- "status": "processed",
- "created_at": "2022-02-11T23:19:22-03:00",
- "updated_at": "2022-02-11T23:19:22-03:00"
}
}
Obtener filas de una Importación
Obtener filas de una Importación.
Authorizations:
path Parameters
id required | string Example: IMKd7zlGJAna Import ID. |
query Parameters
filter | string Validation. Example: valid. Allows values: valid, invalid. |
object (range_query_specs) Un filtro en la lista, basado en el campo | |
ending_before | string Un cursor para utilizar en la paginación. |
limit | integer Example: limit=20 Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25. |
starting_after | string Un cursor para utilizar en la paginación. |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request GET \ --url 'https://api.debi.pro/v1/imports/IMKd7zlGJAna/rows?filter=SOME_STRING_VALUE&created_at=SOME_OBJECT_VALUE&ending_before=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE' \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 200
- 401
{- "data": [
- {
- "id": "IRGdOz9vReVZ",
- "valid": true,
- "data": {
- "name": "Yimi Jendri",
- "email": "yimi@jendri.co",
- "metadata": {
- "dni": 23456789
}
}, - "livemode": false,
- "resource": "customer",
- "resource_id": "CSWVJD6bD5yr",
- "created_at": "2022-01-10T10:00:00-03:00",
- "updated_at": "2022-01-10T10:00:00-03:00"
}, - {
- "id": "IRKd7zlGJAna",
- "valid": true,
- "data": {
- "name": "John Doe",
- "email": "john@doe.co",
- "metadata": {
- "dni": 23789456
}
}, - "livemode": false,
- "resource": "customer",
- "resource_id": "CSbJrDMEDaW9",
- "created_at": "2022-01-10T10:00:00-03:00",
- "updated_at": "2022-01-10T10:00:00-03:00"
}
], - "links": {
}, - "meta": {
- "total": 2730,
- "next_cursor": null,
- "per_page": 1000,
- "prev_cursor": null
}
}
Un Link es una URL compartible que llevará a sus clientes a una página de pago/adhesión. Los Links pueden crear adhesiones, pagos o suscripciones fácilmente. Un Link se puede compartir y utilizar varias veces.
Cuando un cliente abre un Link de pago, el siguiente paso creará una nueva Sesión de pago para mostrar la página. Puede utilizar los eventos de la Sesión de pago para realizar un seguimiento de los resultados.
id | string Identificador único del objeto. |
uuid | string Identificador UUID del objeto. [Legacy] |
livemode | boolean Tiene el valor |
metadata | object or null Conjunto de pares clave/valor que puede adjuntar
a un objeto. Esto puede ser útil para almacenar información
sobre el objeto en un formato estructurado.
Todas las claves se pueden borrar publicando un valor |
extra_fields | object or null Una colección de campos diseñados para almacenarse como metadatos del objeto que la Sesión está generando, ya sea un Pago, Suscripción o Adhesión. Esta funcionalidad te permite solicitar información adicional al usuario durante el proceso de pago, brindando una manera de almacenar detalles complementarios sobre el objeto en un formato bien organizado. |
extra_fields_customer | object or null Una colección de campos diseñados para almacenarse como metadatos del Cliente que la Sesión está generando. Esta funcionalidad te permite solicitar información adicional al usuario durante el proceso de pago, brindando una manera de almacenar detalles complementarios sobre el objeto en un formato bien organizado. |
created_at | string <date-time> Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: |
updated_at | string <date-time> Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: |
deleted_at | null or string <date-time> Hora en la que se eliminó el objeto. Formato: RFC339. Ejemplo: |
{- "body": "hoiadsad ad sad",
- "brands": [ ],
- "button_text": null,
- "created_at": "2022-02-02T02:06:22.00-03:00",
- "deleted_at": null,
- "enabled": true,
- "extra_fields": [ ],
- "extra_fields_customer": [ ],
- "id": "LKLj0JV8xzdMoRk549",
- "uuid": "b7fba990-83cc-11ec-8c7b-5b2fd150abb2",
- "kind": "payment",
- "livemode": true,
- "metadata": null,
- "name_text": null,
- "object": "link",
- "options": [
- {
- "amount": "100",
- "count": null,
- "description": "mucho",
- "editable_amount": false,
- "editable_count": false,
- "installments": 1,
- "interval": "1",
- "interval_unit": "monthly",
- "max_installments": null,
- "show_count": false,
- "show_installments": false
}, - {
- "amount": "75",
- "count": null,
- "description": "poco",
- "editable_amount": false,
- "editable_count": false,
- "installments": 1,
- "interval": "1",
- "interval_unit": "monthly",
- "max_installments": null,
- "show_count": false,
- "show_installments": false
}
], - "success_url": null,
- "title": "Test options",
- "updated_at": "2022-02-02T02:06:22.00-03:00",
- "user": {
- "country": "AR",
- "currency": "ARS",
- "email": "pedrolombardo@email.com",
- "organization_name": "Debi",
- "preference_color1": "#ffffff",
- "preference_color2": "#d10000",
}
}
Listado de Links
Obtener una lista con todos sus Links.
Authorizations:
query Parameters
search | string Example: search=foo@bar.com Search. |
object (range_query_specs) Un filtro en la lista, basado en el campo | |
ending_before | string Un cursor para utilizar en la paginación. |
limit | integer Example: limit=20 Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25. |
starting_after | string Un cursor para utilizar en la paginación. |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request GET \ --url 'https://api.debi.pro/v1/links?search=SOME_STRING_VALUE&created_at=SOME_OBJECT_VALUE&ending_before=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE' \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 200
- 401
{- "data": [
- {
- "id": "string",
- "uuid": "43751655-7580-4bd7-8bad-3c54ed1c4abc",
- "livemode": true,
- "metadata": {
- "some": "metadata"
}, - "extra_fields": [
- {
- "name": "source",
- "type": "select",
- "label": "Cómo nos conociste?",
- "options": {
- "key_1": "Opción 1",
- "key_2": "Opción 2"
}
}, - {
- "name": "age",
- "label": "Edad"
}
], - "extra_fields_customer": [
- {
- "name": "identification_type",
- "type": "select",
- "label": "Tipo de documento",
- "options": {
- "dni": "DNI",
- "cuit": "CUIT",
- "rut": "RUT",
- "cif": "CIF",
- "passport": "Pasaporte"
}
}, - {
- "name": "identification_number",
- "type": "text",
- "label": "Número de documento"
}
], - "created_at": "2022-02-11T23:19:22-03:00",
- "updated_at": "2022-02-11T23:19:22-03:00",
- "deleted_at": "2022-02-11T23:19:22-03:00"
}
], - "links": {
}, - "meta": {
- "per_page": 25,
- "total": 2500,
- "next_cursor": null,
- "prev_cursor": null
}
}
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request POST \ --url https://api.debi.pro/v1/links \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 201
- 401
{- "data": {
- "id": "string",
- "uuid": "43751655-7580-4bd7-8bad-3c54ed1c4abc",
- "livemode": true,
- "metadata": {
- "some": "metadata"
}, - "extra_fields": [
- {
- "name": "source",
- "type": "select",
- "label": "Cómo nos conociste?",
- "options": {
- "key_1": "Opción 1",
- "key_2": "Opción 2"
}
}, - {
- "name": "age",
- "label": "Edad"
}
], - "extra_fields_customer": [
- {
- "name": "identification_type",
- "type": "select",
- "label": "Tipo de documento",
- "options": {
- "dni": "DNI",
- "cuit": "CUIT",
- "rut": "RUT",
- "cif": "CIF",
- "passport": "Pasaporte"
}
}, - {
- "name": "identification_number",
- "type": "text",
- "label": "Número de documento"
}
], - "created_at": "2022-02-11T23:19:22-03:00",
- "updated_at": "2022-02-11T23:19:22-03:00",
- "deleted_at": "2022-02-11T23:19:22-03:00"
}
}
Obtener un link
Obtener un link.
Authorizations:
path Parameters
id required | string Example: LKLj0JV8xzdMoRk549 Link ID. |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request GET \ --url https://api.debi.pro/v1/links/LKLj0JV8xzdMoRk549 \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 200
- 401
{- "data": {
- "id": "string",
- "uuid": "43751655-7580-4bd7-8bad-3c54ed1c4abc",
- "livemode": true,
- "metadata": {
- "some": "metadata"
}, - "extra_fields": [
- {
- "name": "source",
- "type": "select",
- "label": "Cómo nos conociste?",
- "options": {
- "key_1": "Opción 1",
- "key_2": "Opción 2"
}
}, - {
- "name": "age",
- "label": "Edad"
}
], - "extra_fields_customer": [
- {
- "name": "identification_type",
- "type": "select",
- "label": "Tipo de documento",
- "options": {
- "dni": "DNI",
- "cuit": "CUIT",
- "rut": "RUT",
- "cif": "CIF",
- "passport": "Pasaporte"
}
}, - {
- "name": "identification_number",
- "type": "text",
- "label": "Número de documento"
}
], - "created_at": "2022-02-11T23:19:22-03:00",
- "updated_at": "2022-02-11T23:19:22-03:00",
- "deleted_at": "2022-02-11T23:19:22-03:00"
}
}
Actualizar un Link
Actualizar un Link.
Authorizations:
path Parameters
id required | string Example: LKLj0JV8xzdMoRk549 Link ID. |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request PUT \ --url https://api.debi.pro/v1/links/LKLj0JV8xzdMoRk549 \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 200
- 401
- 422
{- "data": {
- "id": "string",
- "uuid": "43751655-7580-4bd7-8bad-3c54ed1c4abc",
- "livemode": true,
- "metadata": {
- "some": "metadata"
}, - "extra_fields": [
- {
- "name": "source",
- "type": "select",
- "label": "Cómo nos conociste?",
- "options": {
- "key_1": "Opción 1",
- "key_2": "Opción 2"
}
}, - {
- "name": "age",
- "label": "Edad"
}
], - "extra_fields_customer": [
- {
- "name": "identification_type",
- "type": "select",
- "label": "Tipo de documento",
- "options": {
- "dni": "DNI",
- "cuit": "CUIT",
- "rut": "RUT",
- "cif": "CIF",
- "passport": "Pasaporte"
}
}, - {
- "name": "identification_number",
- "type": "text",
- "label": "Número de documento"
}
], - "created_at": "2022-02-11T23:19:22-03:00",
- "updated_at": "2022-02-11T23:19:22-03:00",
- "deleted_at": "2022-02-11T23:19:22-03:00"
}
}
Una Adhesión es un registro del permiso que un cliente te ha dado para debitar su método de pago.
id | string Identificador único de la Adhesión. |
status | string Enum: "active" "revoked" Estado. |
uuid | string Identificador UUID del objeto. [Legacy] |
object | string Value: "mandate" |
livemode | boolean Tiene el valor |
object (Cliente) Este objeto representa a un cliente de su organización. | |
object (Método de pago) Este objeto representa un Método de Pago de su cuenta. | |
metadata | object or null Conjunto de pares clave/valor que puede adjuntar
a un objeto. Esto puede ser útil para almacenar información
sobre el objeto en un formato estructurado.
Todas las claves se pueden borrar publicando un valor |
created_at | string <date-time> Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: |
updated_at | string <date-time> Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: |
deleted_at | null or string <date-time> Hora en la que se eliminó el objeto. Formato: RFC339. Ejemplo: |
{- "created_at": "2022-02-01T19:06:37-03:00",
- "customer": {
- "created_at": "2022-02-05T01:42:13-03:00",
- "deleted_at": null,
- "email": "john@doe.com",
- "gateway_identifier": "383473",
- "id": "CSnlZxyY3jwr",
- "identification_number": null,
- "identification_type": null,
- "livemode": true,
- "metadata": null,
- "mobile_number": "5491154876503",
- "name": "John Doe",
- "updated_at": "2022-02-05T01:42:13-03:00"
}, - "deleted_at": null,
- "id": "MA9aQOWen2kZe6qypB",
- "uuid": "3990a740-83ab-11ec-8651-cde6203c968e",
- "livemode": true,
- "metadata": {
- "dni": "1231232131"
}, - "object": "mandate",
- "payment_method": {
- "card": {
- "name": "Visa",
- "network": "visa",
- "issuer": null,
- "country": "AR",
- "expiration_month": null,
- "expiration_year": null,
- "fingerprint": "0sZQikKp4lImAgIo",
- "funding": "credit",
- "last_four_digits": "4242",
- "providers": {
- "available": [
- "fiserv-argentina"
], - "preferred": "fiserv-argentina"
}
}, - "created_at": "2022-02-01T23:13:04-03:00",
- "id": "PMBja4YZ2GDR",
- "livemode": true,
- "metadata": null,
- "object": "payment_method",
- "type": "card",
- "updated_at": "2022-02-01T23:13:04-03:00"
}, - "status": "active",
- "updated_at": "2022-02-01T19:06:37-03:00"
}
Obtener todos las adhesiones
Por defecto, las adhesiones más nuevas serán los primeras en la lista.
Authorizations:
query Parameters
all | boolean Incluye adhesiones archivadas. |
customer_id | |
object (range_query_specs) Un filtro en la lista, basado en el campo | |
ending_before | string Un cursor para utilizar en la paginación. |
limit | integer Example: limit=20 Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25. |
starting_after | string Un cursor para utilizar en la paginación. |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request GET \ --url 'https://api.debi.pro/v1/mandates?all=SOME_BOOLEAN_VALUE&customer_id=SOME_STRING_VALUE&created_at=SOME_OBJECT_VALUE&ending_before=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE' \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 200
- 401
{- "data": [
- {
- "id": "MAmQ6j9NWxblNv",
- "status": "active",
- "uuid": "43751655-7580-4bd7-8bad-3c54ed1c4abc",
- "object": "mandate",
- "livemode": true,
- "customer": {
- "id": "CSljikas98",
- "name": "Jorgelina Castro",
- "email": "mail@example.com",
- "object": "customer",
- "livemode": true,
- "metadata": {
- "some": "metadata"
}, - "mobile_number": "5491164531234",
- "default_payment_method_id": "PMBja4YZ2GDR.",
- "gateway_identifier": "383473",
- "identification_number": "15.555.324",
- "identification_type": "DNI",
- "created_at": "2022-02-11T23:19:22-03:00",
- "updated_at": "2022-02-11T23:19:22-03:00",
- "deleted_at": "2022-02-11T23:19:22-03:00"
}, - "payment_method": {
- "id": "PMyma6Ql8Wo9",
- "object": "payment_method",
- "type": "card",
- "card": {
- "country": "AR",
- "expiration_month": 11,
- "expiration_year": 2030,
- "fingerprint": "8712yh2uihiu1123sxas",
- "funding": "credit",
- "issuer": "argencard",
- "last_four_digits": "9876",
- "name": "Visa",
- "network": "visa",
- "providers": {
- "available": [
- "fiserv-argentina"
], - "preferred": "fiserv-argentina"
}
}, - "sepa_debit": {
- "bank": "string",
- "country": "NL",
- "fingerprint": "8712yh2uihiu1123sxas",
- "identification": { },
- "last_four_digits": "9876",
- "providers": {
- "available": [
- "santander-es"
], - "preferred": [
- "santander-es"
]
}
}, - "cbu": {
- "bank": "string",
- "country": "AR",
- "fingerprint": "8712yh2uihiu1123sxas",
- "identification": { },
- "last_four_digits": "9876",
- "providers": {
- "available": [
- "cbu-galicia"
], - "preferred": "cbu-galicia"
}
}, - "livemode": true,
- "metadata": {
- "some": "metadata"
}, - "created_at": "2022-02-11T23:19:22-03:00",
- "updated_at": "2022-02-11T23:19:22-03:00"
}, - "metadata": {
- "some": "metadata"
}, - "created_at": "2022-02-11T23:19:22-03:00",
- "updated_at": "2022-02-11T23:19:22-03:00",
- "deleted_at": "2022-02-11T23:19:22-03:00"
}
], - "links": {
}, - "meta": {
- "per_page": 25,
- "total": 2500,
- "next_cursor": null,
- "prev_cursor": null
}
}
Crear una adhesión
Crear una adhesión.
Authorizations:
Request Body schema: application/jsonoptional
customer_id | string |
payment_method_id | string |
Responses
Request samples
- Payload
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
{- "customer_id": "CS3oDRqz9wzB",
- "payment_method_id": "PMBja4YZ2GDR"
}
Response samples
- 201
- 401
{- "data": {
- "id": "3d48eb80-a5a3-11ea-8439-bdd053d1a65b",
- "object": "mandate",
- "livemode": true,
- "status": "active",
- "created_at": "2020-06-03T11:05:11-03:00",
- "updated_at": "2020-06-03T11:05:11-03:00",
- "customer": {
- "id": "CS3oDRqz9wzB",
- "object": "customer",
- "gateway_identifier": "1234",
- "name": "John",
- "email": "john@doe.com",
- "identification_type": "",
- "identification_number": "",
- "mobile_number": "",
- "livemode": true,
- "updated_at": "2020-06-03T11:05:11-03:00",
- "created_at": "2020-06-03T11:05:11-03:00"
}, - "payment_method": {
- "card": {
- "name": "Visa",
- "network": "visa",
- "issuer": null,
- "country": "AR",
- "expiration_month": null,
- "expiration_year": null,
- "fingerprint": "0sZQikKp4lImAgIo",
- "funding": "credit",
- "last_four_digits": "4242",
- "providers": {
- "available": [
- "fiserv-argentina"
], - "preferred": "fiserv-argentina"
}
}, - "created_at": "2022-02-01T23:13:04-03:00",
- "id": "PMBja4YZ2GDR",
- "livemode": true,
- "metadata": null,
- "object": "payment_method",
- "type": "card",
- "updated_at": "2022-02-01T23:13:04-03:00"
}
}
}
Obtener una adhesión
Obtener una adhesión.
Authorizations:
path Parameters
id required |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request GET \ --url https://api.debi.pro/v1/mandates/MA9aQOWen2kZe6qypB \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 200
- 401
- 404
{- "data": {
- "id": "MAmQ6j9NWxblNv",
- "status": "active",
- "uuid": "43751655-7580-4bd7-8bad-3c54ed1c4abc",
- "object": "mandate",
- "livemode": true,
- "customer": {
- "id": "CSljikas98",
- "name": "Jorgelina Castro",
- "email": "mail@example.com",
- "object": "customer",
- "livemode": true,
- "metadata": {
- "some": "metadata"
}, - "mobile_number": "5491164531234",
- "default_payment_method_id": "PMBja4YZ2GDR.",
- "gateway_identifier": "383473",
- "identification_number": "15.555.324",
- "identification_type": "DNI",
- "created_at": "2022-02-11T23:19:22-03:00",
- "updated_at": "2022-02-11T23:19:22-03:00",
- "deleted_at": "2022-02-11T23:19:22-03:00"
}, - "payment_method": {
- "id": "PMyma6Ql8Wo9",
- "object": "payment_method",
- "type": "card",
- "card": {
- "country": "AR",
- "expiration_month": 11,
- "expiration_year": 2030,
- "fingerprint": "8712yh2uihiu1123sxas",
- "funding": "credit",
- "issuer": "argencard",
- "last_four_digits": "9876",
- "name": "Visa",
- "network": "visa",
- "providers": {
- "available": [
- "fiserv-argentina"
], - "preferred": "fiserv-argentina"
}
}, - "sepa_debit": {
- "bank": "string",
- "country": "NL",
- "fingerprint": "8712yh2uihiu1123sxas",
- "identification": { },
- "last_four_digits": "9876",
- "providers": {
- "available": [
- "santander-es"
], - "preferred": [
- "santander-es"
]
}
}, - "cbu": {
- "bank": "string",
- "country": "AR",
- "fingerprint": "8712yh2uihiu1123sxas",
- "identification": { },
- "last_four_digits": "9876",
- "providers": {
- "available": [
- "cbu-galicia"
], - "preferred": "cbu-galicia"
}
}, - "livemode": true,
- "metadata": {
- "some": "metadata"
}, - "created_at": "2022-02-11T23:19:22-03:00",
- "updated_at": "2022-02-11T23:19:22-03:00"
}, - "metadata": {
- "some": "metadata"
}, - "created_at": "2022-02-11T23:19:22-03:00",
- "updated_at": "2022-02-11T23:19:22-03:00",
- "deleted_at": "2022-02-11T23:19:22-03:00"
}
}
Revocar una adhesión
Esta acción revocará la adhesión y también cancelará todos las suscripciones cancelables adjuntas al mismo customer
y al mismo payment_method
.
Authorizations:
path Parameters
id required |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request POST \ --url https://api.debi.pro/v1/mandates/MA9aQOWen2kZe6qypB/actions/revoke \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 401
{- "data": {
- "message": "Unauthorized"
}
}
Restaurar la adhesión
Esta acción restaurará la adhesión revocada.
Authorizations:
path Parameters
id required |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request POST \ --url https://api.debi.pro/v1/mandates/MA9aQOWen2kZe6qypB/actions/restore \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 401
{- "data": {
- "message": "Unauthorized"
}
}
Buscar adhesiones
Buscar adhesiones.
Authorizations:
query Parameters
q required | |
limit | integer Example: limit=20 Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25. |
page required | string Example: page=john doe Un cursor para la paginación en varias páginas de resultados. No incluya este parámetro en la primera llamada. Utilice el valor de |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request GET \ --url 'https://api.debi.pro/v1/mandates/search?q=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&page=SOME_STRING_VALUE' \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 200
- 401
{- "data": [
- {
- "created_at": "2022-02-01T19:06:37-03:00",
- "customer": {
- "created_at": "2022-02-05T01:42:13-03:00",
- "deleted_at": null,
- "email": "john@doe.com",
- "gateway_identifier": "383473",
- "id": "CSnlZxyY3jwr",
- "identification_number": null,
- "identification_type": null,
- "livemode": true,
- "metadata": null,
- "mobile_number": "5491154876503",
- "name": "John Doe",
- "object": "customer",
- "updated_at": "2022-02-05T01:42:13-03:00"
}, - "deleted_at": null,
- "id": "MA9aQOWen2kZe6qypB",
- "uuid": "3990a740-83ab-11ec-8651-cde6203c968e",
- "livemode": true,
- "metadata": {
- "dni": "1231232131"
}, - "object": "mandate",
- "payment_method": {
- "card": {
- "name": "Visa",
- "network": "visa",
- "issuer": null,
- "country": "AR",
- "expiration_month": null,
- "expiration_year": null,
- "fingerprint": "0sZQikKp4lImAgIo",
- "funding": "credit",
- "last_four_digits": "4242",
- "providers": {
- "available": [
- "fiserv-argentina"
], - "preferred": "fiserv-argentina"
}
}, - "created_at": "2022-02-01T23:13:04-03:00",
- "id": "PMBja4YZ2GDR",
- "livemode": true,
- "metadata": null,
- "object": "payment_method",
- "type": "card",
- "updated_at": "2022-02-01T23:13:04-03:00"
}, - "status": "active",
- "updated_at": "2022-02-01T19:06:37-03:00"
}
], - "links": {
}, - "meta": {
- "per_page": 25,
- "total": 2500
}
}
Estos objetos representan los Métodos de Pago de su cliente. Puede usarlos para crear pagos o suscripciones a un cliente.
id | string Identificador único del objeto. |
object | string Value: "payment_method" |
type | string Enum: "card" "sepa_debit" "cbu" Tipo de medio de pago. Uno de: |
object (Tarjeta de Crédito) Este objeto representa una tarjeta de crédito de su cuenta. | |
object (CBU) Este objeto representa el método de pago a través de débitos SEPA, utlizado para debitar cuentas bancarias en la región europea (SEPA). | |
object (CBU) Este objeto representa una cuenta bancaria (CBU) de su cuenta. | |
livemode | boolean Tiene el valor |
metadata | object or null Conjunto de pares clave/valor que puede adjuntar
a un objeto. Esto puede ser útil para almacenar información
sobre el objeto en un formato estructurado.
Todas las claves se pueden borrar publicando un valor |
created_at | string <date-time> Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: |
updated_at | string <date-time> Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: |
{- "card": {
- "name": "Visa",
- "network": "visa",
- "issuer": null,
- "country": "AR",
- "expiration_month": null,
- "expiration_year": null,
- "fingerprint": "0sZQikKp4lImAgIo",
- "funding": "credit",
- "last_four_digits": "4242",
- "providers": {
- "available": [
- "fiserv-argentina"
], - "preferred": "fiserv-argentina"
}
}, - "created_at": "2022-02-01T23:13:04-03:00",
- "id": "PMBja4YZ2GDR",
- "livemode": true,
- "metadata": null,
- "object": "payment_method",
- "type": "card",
- "updated_at": "2022-02-01T23:13:04-03:00"
}
Obtener todos los métodos de pago
Obtener una lista de métodos de pago.
Authorizations:
query Parameters
page | number Example: page=1 Cursor value to paginate response. |
limit | integer Example: limit=20 Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25. |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request GET \ --url 'https://api.debi.pro/v1/payment_methods?page=SOME_NUMBER_VALUE&limit=SOME_INTEGER_VALUE' \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 200
- 401
{- "data": [
- {
- "type": "card",
- "card": {
- "name": "Visa",
- "network": "visa",
- "country": "AR",
- "issuer": null,
- "fingerprint": "782uy3h1983gy7sl",
- "last_four_digits": "1481",
- "providers": {
- "available": [
- "fiserv-argentina"
], - "preferred": "fiserv-argentina"
}
}, - "created_at": "2019-01-28T15:27:29-03:00",
- "id": "PMVdYaYwkqOw",
- "livemode": true,
- "object": "payment_method",
- "updated_at": "2019-05-23T20:30:01-03:00"
}
], - "links": {
- "first": null,
- "last": null,
},
}
Crear un método de pago
Crear un método de pago
Authorizations:
Request Body schema: application/jsonoptional
type | string Enum: "card" "sepa_debit" "cbu" Uno de |
object (Tarjeta) Este objeto representa una tarjeta de su cuenta. | |
object (CBU) Este objeto representa una cuenta bancaria (CBU) de su cuenta. | |
object (Débito Sepa (Iban)) Este objeto representa un método de pago para débito directo a una cuenta IBAN de la región de pagos Europea. | |
strict | boolean Si es verdadero, el método de pago no se podrá crear si la cuenta no tiene habilitado un medio de cobro para procesar este método de pago. |
Responses
Request samples
- Payload
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
{- "type": "card",
- "card": {
- "number": "4242424242424242",
- "expiration_year": 2032,
- "expiration_month": 5,
- "security_code": "123"
}, - "strict": true
}
Response samples
- 201
- 401
- 422
{- "data": {
- "card": {
- "country": "AR",
- "expiration_month": null,
- "expiration_year": null,
- "fingerprint": "0sZQikKp4lImAgIo",
- "issuer": null,
- "funding": "credit",
- "last_four_digits": "4242",
- "name": "Visa",
- "network": "visa",
- "providers": {
- "available": [
- "fiserv-argentina"
], - "preferred": "fiserv-argentina"
}
}, - "created_at": "2022-02-01T23:13:04-03:00",
- "id": "PMBja4YZ2GDR",
- "livemode": true,
- "metadata": null,
- "object": "payment_method",
- "type": "card",
- "updated_at": "2022-02-01T23:13:04-03:00"
}
}
Obtener un Método de Pago
Obtener un Método de Pago.
Authorizations:
path Parameters
id required | string Example: PMVA0W8y1aQO Payment method ID. |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request GET \ --url https://api.debi.pro/v1/payment_methods/PMVA0W8y1aQO \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 200
- 401
- 404
{- "data": {
- "id": "PMyma6Ql8Wo9",
- "object": "payment_method",
- "type": "card",
- "card": {
- "country": "AR",
- "expiration_month": 11,
- "expiration_year": 2030,
- "fingerprint": "8712yh2uihiu1123sxas",
- "funding": "credit",
- "issuer": "argencard",
- "last_four_digits": "9876",
- "name": "Visa",
- "network": "visa",
- "providers": {
- "available": [
- "fiserv-argentina"
], - "preferred": "fiserv-argentina"
}
}, - "sepa_debit": {
- "bank": "string",
- "country": "NL",
- "fingerprint": "8712yh2uihiu1123sxas",
- "identification": { },
- "last_four_digits": "9876",
- "providers": {
- "available": [
- "santander-es"
], - "preferred": [
- "santander-es"
]
}
}, - "cbu": {
- "bank": "string",
- "country": "AR",
- "fingerprint": "8712yh2uihiu1123sxas",
- "identification": { },
- "last_four_digits": "9876",
- "providers": {
- "available": [
- "cbu-galicia"
], - "preferred": "cbu-galicia"
}
}, - "livemode": true,
- "metadata": {
- "some": "metadata"
}, - "created_at": "2022-02-11T23:19:22-03:00",
- "updated_at": "2022-02-11T23:19:22-03:00"
}
}
Buscar métodos de pago
Buscar métodos de pago.
Authorizations:
query Parameters
q required | |
limit | integer Example: limit=20 Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25. |
page required | string Example: page=john doe Un cursor para la paginación en varias páginas de resultados. No incluya este parámetro en la primera llamada. Utilice el valor de |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request GET \ --url 'https://api.debi.pro/v1/payment_methods/search?q=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&page=SOME_STRING_VALUE' \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 200
- 401
{- "data": [
- {
- "card": {
- "name": "Visa",
- "network": "visa",
- "issuer": null,
- "country": "AR",
- "expiration_month": null,
- "expiration_year": null,
- "fingerprint": "0sZQikKp4lImAgIo",
- "funding": "credit",
- "last_four_digits": "4242",
- "providers": {
- "available": [
- "fiserv-argentina"
], - "preferred": "fiserv-argentina"
}
}, - "created_at": "2022-02-01T23:13:04-03:00",
- "id": "PMBja4YZ2GDR",
- "livemode": true,
- "metadata": null,
- "object": "payment_method",
- "type": "card",
- "updated_at": "2022-02-01T23:13:04-03:00"
}
], - "links": {
}, - "meta": {
- "per_page": 25,
- "total": 2500
}
}
Un pago es un objeto que crea para cargar una tarjeta de crédito, débito o una cuenta bancaria. Puede obtener información sobre el pago y también reembolsarlos parcial o totalmente.
Estado | Razón |
---|---|
pending_submission |
El pago se ha emitido, pero aún no se ha presentado a la entidad financiera |
cancelled |
El pago ha sido cancelado manualmente. |
submitted |
El pago se ha realizado correctamente y está siendo procesado por la entidad financiera |
failed |
No se ha podido presentar en la entidad financiera. Hay un error en la solicitud |
will_retry |
El intento fracasó, pero la entidad financiera hará un nuevo intento |
approved |
Enviado OK y aprobado |
rejected |
Se envió correctamente, pero no se pudo cobrar. |
chargeback |
El cliente le pidió al banco que le devolvieran su dinero. |
refunded |
El pago ha sido devuelto al cliente. |
partially_refunded |
Una cantidad parcial del pago ha sido devuelta al cliente |
id | string Identificador único del Pago. |
object | string Value: "payment" |
amount | number Monto del pago |
amount_refunded | number Payment amount refunded. |
currency | string Enum: "ARS" "BRL" "CLP" "COP" "MXN" "USB" "USD" Moneda de la transacción usando códigos ISO_4217. Los valores predeterminados son los predeterminados de la cuenta. |
description | string Descripción del pago |
status | string Enum: "pending_submission" "cancelled" "submitted" "failed" "will_retry" "approved" "rejected" "chargeback" "refunded" "partially_refunded" Estado del pago |
response_message | string Respuesta detallada de la institución financiera |
paid | boolean El pago se ha cobrado con éxito. |
retryable | boolean Se puede volver a intentar el pago. |
refundable | boolean El pago puede ser reembolsado. |
amount_refundable | number El monto del pago que se puede reembolsar. |
livemode | boolean Tiene el valor |
created_at | string <date-time> Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: |
charge_date | string Una fecha futura en la que se debe cobrar el pago. Si no se especifica, el pago se cobrará lo antes posible. |
submissions_count | number El número de veces que el pago ha sido enviado a la institución financiera. |
can_auto_retry_until | null or string La última fecha en que se enviará el pago a la institución financiera. Nulo significa sin límite |
auto_retries_max_attempts | null or number El número máximo de veces que se puede volver a intentar el pago automáticamente. |
effective_charged_date | null or string La fecha en que se cobrará el pago. |
estimated_accreditation_date | null or string La fecha estimada en la que la entidad financiera enviará el monto a cobrar a tu cuenta. |
updated_at | string <date-time> Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: |
updated_status | null or string La última fecha en que se cambió el estado del pago. |
object (Cliente) Este objeto representa a un cliente de su organización. | |
subscription | null or string La Suscripción asociada con el pago si existe. |
subscription_payment_number | null or string El número de pago de la Suscripción asociada, si existiera. |
gateway | string El Gateway asociada con el pago. |
object (Método de pago) Este objeto representa un Método de Pago de su cuenta. | |
gateway_identifier | null or string El número personalizado que envía al Gateway. En la mayoría de los casos este valor es nulo. |
binary_mode | boolean Fuerza el procesamiento instantáneo de pagos, proporcionando un estado inmediato de |
refunds | Array of arrays Reembolsos asociados con este pago. |
metadata | object or null Conjunto de pares clave/valor que puede adjuntar
a un objeto. Esto puede ser útil para almacenar información
sobre el objeto en un formato estructurado.
Todas las claves se pueden borrar publicando un valor |
{- "id": "PY9J8YYdylz6",
- "object": "payment",
- "amount": 2300,
- "amount_refunded": 0,
- "currency": "ARS",
- "description": "Ajuste por deuda pasada",
- "status": "approved",
- "response_message": "Transacción aceptada",
- "paid": true,
- "retryable": false,
- "refundable": true,
- "amount_refundable": 2300,
- "livemode": true,
- "created_at": "2022-08-03T12:24:33-03:00",
- "charge_date": "2022-08-03",
- "submissions_count": 1,
- "can_auto_retry_until": null,
- "auto_retries_max_attempts": null,
- "effective_charged_date": "2022-08-05",
- "estimated_accreditation_date": "2022-08-19",
- "updated_at": "2022-08-03T12:24:33-03:00",
- "updated_status": "2022-08-05",
- "customer": {
- "id": "CS3Z25Agp708",
- "object": "customer",
- "gateway_identifier": "1723393503",
- "name": "Andrés Bahena Tercero",
- "email": "andres37@calvillo.info",
- "identification_type": null,
- "identification_number": null,
- "mobile_number": "+5481934863501",
- "metadata": {
- "external_id": "0Qk3IJY5"
}, - "livemode": true,
- "created_at": "2021-07-05T12:24:32-03:00",
- "updated_at": "2021-07-05T12:24:32-03:00",
- "deleted_at": null
}, - "subscription": null,
- "subscription_payment_number": null,
- "gateway": "GW1L49J7ARW3",
- "payment_method": {
- "card": {
- "name": "Visa",
- "network": "visa",
- "issuer": null,
- "country": "AR",
- "expiration_month": null,
- "expiration_year": null,
- "fingerprint": "0sZQikKp4lImAgIo",
- "funding": "credit",
- "last_four_digits": "4242",
- "providers": {
- "available": [
- "fiserv-argentina"
], - "preferred": "fiserv-argentina"
}
}, - "created_at": "2022-02-01T23:13:04-03:00",
- "id": "PMBja4YZ2GDR",
- "livemode": true,
- "metadata": null,
- "object": "payment_method",
- "type": "card",
- "updated_at": "2022-02-01T23:13:04-03:00"
}, - "gateway_identifier": null,
- "metadata": null,
- "refunds": [ ]
}
Obtener pagos
Obtener pagos en order cronológico, los más nuevos aparecerán primero.
Authorizations:
query Parameters
customer_id | string Example: customer_id=CS9PL8eeo8aB Mostrar solo los métodos de pago de un cliente determinado. |
subscription_id | string Example: subscription_id=SBmX1MrZ77Mwq3 Mostrar solo los métodos de pago de una suscripción determinada. |
object (range_query_specs) Un filtro en la lista, basado en el campo | |
ending_before | string Un cursor para utilizar en la paginación. |
limit | integer Example: limit=20 Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25. |
starting_after | string Un cursor para utilizar en la paginación. |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request GET \ --url 'https://api.debi.pro/v1/payments?customer_id=SOME_STRING_VALUE&subscription_id=SOME_STRING_VALUE&created_at=SOME_OBJECT_VALUE&ending_before=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE' \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 200
- 401
{- "data": [
- {
- "id": "PYljikas9Fa8",
- "object": "payment",
- "amount": 12.5,
- "amount_refunded": 0,
- "currency": "ARS",
- "description": "Ajuste por deuda pasada",
- "status": "rejected",
- "response_message": "Falta de fondos",
- "paid": false,
- "retryable": true,
- "refundable": false,
- "amount_refundable": 0,
- "livemode": true,
- "created_at": "2022-02-11T23:19:22-03:00",
- "charge_date": "2022-08-04",
- "submissions_count": 1,
- "can_auto_retry_until": "2022-08-31",
- "auto_retries_max_attempts": null,
- "effective_charged_date": null,
- "estimated_accreditation_date": null,
- "updated_at": "2022-02-11T23:19:22-03:00",
- "updated_status": "2022-08-31",
- "customer": {
- "id": "CSljikas98",
- "name": "Jorgelina Castro",
- "email": "mail@example.com",
- "object": "customer",
- "livemode": true,
- "metadata": {
- "some": "metadata"
}, - "mobile_number": "5491164531234",
- "default_payment_method_id": "PMBja4YZ2GDR.",
- "gateway_identifier": "383473",
- "identification_number": "15.555.324",
- "identification_type": "DNI",
- "created_at": "2022-02-11T23:19:22-03:00",
- "updated_at": "2022-02-11T23:19:22-03:00",
- "deleted_at": "2022-02-11T23:19:22-03:00"
}, - "subscription": "SBmX1MrZ77Mwq3",
- "subscription_payment_number": null,
- "gateway": "GW1L49J7ARW3",
- "payment_method": {
- "id": "PMyma6Ql8Wo9",
- "object": "payment_method",
- "type": "card",
- "card": {
- "country": "AR",
- "expiration_month": 11,
- "expiration_year": 2030,
- "fingerprint": "8712yh2uihiu1123sxas",
- "funding": "credit",
- "issuer": "argencard",
- "last_four_digits": "9876",
- "name": "Visa",
- "network": "visa",
- "providers": {
- "available": [
- "fiserv-argentina"
], - "preferred": "fiserv-argentina"
}
}, - "sepa_debit": {
- "bank": "string",
- "country": "NL",
- "fingerprint": "8712yh2uihiu1123sxas",
- "identification": { },
- "last_four_digits": "9876",
- "providers": {
- "available": [
- "santander-es"
], - "preferred": [
- "santander-es"
]
}
}, - "cbu": {
- "bank": "string",
- "country": "AR",
- "fingerprint": "8712yh2uihiu1123sxas",
- "identification": { },
- "last_four_digits": "9876",
- "providers": {
- "available": [
- "cbu-galicia"
], - "preferred": "cbu-galicia"
}
}, - "livemode": true,
- "metadata": {
- "some": "metadata"
}, - "created_at": "2022-02-11T23:19:22-03:00",
- "updated_at": "2022-02-11T23:19:22-03:00"
}, - "gateway_identifier": null,
- "binary_mode": true,
- "refunds": [ ],
- "metadata": {
- "some": "metadata"
}
}
], - "links": {
}, - "meta": {
- "per_page": 25,
- "total": 2500,
- "next_cursor": null,
- "prev_cursor": null
}
}
Crear un pago
Crear un pago.
Authorizations:
Request Body schema: application/jsonoptional
amount required | number El monto del pago. |
description required | string La descripción del pago. |
customer_id required | string |
payment_method_id required | string El ID del Método de Pago para este pago. |
charge_date | string <date> Una fecha futura en la que se debe cobrar el pago. Si no se especifica, el pago se cobrará lo antes posible. |
can_auto_retry_until | string <date> La fecha máxima en la que se puede volver a intentar el pago automáticamente. |
auto_retries_max_attempts | integer La cantidad máxima de veces que se puede volver a intentar el pago automáticamente. |
gateway_identifier | string Identificador de Gateway para su pago. |
binary_mode | boolean Fuerza el procesamiento instantáneo de pagos, proporcionando un estado inmediato de |
metadata | object or null Conjunto de pares clave/valor que puede adjuntar
a un objeto. Esto puede ser útil para almacenar información
sobre el objeto en un formato estructurado.
Todas las claves se pueden borrar publicando un valor |
Responses
Request samples
- Payload
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
{- "amount": 100,
- "description": "Unique payment",
- "gateway_identifier": "001234",
- "customer_id": "CSr7Dg3LkDP2",
- "payment_method_id": "PMBja4YZ2GDR"
}
Response samples
- 201
- 401
{- "data": {
- "id": "PYljikas9Fa8",
- "object": "payment",
- "amount": 12.5,
- "amount_refunded": 0,
- "currency": "ARS",
- "description": "Ajuste por deuda pasada",
- "status": "rejected",
- "response_message": "Falta de fondos",
- "paid": false,
- "retryable": true,
- "refundable": false,
- "amount_refundable": 0,
- "livemode": true,
- "created_at": "2022-02-11T23:19:22-03:00",
- "charge_date": "2022-08-04",
- "submissions_count": 1,
- "can_auto_retry_until": "2022-08-31",
- "auto_retries_max_attempts": null,
- "effective_charged_date": null,
- "estimated_accreditation_date": null,
- "updated_at": "2022-02-11T23:19:22-03:00",
- "updated_status": "2022-08-31",
- "customer": {
- "id": "CSljikas98",
- "name": "Jorgelina Castro",
- "email": "mail@example.com",
- "object": "customer",
- "livemode": true,
- "metadata": {
- "some": "metadata"
}, - "mobile_number": "5491164531234",
- "default_payment_method_id": "PMBja4YZ2GDR.",
- "gateway_identifier": "383473",
- "identification_number": "15.555.324",
- "identification_type": "DNI",
- "created_at": "2022-02-11T23:19:22-03:00",
- "updated_at": "2022-02-11T23:19:22-03:00",
- "deleted_at": "2022-02-11T23:19:22-03:00"
}, - "subscription": "SBmX1MrZ77Mwq3",
- "subscription_payment_number": null,
- "gateway": "GW1L49J7ARW3",
- "payment_method": {
- "id": "PMyma6Ql8Wo9",
- "object": "payment_method",
- "type": "card",
- "card": {
- "country": "AR",
- "expiration_month": 11,
- "expiration_year": 2030,
- "fingerprint": "8712yh2uihiu1123sxas",
- "funding": "credit",
- "issuer": "argencard",
- "last_four_digits": "9876",
- "name": "Visa",
- "network": "visa",
- "providers": {
- "available": [
- "fiserv-argentina"
], - "preferred": "fiserv-argentina"
}
}, - "sepa_debit": {
- "bank": "string",
- "country": "NL",
- "fingerprint": "8712yh2uihiu1123sxas",
- "identification": { },
- "last_four_digits": "9876",
- "providers": {
- "available": [
- "santander-es"
], - "preferred": [
- "santander-es"
]
}
}, - "cbu": {
- "bank": "string",
- "country": "AR",
- "fingerprint": "8712yh2uihiu1123sxas",
- "identification": { },
- "last_four_digits": "9876",
- "providers": {
- "available": [
- "cbu-galicia"
], - "preferred": "cbu-galicia"
}
}, - "livemode": true,
- "metadata": {
- "some": "metadata"
}, - "created_at": "2022-02-11T23:19:22-03:00",
- "updated_at": "2022-02-11T23:19:22-03:00"
}, - "gateway_identifier": null,
- "binary_mode": true,
- "refunds": [ ],
- "metadata": {
- "some": "metadata"
}
}
}
Obtener un pago
Obtener un pago.
Authorizations:
path Parameters
id required |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request GET \ --url https://api.debi.pro/v1/payments/PYdOz9bgVReV \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 200
- 401
- 404
{- "data": {
- "id": "PYljikas9Fa8",
- "object": "payment",
- "amount": 12.5,
- "amount_refunded": 0,
- "currency": "ARS",
- "description": "Ajuste por deuda pasada",
- "status": "rejected",
- "response_message": "Falta de fondos",
- "paid": false,
- "retryable": true,
- "refundable": false,
- "amount_refundable": 0,
- "livemode": true,
- "created_at": "2022-02-11T23:19:22-03:00",
- "charge_date": "2022-08-04",
- "submissions_count": 1,
- "can_auto_retry_until": "2022-08-31",
- "auto_retries_max_attempts": null,
- "effective_charged_date": null,
- "estimated_accreditation_date": null,
- "updated_at": "2022-02-11T23:19:22-03:00",
- "updated_status": "2022-08-31",
- "customer": {
- "id": "CSljikas98",
- "name": "Jorgelina Castro",
- "email": "mail@example.com",
- "object": "customer",
- "livemode": true,
- "metadata": {
- "some": "metadata"
}, - "mobile_number": "5491164531234",
- "default_payment_method_id": "PMBja4YZ2GDR.",
- "gateway_identifier": "383473",
- "identification_number": "15.555.324",
- "identification_type": "DNI",
- "created_at": "2022-02-11T23:19:22-03:00",
- "updated_at": "2022-02-11T23:19:22-03:00",
- "deleted_at": "2022-02-11T23:19:22-03:00"
}, - "subscription": "SBmX1MrZ77Mwq3",
- "subscription_payment_number": null,
- "gateway": "GW1L49J7ARW3",
- "payment_method": {
- "id": "PMyma6Ql8Wo9",
- "object": "payment_method",
- "type": "card",
- "card": {
- "country": "AR",
- "expiration_month": 11,
- "expiration_year": 2030,
- "fingerprint": "8712yh2uihiu1123sxas",
- "funding": "credit",
- "issuer": "argencard",
- "last_four_digits": "9876",
- "name": "Visa",
- "network": "visa",
- "providers": {
- "available": [
- "fiserv-argentina"
], - "preferred": "fiserv-argentina"
}
}, - "sepa_debit": {
- "bank": "string",
- "country": "NL",
- "fingerprint": "8712yh2uihiu1123sxas",
- "identification": { },
- "last_four_digits": "9876",
- "providers": {
- "available": [
- "santander-es"
], - "preferred": [
- "santander-es"
]
}
}, - "cbu": {
- "bank": "string",
- "country": "AR",
- "fingerprint": "8712yh2uihiu1123sxas",
- "identification": { },
- "last_four_digits": "9876",
- "providers": {
- "available": [
- "cbu-galicia"
], - "preferred": "cbu-galicia"
}
}, - "livemode": true,
- "metadata": {
- "some": "metadata"
}, - "created_at": "2022-02-11T23:19:22-03:00",
- "updated_at": "2022-02-11T23:19:22-03:00"
}, - "gateway_identifier": null,
- "binary_mode": true,
- "refunds": [ ],
- "metadata": {
- "some": "metadata"
}
}
}
Actualizar un pago
Actualizar un pago.
Authorizations:
path Parameters
id required |
Request Body schema: application/jsonrequired
amount | number El nuevo monto del pago. |
auto_retries_max_attempts | integer La cantidad máxima de veces que se puede volver a intentar el pago automáticamente. |
can_auto_retry_until | string <date> La fecha máxima en la que se puede volver a intentar el pago automáticamente. |
charge_date | string <date> Una fecha futura en la que se debe cobrar el pago. |
description | string La nueva descripción del pago. |
payment_method_id | string El ID del Método de Pago para este pago. |
metadata | object or null Conjunto de pares clave/valor que puede adjuntar
a un objeto. Esto puede ser útil para almacenar información
sobre el objeto en un formato estructurado.
Todas las claves se pueden borrar publicando un valor |
Responses
Request samples
- Payload
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
{- "description": "New payment title"
}
Response samples
- 200
- 401
{- "data": {
- "id": "PYljikas9Fa8",
- "object": "payment",
- "amount": 12.5,
- "amount_refunded": 0,
- "currency": "ARS",
- "description": "Ajuste por deuda pasada",
- "status": "rejected",
- "response_message": "Falta de fondos",
- "paid": false,
- "retryable": true,
- "refundable": false,
- "amount_refundable": 0,
- "livemode": true,
- "created_at": "2022-02-11T23:19:22-03:00",
- "charge_date": "2022-08-04",
- "submissions_count": 1,
- "can_auto_retry_until": "2022-08-31",
- "auto_retries_max_attempts": null,
- "effective_charged_date": null,
- "estimated_accreditation_date": null,
- "updated_at": "2022-02-11T23:19:22-03:00",
- "updated_status": "2022-08-31",
- "customer": {
- "id": "CSljikas98",
- "name": "Jorgelina Castro",
- "email": "mail@example.com",
- "object": "customer",
- "livemode": true,
- "metadata": {
- "some": "metadata"
}, - "mobile_number": "5491164531234",
- "default_payment_method_id": "PMBja4YZ2GDR.",
- "gateway_identifier": "383473",
- "identification_number": "15.555.324",
- "identification_type": "DNI",
- "created_at": "2022-02-11T23:19:22-03:00",
- "updated_at": "2022-02-11T23:19:22-03:00",
- "deleted_at": "2022-02-11T23:19:22-03:00"
}, - "subscription": "SBmX1MrZ77Mwq3",
- "subscription_payment_number": null,
- "gateway": "GW1L49J7ARW3",
- "payment_method": {
- "id": "PMyma6Ql8Wo9",
- "object": "payment_method",
- "type": "card",
- "card": {
- "country": "AR",
- "expiration_month": 11,
- "expiration_year": 2030,
- "fingerprint": "8712yh2uihiu1123sxas",
- "funding": "credit",
- "issuer": "argencard",
- "last_four_digits": "9876",
- "name": "Visa",
- "network": "visa",
- "providers": {
- "available": [
- "fiserv-argentina"
], - "preferred": "fiserv-argentina"
}
}, - "sepa_debit": {
- "bank": "string",
- "country": "NL",
- "fingerprint": "8712yh2uihiu1123sxas",
- "identification": { },
- "last_four_digits": "9876",
- "providers": {
- "available": [
- "santander-es"
], - "preferred": [
- "santander-es"
]
}
}, - "cbu": {
- "bank": "string",
- "country": "AR",
- "fingerprint": "8712yh2uihiu1123sxas",
- "identification": { },
- "last_four_digits": "9876",
- "providers": {
- "available": [
- "cbu-galicia"
], - "preferred": "cbu-galicia"
}
}, - "livemode": true,
- "metadata": {
- "some": "metadata"
}, - "created_at": "2022-02-11T23:19:22-03:00",
- "updated_at": "2022-02-11T23:19:22-03:00"
}, - "gateway_identifier": null,
- "binary_mode": true,
- "refunds": [ ],
- "metadata": {
- "some": "metadata"
}
}
}
Cancelar pago
Cancelar pago.
Authorizations:
path Parameters
id required |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request POST \ --url https://api.debi.pro/v1/payments/PYdOz9bgVReV/actions/cancel \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 201
- 401
{- "message": "Cancelled successfully"
}
Reintentar un pago
Reintentar un pago.
Authorizations:
path Parameters
id required |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request POST \ --url https://api.debi.pro/v1/payments/PYdOz9bgVReV/actions/retry \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 201
- 401
{- "message": "Retried successfully"
}
Detener reintentos automáticos
Detener reintentos automáticos, impide que luego de un rechazo el pago continue realizando reintentos automáticos. Esta acción puede solicitarse en cualquier momento del ciclo del pago, es decir, incluso cuando el pago está enviado a la entidad financiera.
Authorizations:
path Parameters
id required |
Responses
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request POST \ --url https://api.debi.pro/v1/payments/PYdOz9bgVReV/actions/stop_auto_retrying \ --header 'Authorization: Bearer sk_live_...'
Response samples
- 201
- 401
{- "message": "Stopped autoretries successfully"
}
Buscar pagos
Buscar pagos.
Authorizations:
query Parameters
q required | |
limit | integer Example: limit=20 Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25. |
page required | string Example: page=john doe Un cursor para la paginación en varias páginas de resultados. No incluya este parámetro en la primera llamada. Utilice el valor de |