openapi: 3.1.0 info: license: name: Proprietary url: https://debi.pro/terms title: Debi API description: > # Introducción 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" ``` # Autenticación 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](https://debi.pro/dashboard/developers) 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. # Errores 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 ```json { "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 ```json { "message": "Unauthenticated." } ``` # Idempotencia 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: ` 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. # Metadata Los siguientes objetos tienen un parámetro `metadata` que puedes usar para guardar pares de clave-valor: - [Clientes](#tag/Clientes) - [Adhesiones](#tag/Adhesiones) - [Pagos](#tag/Pagos) - [Devoluciones](#tag/Devoluciones) - [Métodos de Pago](#tag/Metodos-de-Pago) - [Suscripciones](#tag/Suscripciones) 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. # Paginación Todos los recursos de la API pueden listarse a través de métodos de la API. Por ejemplo, puede [obtener pagos](#tag/Pagos/operation/PaymentsGetPayments), [obtener clientes](#tag/Clientes/operation/CustomersGetCustomers) y [obtener suscripciones](#tag/Suscripciones/operation/SubscriptionsGetSubscriptions). 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`. # IDs de Request 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](https://debi.pro/dashboard/logs). # Convenciones ### 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](https://www.ietf.org/rfc/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](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). ### 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` # Medios de pago de prueba 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. # Notificaciones de Webhook 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:
```json { "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](https://ngrok.com/). ### 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](https://debi.pro/dashboard/developers). 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. termsOfService: https://debi.pro/terms contact: name: Debi Devs email: devs@debi.pro url: https://debi.pro/docs/api x-logo: url: https://debi.pro/img/debi.svg altText: Debi version: '2025-10-02' servers: - url: https://api.debi.pro description: Servidor de API - url: https://api.debi-test.pro description: Servidor de API Sandbox paths: /v1/customers: get: operationId: CustomersGetCustomers summary: Obtener todos los clientes description: Por defecto, los clientes más nuevos serán los primeros en la lista. parameters: - name: all in: query description: Incluye clientes archivados. required: false schema: type: boolean - name: created_at in: query description: >- Un filtro en la lista, basado en el campo `created_at` del objeto. El valor puede ser un Unix Timestamp, o puede ser un diccionario con varias opciones de consulta diferentes. required: false schema: type: object properties: gt: description: Mínimo valor para filtrar (exclusivo) type: integer gte: description: Mínimo valor para filtrar (inclusivo) type: integer lt: description: Máximo valor para filtrar (exclusivo) type: integer lte: description: Máximo valor para filtrar (inclusivo) type: integer title: range_query_specs explode: true style: deepObject - name: ending_before in: query description: >- Un cursor para utilizar en la paginación. `ending_before` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, comenzando con `obj_ID`, la próxima llamda puede incluir `ending_before=obj_ID` para obtener la página previa. required: false schema: type: string style: form - name: limit in: query description: >- 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. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- Un cursor para utilizar en la paginación. `starting_after` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, terminando con `obj_ID`, la próxima llamda puede incluir `starting_after=obj_ID` para obtener la página siguiente. required: false schema: type: string style: form responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Cliente description: Este objeto representa a un cliente de su organización. type: object properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' additionalProperties: false required: - id - object - livemode - created_at - updated_at links: description: Links de paginación type: object properties: first: type: - 'null' - string example: https://api.debi.pro/v1/customers last: type: - 'null' - string example: https://api.debi.pro/v1/customers next: type: - 'null' - string example: https://api.debi.pro/v1/customers prev: type: - 'null' - string example: https://api.debi.pro/v1/customers title: Metadata de Respuesta meta: description: Metadata de paginación type: object properties: per_page: type: number example: 25 total: type: number example: 2500 path: type: string example: https://api.debi.pro/v1/customers next_cursor: description: Cursor de Paginación. type: - 'null' - string prev_cursor: description: Cursor de Paginación. type: - 'null' - string title: Response Meta required: - data example: 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 next: >- https://api.debi.pro/v1/customers?starting_after=CS3Z25Agp708 prev: null meta: per_page: 25 total: 2500 path: https://api.debi.pro/v1/customers '401': description: No autorizado content: application/json: schema: properties: data: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Clientes x-codeSamples: - lang: Shell + Curl source: |- 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_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/customers', qs: { all: 'SOME_BOOLEAN_VALUE', created_at: 'SOME_OBJECT_VALUE', ending_before: 'SOME_STRING_VALUE', limit: 'SOME_INTEGER_VALUE', starting_after: 'SOME_STRING_VALUE' }, headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/customers'); $request->setMethod(HTTP_METH_GET); $request->setQueryData([ 'all' => 'SOME_BOOLEAN_VALUE', 'created_at' => 'SOME_OBJECT_VALUE', 'ending_before' => 'SOME_STRING_VALUE', 'limit' => 'SOME_INTEGER_VALUE', 'starting_after' => 'SOME_STRING_VALUE' ]); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/customers" querystring = {"all":"SOME_BOOLEAN_VALUE","created_at":"SOME_OBJECT_VALUE","ending_before":"SOME_STRING_VALUE","limit":"SOME_INTEGER_VALUE","starting_after":"SOME_STRING_VALUE"} headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers, params=querystring) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("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_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("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") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body post: operationId: CustomersCreateCustomer summary: Crear un cliente description: Crear un cliente. requestBody: required: true content: application/json: encoding: metadata: explode: true style: deepObject example: name: Pedro Lombardo email: pedrolombardo@email.com gateway_identifier: '1234' identification_type: DNI identification_number: '237767265' mobile_number: '+5491123456789' default_payment_method_id: PMVdYaYwkqOw metadata: some: value schema: type: object properties: name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com gateway_identifier: description: La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} additionalProperties: false responses: '201': description: OK content: application/json: schema: properties: data: description: Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente example: 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 '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '422': description: Unprocessable Entity content: application/json: example: errors: email: - El email es inválido. message: The given data was invalid. tags: - Clientes x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/customers \ --header 'Authorization: Bearer sk_live_...' \ --header 'content-type: application/json' \ --data '{"name":"Jorgelina Castro","email":"mail@example.com","gateway_identifier":"383473","identification_type":"DNI","identification_number":"15.555.324","mobile_number":"+5491123456789","default_payment_method_id":"PMVdYaYwkqOw","metadata":{"some":"metadata"}}' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/customers', headers: { 'content-type': 'application/json', Authorization: 'Bearer sk_live_...' }, body: { name: 'Jorgelina Castro', email: 'mail@example.com', gateway_identifier: '383473', identification_type: 'DNI', identification_number: '15.555.324', mobile_number: '+5491123456789', default_payment_method_id: 'PMVdYaYwkqOw', metadata: {some: 'metadata'} }, json: true }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/customers'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'content-type' => 'application/json', 'Authorization' => 'Bearer sk_live_...' ]); $request->setBody('{"name":"Jorgelina Castro","email":"mail@example.com","gateway_identifier":"383473","identification_type":"DNI","identification_number":"15.555.324","mobile_number":"+5491123456789","default_payment_method_id":"PMVdYaYwkqOw","metadata":{"some":"metadata"}}'); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/customers" payload = { "name": "Jorgelina Castro", "email": "mail@example.com", "gateway_identifier": "383473", "identification_type": "DNI", "identification_number": "15.555.324", "mobile_number": "+5491123456789", "default_payment_method_id": "PMVdYaYwkqOw", "metadata": {"some": "metadata"} } headers = { "content-type": "application/json", "Authorization": "Bearer sk_live_..." } response = requests.request("POST", url, json=payload, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/customers") .header("content-type", "application/json") .header("Authorization", "Bearer sk_live_...") .body("{\"name\":\"Jorgelina Castro\",\"email\":\"mail@example.com\",\"gateway_identifier\":\"383473\",\"identification_type\":\"DNI\",\"identification_number\":\"15.555.324\",\"mobile_number\":\"+5491123456789\",\"default_payment_method_id\":\"PMVdYaYwkqOw\",\"metadata\":{\"some\":\"metadata\"}}") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/customers") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'application/json' request["Authorization"] = 'Bearer sk_live_...' request.body = "{\"name\":\"Jorgelina Castro\",\"email\":\"mail@example.com\",\"gateway_identifier\":\"383473\",\"identification_type\":\"DNI\",\"identification_number\":\"15.555.324\",\"mobile_number\":\"+5491123456789\",\"default_payment_method_id\":\"PMVdYaYwkqOw\",\"metadata\":{\"some\":\"metadata\"}}" response = http.request(request) puts response.read_body x-codegen-request-body-name: body /v1/customers/{id}: get: operationId: CustomersGetCustomer summary: Obtener un cliente description: Obtener un cliente. parameters: - name: id in: path description: | [ID del Cliente](#tag/Clientes). required: true schema: type: string example: CS9PL8eeo8aB responses: '200': description: OK content: application/json: schema: properties: data: description: Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '404': description: Recurso no encontrado content: application/json: schema: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found tags: - Clientes x-codeSamples: - lang: Shell + Curl source: |- curl --request GET \ --url https://api.debi.pro/v1/customers/CS9PL8eeo8aB \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/customers/CS9PL8eeo8aB', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/customers/CS9PL8eeo8aB'); $request->setMethod(HTTP_METH_GET); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: |- import requests url = "https://api.debi.pro/v1/customers/CS9PL8eeo8aB" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("https://api.debi.pro/v1/customers/CS9PL8eeo8aB") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/customers/CS9PL8eeo8aB") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body put: operationId: CustomersUpdateCustomer summary: Actualiza un cliente description: Actualiza un cliente. parameters: - name: id in: path description: | [ID del Cliente](#tag/Clientes). required: true schema: type: string example: CS9PL8eeo8aB requestBody: required: true content: application/json: encoding: metadata: explode: true style: deepObject example: name: Pedro Lombardo email: pedrolombardo@email.com schema: type: object properties: name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com gateway_identifier: description: La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} additionalProperties: false responses: '200': description: OK content: application/json: schema: properties: data: description: Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '404': description: Recurso no encontrado content: application/json: schema: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found '422': description: Unprocessable Entity content: application/json: example: errors: email: - El email es inválido. message: The given data was invalid. tags: - Clientes x-codeSamples: - lang: Shell + Curl source: |- curl --request PUT \ --url https://api.debi.pro/v1/customers/CS9PL8eeo8aB \ --header 'Authorization: Bearer sk_live_...' \ --header 'content-type: application/json' \ --data '{"name":"Jorgelina Castro","email":"mail@example.com","gateway_identifier":"383473","identification_type":"DNI","identification_number":"15.555.324","metadata":{"some":"metadata"}}' - lang: Node + Request source: | const request = require('request'); const options = { method: 'PUT', url: 'https://api.debi.pro/v1/customers/CS9PL8eeo8aB', headers: { 'content-type': 'application/json', Authorization: 'Bearer sk_live_...' }, body: { name: 'Jorgelina Castro', email: 'mail@example.com', gateway_identifier: '383473', identification_type: 'DNI', identification_number: '15.555.324', metadata: {some: 'metadata'} }, json: true }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/customers/CS9PL8eeo8aB'); $request->setMethod(HTTP_METH_PUT); $request->setHeaders([ 'content-type' => 'application/json', 'Authorization' => 'Bearer sk_live_...' ]); $request->setBody('{"name":"Jorgelina Castro","email":"mail@example.com","gateway_identifier":"383473","identification_type":"DNI","identification_number":"15.555.324","metadata":{"some":"metadata"}}'); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/customers/CS9PL8eeo8aB" payload = { "name": "Jorgelina Castro", "email": "mail@example.com", "gateway_identifier": "383473", "identification_type": "DNI", "identification_number": "15.555.324", "metadata": {"some": "metadata"} } headers = { "content-type": "application/json", "Authorization": "Bearer sk_live_..." } response = requests.request("PUT", url, json=payload, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.put("https://api.debi.pro/v1/customers/CS9PL8eeo8aB") .header("content-type", "application/json") .header("Authorization", "Bearer sk_live_...") .body("{\"name\":\"Jorgelina Castro\",\"email\":\"mail@example.com\",\"gateway_identifier\":\"383473\",\"identification_type\":\"DNI\",\"identification_number\":\"15.555.324\",\"metadata\":{\"some\":\"metadata\"}}") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/customers/CS9PL8eeo8aB") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'application/json' request["Authorization"] = 'Bearer sk_live_...' request.body = "{\"name\":\"Jorgelina Castro\",\"email\":\"mail@example.com\",\"gateway_identifier\":\"383473\",\"identification_type\":\"DNI\",\"identification_number\":\"15.555.324\",\"metadata\":{\"some\":\"metadata\"}}" response = http.request(request) puts response.read_body x-codegen-request-body-name: body /v1/customers/{id}/actions/archive: post: operationId: CustomersArchiveCustomer summary: Archivar un cliente description: Archivar un cliente y cancelar suscripciones y pagos en proceso. parameters: - name: id in: path description: | [ID del Cliente](#tag/Clientes). required: true schema: type: string example: CS9PL8eeo8aB responses: '200': description: OK content: application/json: example: message: Archived successfully '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '404': description: Recurso no encontrado content: application/json: schema: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found tags: - Clientes x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/customers/CS9PL8eeo8aB/actions/archive \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/customers/CS9PL8eeo8aB/actions/archive', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/customers/CS9PL8eeo8aB/actions/archive'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/customers/CS9PL8eeo8aB/actions/archive" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("POST", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/customers/CS9PL8eeo8aB/actions/archive") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/customers/CS9PL8eeo8aB/actions/archive") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/customers/{id}/actions/restore: post: operationId: CustomersRestoreCustomer summary: Restaurar un cliente description: Restaurar inmediatamente un cliente. parameters: - name: id in: path description: | [ID del Cliente](#tag/Clientes). required: true schema: type: string example: CS9PL8eeo8aB responses: '200': description: OK content: application/json: example: message: Restored successfully '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '404': description: Recurso no encontrado content: application/json: schema: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found tags: - Clientes x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/customers/CS9PL8eeo8aB/actions/restore \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/customers/CS9PL8eeo8aB/actions/restore', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/customers/CS9PL8eeo8aB/actions/restore'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/customers/CS9PL8eeo8aB/actions/restore" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("POST", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/customers/CS9PL8eeo8aB/actions/restore") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/customers/CS9PL8eeo8aB/actions/restore") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/customers/search: get: operationId: CustomersSearch summary: Buscar clientes description: Buscar clientes. parameters: - name: q in: query description: > Puede usar [la sintáxis de búsqueda](https://debi.pro/docs/docs/producto/Sistema%20de%20B%C3%BAsquedas/). required: true schema: type: string example: john doe - name: limit in: query description: >- 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. required: false schema: type: integer example: 20 - name: page in: query description: > 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 `next_page` devuelto en una respuesta anterior para solicitar resultados posteriores. required: true schema: type: string example: john doe responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Cliente description: Este objeto representa a un cliente de su organización. type: object properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' additionalProperties: false required: - id - object - livemode - created_at - updated_at links: description: Links de paginación type: object properties: first: type: - 'null' - string example: https://api.debi.pro/v1/customers last: type: - 'null' - string example: https://api.debi.pro/v1/customers next: type: - 'null' - string example: https://api.debi.pro/v1/customers prev: type: - 'null' - string example: https://api.debi.pro/v1/customers title: Metadata de Respuesta meta: description: Metadata de paginación type: object properties: per_page: type: number example: 25 total: type: number example: 2500 path: type: string example: https://api.debi.pro/v1/customers next_cursor: description: Cursor de Paginación. type: - 'null' - string prev_cursor: description: Cursor de Paginación. type: - 'null' - string title: Response Meta required: - data example: 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: prev: https://api.debi.pro/customers/search?q=john%20doe&page=1 next: https://api.debi.pro/customers/search?q=john%20doe&page=3 meta: per_page: 25 total: 2500 '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Clientes x-codeSamples: - lang: Shell + Curl source: |- 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_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/customers/search', qs: {q: 'SOME_STRING_VALUE', limit: 'SOME_INTEGER_VALUE', page: 'SOME_STRING_VALUE'}, headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/customers/search'); $request->setMethod(HTTP_METH_GET); $request->setQueryData([ 'q' => 'SOME_STRING_VALUE', 'limit' => 'SOME_INTEGER_VALUE', 'page' => 'SOME_STRING_VALUE' ]); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/customers/search" querystring = {"q":"SOME_STRING_VALUE","limit":"SOME_INTEGER_VALUE","page":"SOME_STRING_VALUE"} headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers, params=querystring) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("https://api.debi.pro/v1/customers/search?q=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&page=SOME_STRING_VALUE") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/customers/search?q=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&page=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/customers/{id}/payment_methods: get: operationId: listCustomerPaymentMethods summary: Listar métodos de pago del cliente description: > Devuelve una lista de métodos de pago que pertenecen a un cliente específico. parameters: - name: id in: path description: El ID del cliente required: true schema: type: string example: CSbJrDMEDaW9 - name: limit in: query description: >- 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. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- Un cursor para utilizar en la paginación. `starting_after` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, terminando con `obj_ID`, la próxima llamda puede incluir `starting_after=obj_ID` para obtener la página siguiente. required: false schema: type: string style: form - name: ending_before in: query description: >- Un cursor para utilizar en la paginación. `ending_before` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, comenzando con `obj_ID`, la próxima llamda puede incluir `ending_before=obj_ID` para obtener la página previa. required: false schema: type: string style: form responses: '200': description: Una lista de métodos de pago para el cliente content: application/json: schema: type: object properties: object: type: string enum: - list data: type: array items: title: Método de pago description: Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: >- Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: >- Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: >- Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: >- Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' has_more: description: Si hay más métodos de pago disponibles type: boolean example: object: list data: - id: PMBja4YZ2GDR object: payment_method type: card card: country: AR 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' updated_at: '2022-02-01T23:13:04-03:00' livemode: true metadata: null - id: PMBKkz3wjEW9 object: payment_method type: cbu cbu: bank: Banco de la Nación Argentina country: AR fingerprint: jhA2lx68sNppN90k last_four_digits: '0013' providers: available: - cbu-galicia preferred: cbu-galicia created_at: '2022-11-05T20:43:29-03:00' updated_at: '2022-11-05T20:43:29-03:00' livemode: false metadata: null - id: PMr0AkerW4N1 object: payment_method type: cvu cvu: account_number: '0001371211179340101691' last_four_digits: '1691' providers: available: - bind-transfers preferred: bind-transfers fingerprint: R1YRXJAn7SVSH8Jb livemode: false metadata: null customer_id: null created_at: '2025-09-25T16:52:58-03:00' updated_at: '2025-09-25T16:52:58-03:00' has_more: false '404': description: Cliente no encontrado content: application/json: schema: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found tags: - Clientes x-codeSamples: - lang: Shell + Curl source: |- curl --request GET \ --url 'https://api.debi.pro/v1/customers/%7Bid%7D/payment_methods?limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE&ending_before=SOME_STRING_VALUE' \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/customers/%7Bid%7D/payment_methods', qs: { limit: 'SOME_INTEGER_VALUE', starting_after: 'SOME_STRING_VALUE', ending_before: 'SOME_STRING_VALUE' }, headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/customers/%7Bid%7D/payment_methods'); $request->setMethod(HTTP_METH_GET); $request->setQueryData([ 'limit' => 'SOME_INTEGER_VALUE', 'starting_after' => 'SOME_STRING_VALUE', 'ending_before' => 'SOME_STRING_VALUE' ]); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/customers/%7Bid%7D/payment_methods" querystring = {"limit":"SOME_INTEGER_VALUE","starting_after":"SOME_STRING_VALUE","ending_before":"SOME_STRING_VALUE"} headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers, params=querystring) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("https://api.debi.pro/v1/customers/%7Bid%7D/payment_methods?limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE&ending_before=SOME_STRING_VALUE") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/customers/%7Bid%7D/payment_methods?limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE&ending_before=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/events: get: operationId: GetEvents summary: Obtener eventos description: Obtener una lista páginada por cursor de tus eventos. parameters: - name: delivery_success in: query description: >- 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. required: false schema: type: boolean - name: related_object in: query description: >- Filtra eventos para un objeto en particular. Puede recibir cualquier ID de cualquier objecto. required: false schema: type: string maxLength: 255 example: CS9PL8eeo8aB - name: type in: query description: >- Puede contener un nombre de evento específico o un grupo de eventos utilizando `*` como comodín. La lista se filtrará para incluir solo eventos con que coincidan. required: false schema: type: string maxLength: 255 - name: created_at in: query description: >- Un filtro en la lista, basado en el campo `created_at` del objeto. El valor puede ser un Unix Timestamp, o puede ser un diccionario con varias opciones de consulta diferentes. required: false schema: type: object properties: gt: description: Mínimo valor para filtrar (exclusivo) type: integer gte: description: Mínimo valor para filtrar (inclusivo) type: integer lt: description: Máximo valor para filtrar (exclusivo) type: integer lte: description: Máximo valor para filtrar (inclusivo) type: integer title: range_query_specs explode: true style: deepObject - name: ending_before in: query description: >- Un cursor para utilizar en la paginación. `ending_before` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, comenzando con `obj_ID`, la próxima llamda puede incluir `ending_before=obj_ID` para obtener la página previa. required: false schema: type: string style: form - name: limit in: query description: >- 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. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- Un cursor para utilizar en la paginación. `starting_after` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, terminando con `obj_ID`, la próxima llamda puede incluir `starting_after=obj_ID` para obtener la página siguiente. required: false schema: type: string style: form responses: '200': description: OK content: application/json: example: 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 next: https://api.debi.pro/v1/events?starting_after=EVaX3JagwR6x meta: path: https://api.debi.pro/v1/events per_page: 25 total: 34 schema: type: object properties: data: type: array items: title: Evento description: Este objeto representa un evento en tu cuenta. type: object properties: id: description: Identificador único del Evento. type: string example: EVm3RnKn3knw readOnly: true object: type: string enum: - event created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' data: type: object properties: object: description: Event object. type: object additionalProperties: true properties: {} required: - object delivered_at: description: > Hora en que se entregó el evento. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true resource: description: Recurso relacionado con el evento. type: string example: customer enum: - customer - gateway - import - mandate - payment - payment_method - subscription resource_id: description: ID del recurso relacionado con el evento. type: string example: CS12312d1d1dl type: description: Tipo de evento. type: string example: customer.created 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 links: description: Links de paginación type: object properties: first: type: - 'null' - string example: https://api.debi.pro/v1/customers last: type: - 'null' - string example: https://api.debi.pro/v1/customers next: type: - 'null' - string example: https://api.debi.pro/v1/customers prev: type: - 'null' - string example: https://api.debi.pro/v1/customers title: Metadata de Respuesta meta: description: Metadata de paginación type: object properties: per_page: type: number example: 25 total: type: number example: 2500 path: type: string example: https://api.debi.pro/v1/customers next_cursor: description: Cursor de Paginación. type: - 'null' - string prev_cursor: description: Cursor de Paginación. type: - 'null' - string title: Response Meta '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Eventos x-codeSamples: - lang: Shell + Curl source: |- 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_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/events', qs: { 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' }, headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/events'); $request->setMethod(HTTP_METH_GET); $request->setQueryData([ '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' ]); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/events" querystring = {"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"} headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers, params=querystring) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("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_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("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") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/events/{id}: get: operationId: EventsGetEvent summary: Obtener un evento description: Obtener un evento. parameters: - name: id in: path description: | [ID del Evento](#tag/Eventos). required: true schema: type: string example: EVaX3JagwR6x responses: '200': description: OK content: application/json: schema: properties: data: description: Este objeto representa un evento en tu cuenta. type: object properties: id: description: Identificador único del Evento. type: string example: EVm3RnKn3knw readOnly: true object: type: string enum: - event created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' data: type: object properties: object: description: Event object. type: object additionalProperties: true properties: {} required: - object delivered_at: description: > Hora en que se entregó el evento. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true resource: description: Recurso relacionado con el evento. type: string example: customer enum: - customer - gateway - import - mandate - payment - payment_method - subscription resource_id: description: ID del recurso relacionado con el evento. type: string example: CS12312d1d1dl type: description: Tipo de evento. type: string example: customer.created 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 title: Evento '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '404': description: Recurso no encontrado content: application/json: schema: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found tags: - Eventos x-codeSamples: - lang: Shell + Curl source: |- curl --request GET \ --url https://api.debi.pro/v1/events/EVaX3JagwR6x \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/events/EVaX3JagwR6x', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/events/EVaX3JagwR6x'); $request->setMethod(HTTP_METH_GET); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: |- import requests url = "https://api.debi.pro/v1/events/EVaX3JagwR6x" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("https://api.debi.pro/v1/events/EVaX3JagwR6x") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/events/EVaX3JagwR6x") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/gateways: get: operationId: GetGateways summary: Listado de Gateways description: Obtener una lista de todas sus gateways. parameters: - name: ending_before in: query description: >- Un cursor para utilizar en la paginación. `ending_before` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, comenzando con `obj_ID`, la próxima llamda puede incluir `ending_before=obj_ID` para obtener la página previa. required: false schema: type: string style: form - name: limit in: query description: >- 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. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- Un cursor para utilizar en la paginación. `starting_after` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, terminando con `obj_ID`, la próxima llamda puede incluir `starting_after=obj_ID` para obtener la página siguiente. required: false schema: type: string style: form responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Gateway description: Este objeto representa un gateway de su cuenta. type: object properties: approved_at: description: > Hora en la que el gateway se marcó como aprobado. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' code_length: description: Longitud del código type: - 'null' - number example: 8 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' disabled: description: Declara si el gateway está deshabilitado. type: boolean id: description: Identificador único del Gateway. type: string example: GWBZqKYEK7Y2 readOnly: true livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true number: description: Identificador para el procesador. type: string example: '123144' number_bank_retries: description: Número de reintentos bancarios. type: - 'null' - number example: 0 object: type: string enum: - gateway provider: description: Proveedor. type: 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 supported_payment_methods: description: | Medios de pago soportados por este Gateway. type: object example: card: networks: - diners - jcb - mastercard - visa required_fields: - expiration - security_code cbu: [] properties: card: type: object properties: networks: type: array items: type: string enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa required_fields: type: array items: type: string enum: - expiration - security_code cbu: type: array updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' username: description: Nombre de usuario actual del Gateway. type: string example: foo@bar.com links: description: Links de paginación type: object properties: first: type: - 'null' - string example: https://api.debi.pro/v1/customers last: type: - 'null' - string example: https://api.debi.pro/v1/customers next: type: - 'null' - string example: https://api.debi.pro/v1/customers prev: type: - 'null' - string example: https://api.debi.pro/v1/customers title: Metadata de Respuesta meta: description: Metadata de paginación type: object properties: per_page: type: number example: 25 total: type: number example: 2500 path: type: string example: https://api.debi.pro/v1/customers next_cursor: description: Cursor de Paginación. type: - 'null' - string prev_cursor: description: Cursor de Paginación. type: - 'null' - string title: Response Meta required: - data example: 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: first: https://api.debi.pro/v1/gateways?page=1 last: https://api.debi.pro/v1/gateways?page=1 meta: next_cursor: null path: https://api.debi.pro/v1/gateways per_page: 25 prev_cursor: null total: 7 '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Gateways x-codeSamples: - lang: Shell + Curl source: |- 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_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/gateways', qs: { ending_before: 'SOME_STRING_VALUE', limit: 'SOME_INTEGER_VALUE', starting_after: 'SOME_STRING_VALUE' }, headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/gateways'); $request->setMethod(HTTP_METH_GET); $request->setQueryData([ 'ending_before' => 'SOME_STRING_VALUE', 'limit' => 'SOME_INTEGER_VALUE', 'starting_after' => 'SOME_STRING_VALUE' ]); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/gateways" querystring = {"ending_before":"SOME_STRING_VALUE","limit":"SOME_INTEGER_VALUE","starting_after":"SOME_STRING_VALUE"} headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers, params=querystring) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("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_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/gateways?ending_before=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/gateways/{id}/actions/disable: post: operationId: disableGateway summary: Deshabilitar un gateway description: > Deshabilitar un gateway para evitar que procese nuevos pagos. Los pagos existentes continuarán siendo procesados. parameters: - name: id in: path description: El ID del gateway required: true schema: type: string example: GWVwjAlbK4Z6 responses: '200': description: Gateway deshabilitado exitosamente content: application/json: schema: type: object properties: message: type: string example: Enabled successfully example: message: Enabled successfully '404': description: Gateway no encontrado content: application/json: schema: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found '422': description: Error de validación content: application/json: schema: description: Error de Validación type: object properties: message: type: string errors: type: array items: type: string example: errors: email: - El email es inválido. message: The given data was invalid. title: Error de Validación tags: - Gateways x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/gateways/%7Bid%7D/actions/disable \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/gateways/%7Bid%7D/actions/disable', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/gateways/%7Bid%7D/actions/disable'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: |- import requests url = "https://api.debi.pro/v1/gateways/%7Bid%7D/actions/disable" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("POST", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/gateways/%7Bid%7D/actions/disable") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/gateways/%7Bid%7D/actions/disable") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/gateways/{id}/actions/enable: post: operationId: enableGateway summary: Habilitar un gateway description: > Habilitar un gateway previamente deshabilitado para permitirle procesar pagos nuevamente. parameters: - name: id in: path description: El ID del gateway required: true schema: type: string example: GWVwjAlbK4Z6 responses: '200': description: Gateway habilitado exitosamente content: application/json: schema: type: object properties: message: type: string example: Disabled successfully example: message: Disabled successfully '404': description: Gateway no encontrado content: application/json: schema: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found '422': description: Error de validación content: application/json: schema: description: Error de Validación type: object properties: message: type: string errors: type: array items: type: string example: errors: email: - El email es inválido. message: The given data was invalid. title: Error de Validación tags: - Gateways x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/gateways/%7Bid%7D/actions/enable \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/gateways/%7Bid%7D/actions/enable', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/gateways/%7Bid%7D/actions/enable'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: |- import requests url = "https://api.debi.pro/v1/gateways/%7Bid%7D/actions/enable" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("POST", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/gateways/%7Bid%7D/actions/enable") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/gateways/%7Bid%7D/actions/enable") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/exports: get: operationId: listExports summary: Listar todas las exportaciones description: > Devuelve una lista de exportaciones que se han creado. Las exportaciones se devuelven en orden cronológico inverso. parameters: - name: limit in: query description: >- 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. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- Un cursor para utilizar en la paginación. `starting_after` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, terminando con `obj_ID`, la próxima llamda puede incluir `starting_after=obj_ID` para obtener la página siguiente. required: false schema: type: string style: form - name: ending_before in: query description: >- Un cursor para utilizar en la paginación. `ending_before` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, comenzando con `obj_ID`, la próxima llamda puede incluir `ending_before=obj_ID` para obtener la página previa. required: false schema: type: string style: form - name: created_at in: query description: >- Un filtro en la lista, basado en el campo `created_at` del objeto. El valor puede ser un Unix Timestamp, o puede ser un diccionario con varias opciones de consulta diferentes. required: false schema: type: object properties: gt: description: Mínimo valor para filtrar (exclusivo) type: integer gte: description: Mínimo valor para filtrar (inclusivo) type: integer lt: description: Máximo valor para filtrar (exclusivo) type: integer lte: description: Máximo valor para filtrar (inclusivo) type: integer title: range_query_specs explode: true style: deepObject responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: type: object description: Objeto de exportación properties: id: description: Identificador único del objeto. type: string readOnly: true object: description: Cadena que representa el tipo de objeto. type: string enum: - export type: description: El tipo de exportación type: string enum: - payments_monthly - accreditations_monthly - rejected_report - settlement_report - aggregated_rejections_report - new_customers format: description: El formato del archivo de exportación type: string enum: - csv - xlsx status: description: El estado actual de la exportación type: string enum: - pending - processing - completed - failed download_url: description: >- URL para descargar el archivo de exportación (disponible cuando el estado es completado) type: - 'null' - string format: uri file_size: description: Tamaño del archivo de exportación en bytes type: - 'null' - integer rows_count: description: Número de filas en la exportación type: - 'null' - integer error_message: description: Mensaje de error si la exportación falló type: - 'null' - string filters: description: Filtros aplicados a la exportación type: - 'null' - object livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' completed_at: description: Cuándo se completó la exportación type: - 'null' - string format: date-time required: - id - object - type - format - status - livemode - created_at - updated_at links: description: Links de paginación type: object properties: first: type: - 'null' - string example: https://api.debi.pro/v1/customers last: type: - 'null' - string example: https://api.debi.pro/v1/customers next: type: - 'null' - string example: https://api.debi.pro/v1/customers prev: type: - 'null' - string example: https://api.debi.pro/v1/customers title: Metadata de Respuesta meta: description: Metadata de paginación type: object properties: per_page: type: number example: 25 total: type: number example: 2500 path: type: string example: https://api.debi.pro/v1/customers next_cursor: description: Cursor de Paginación. type: - 'null' - string prev_cursor: description: Cursor de Paginación. type: - 'null' - string title: Response Meta required: - data '401': description: No authorizado content: application/json: schema: properties: data: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Informes x-codeSamples: - lang: Shell + Curl source: |- curl --request GET \ --url 'https://api.debi.pro/v1/exports?limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE&ending_before=SOME_STRING_VALUE&created_at=SOME_OBJECT_VALUE' \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/exports', qs: { limit: 'SOME_INTEGER_VALUE', starting_after: 'SOME_STRING_VALUE', ending_before: 'SOME_STRING_VALUE', created_at: 'SOME_OBJECT_VALUE' }, headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/exports'); $request->setMethod(HTTP_METH_GET); $request->setQueryData([ 'limit' => 'SOME_INTEGER_VALUE', 'starting_after' => 'SOME_STRING_VALUE', 'ending_before' => 'SOME_STRING_VALUE', 'created_at' => 'SOME_OBJECT_VALUE' ]); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/exports" querystring = {"limit":"SOME_INTEGER_VALUE","starting_after":"SOME_STRING_VALUE","ending_before":"SOME_STRING_VALUE","created_at":"SOME_OBJECT_VALUE"} headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers, params=querystring) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("https://api.debi.pro/v1/exports?limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE&ending_before=SOME_STRING_VALUE&created_at=SOME_OBJECT_VALUE") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/exports?limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE&ending_before=SOME_STRING_VALUE&created_at=SOME_OBJECT_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body post: operationId: createExport summary: Crear una exportación description: > Crear una nueva exportación para generar reportes en varios formatos (CSV, Excel, etc.). requestBody: required: true content: application/json: schema: type: object properties: type: description: El tipo de exportación a crear type: string example: payments_monthly enum: - payments_monthly - accreditations_monthly - rejected_report - settlement_report - aggregated_rejections_report - new_customers format: description: Formato de exportación type: string default: csv enum: - csv - xlsx csv_delimiter: description: Delimitador CSV (solo se usa para formato CSV) type: string default: ',' enum: - ',' - ; - '|' columns: description: Columnas específicas a incluir en la exportación type: array items: type: object properties: key: description: Clave de columna type: string label: description: Etiqueta de columna type: string display_timezone: description: Zona horaria para el formato de fechas type: string example: America/Argentina/Buenos_Aires headings: description: Si se deben incluir encabezados de columna type: boolean default: true begin_date: description: >- Fecha de inicio para la exportación (requerido para algunos tipos de exportación) type: string format: date example: '2025-01-01' end_date: description: >- Fecha de fin para la exportación (requerido para algunos tipos de exportación) type: string format: date example: '2025-01-31' required: - type responses: '201': description: OK content: application/json: schema: properties: data: description: Objeto de exportación type: object properties: id: description: Identificador único del objeto. type: string readOnly: true object: description: Cadena que representa el tipo de objeto. type: string enum: - export type: description: El tipo de exportación type: string enum: - payments_monthly - accreditations_monthly - rejected_report - settlement_report - aggregated_rejections_report - new_customers format: description: El formato del archivo de exportación type: string enum: - csv - xlsx status: description: El estado actual de la exportación type: string enum: - pending - processing - completed - failed download_url: description: >- URL para descargar el archivo de exportación (disponible cuando el estado es completado) type: - 'null' - string format: uri file_size: description: Tamaño del archivo de exportación en bytes type: - 'null' - integer rows_count: description: Número de filas en la exportación type: - 'null' - integer error_message: description: Mensaje de error si la exportación falló type: - 'null' - string filters: description: Filtros aplicados a la exportación type: - 'null' - object livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' completed_at: description: Cuándo se completó la exportación type: - 'null' - string format: date-time required: - id - object - type - format - status - livemode - created_at - updated_at '422': description: Error de validación content: application/json: schema: description: Error de Validación type: object properties: message: type: string errors: type: array items: type: string example: errors: email: - El email es inválido. message: The given data was invalid. title: Error de Validación tags: - Informes x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/exports \ --header 'Authorization: Bearer sk_live_...' \ --header 'content-type: application/json' \ --data '{"type":"payments_monthly","format":"csv","csv_delimiter":",","columns":[{"key":"string","label":"string"}],"display_timezone":"America/Argentina/Buenos_Aires","headings":true,"begin_date":"2025-01-01","end_date":"2025-01-31"}' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/exports', headers: { 'content-type': 'application/json', Authorization: 'Bearer sk_live_...' }, body: { type: 'payments_monthly', format: 'csv', csv_delimiter: ',', columns: [{key: 'string', label: 'string'}], display_timezone: 'America/Argentina/Buenos_Aires', headings: true, begin_date: '2025-01-01', end_date: '2025-01-31' }, json: true }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/exports'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'content-type' => 'application/json', 'Authorization' => 'Bearer sk_live_...' ]); $request->setBody('{"type":"payments_monthly","format":"csv","csv_delimiter":",","columns":[{"key":"string","label":"string"}],"display_timezone":"America/Argentina/Buenos_Aires","headings":true,"begin_date":"2025-01-01","end_date":"2025-01-31"}'); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/exports" payload = { "type": "payments_monthly", "format": "csv", "csv_delimiter": ",", "columns": [ { "key": "string", "label": "string" } ], "display_timezone": "America/Argentina/Buenos_Aires", "headings": True, "begin_date": "2025-01-01", "end_date": "2025-01-31" } headers = { "content-type": "application/json", "Authorization": "Bearer sk_live_..." } response = requests.request("POST", url, json=payload, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/exports") .header("content-type", "application/json") .header("Authorization", "Bearer sk_live_...") .body("{\"type\":\"payments_monthly\",\"format\":\"csv\",\"csv_delimiter\":\",\",\"columns\":[{\"key\":\"string\",\"label\":\"string\"}],\"display_timezone\":\"America/Argentina/Buenos_Aires\",\"headings\":true,\"begin_date\":\"2025-01-01\",\"end_date\":\"2025-01-31\"}") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/exports") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'application/json' request["Authorization"] = 'Bearer sk_live_...' request.body = "{\"type\":\"payments_monthly\",\"format\":\"csv\",\"csv_delimiter\":\",\",\"columns\":[{\"key\":\"string\",\"label\":\"string\"}],\"display_timezone\":\"America/Argentina/Buenos_Aires\",\"headings\":true,\"begin_date\":\"2025-01-01\",\"end_date\":\"2025-01-31\"}" response = http.request(request) puts response.read_body /v1/exports/{id}: get: operationId: retrieveExport summary: Recuperar una exportación description: | Recupera los detalles de una exportación que se ha creado previamente. parameters: - name: id in: path description: El ID de la exportación required: true schema: type: string example: EXP123456789 responses: '200': description: Detalles de la exportación content: application/json: schema: properties: data: description: Objeto de exportación type: object properties: id: description: Identificador único del objeto. type: string readOnly: true object: description: Cadena que representa el tipo de objeto. type: string enum: - export type: description: El tipo de exportación type: string enum: - payments_monthly - accreditations_monthly - rejected_report - settlement_report - aggregated_rejections_report - new_customers format: description: El formato del archivo de exportación type: string enum: - csv - xlsx status: description: El estado actual de la exportación type: string enum: - pending - processing - completed - failed download_url: description: >- URL para descargar el archivo de exportación (disponible cuando el estado es completado) type: - 'null' - string format: uri file_size: description: Tamaño del archivo de exportación en bytes type: - 'null' - integer rows_count: description: Número de filas en la exportación type: - 'null' - integer error_message: description: Mensaje de error si la exportación falló type: - 'null' - string filters: description: Filtros aplicados a la exportación type: - 'null' - object livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' completed_at: description: Cuándo se completó la exportación type: - 'null' - string format: date-time required: - id - object - type - format - status - livemode - created_at - updated_at '404': description: No encontrado content: application/json: schema: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found tags: - Informes x-codeSamples: - lang: Shell + Curl source: |- curl --request GET \ --url https://api.debi.pro/v1/exports/%7Bid%7D \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/exports/%7Bid%7D', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/exports/%7Bid%7D'); $request->setMethod(HTTP_METH_GET); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: |- import requests url = "https://api.debi.pro/v1/exports/%7Bid%7D" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("https://api.debi.pro/v1/exports/%7Bid%7D") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/exports/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/imports: get: operationId: GetImports summary: Listado de Importaciones description: Obtener una lista de todas sus importaciones. parameters: - name: search in: query description: Search. required: false schema: type: string example: foo@bar.com - name: status in: query description: | Valores permitidos: `pending`, `ready`, `invalid`, `cancelled`, `processing`, `processed`. required: false schema: type: string example: ready - name: created_at in: query description: >- Un filtro en la lista, basado en el campo `created_at` del objeto. El valor puede ser un Unix Timestamp, o puede ser un diccionario con varias opciones de consulta diferentes. required: false schema: type: object properties: gt: description: Mínimo valor para filtrar (exclusivo) type: integer gte: description: Mínimo valor para filtrar (inclusivo) type: integer lt: description: Máximo valor para filtrar (exclusivo) type: integer lte: description: Máximo valor para filtrar (inclusivo) type: integer title: range_query_specs explode: true style: deepObject - name: ending_before in: query description: >- Un cursor para utilizar en la paginación. `ending_before` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, comenzando con `obj_ID`, la próxima llamda puede incluir `ending_before=obj_ID` para obtener la página previa. required: false schema: type: string style: form - name: limit in: query description: >- 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. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- Un cursor para utilizar en la paginación. `starting_after` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, terminando con `obj_ID`, la próxima llamda puede incluir `starting_after=obj_ID` para obtener la página siguiente. required: false schema: type: string style: form responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Importación description: Este objeto representa una importación de su cuenta. type: object properties: id: description: Identificador único de la Importación. type: string example: IM129038120h readOnly: true batch_job: type: object additionalProperties: true properties: {} cancelled_at: description: > Hora en la que se canceló la importación. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' invalid_at: description: > Hora en la que la importación se marcó como inválida. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' processed_at: description: > Hora en la que la importación se marcó como procesada. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' ready_at: description: > Hora en la que la importación se marcó como lista. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`.type: string type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' invalid_rows_count: description: Cantidad de filas no válido type: number example: 0 valid_rows_count: description: Cantidad de filas válidas type: number example: 0 rows_count: description: Cantidad de filas type: number example: 0 livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true original_filename: type: string example: subscriptions-import-template.csv type: description: Tipo de importación type: string example: subscriptions status: description: Estado de importación type: string example: processed created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' links: description: Links de paginación type: object properties: first: type: - 'null' - string example: https://api.debi.pro/v1/customers last: type: - 'null' - string example: https://api.debi.pro/v1/customers next: type: - 'null' - string example: https://api.debi.pro/v1/customers prev: type: - 'null' - string example: https://api.debi.pro/v1/customers title: Metadata de Respuesta meta: description: Metadata de paginación type: object properties: per_page: type: number example: 25 total: type: number example: 2500 path: type: string example: https://api.debi.pro/v1/customers next_cursor: description: Cursor de Paginación. type: - 'null' - string prev_cursor: description: Cursor de Paginación. type: - 'null' - string title: Response Meta required: - data example: 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: first: https://api.debi.pro/v1/imports?page=1 last: https://api.debi.pro/v1/imports?page=1 meta: next_cursor: null path: https://api.debi.pro/v1/imports per_page: 25 prev_cursor: null total: 7 '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Importaciones x-codeSamples: - lang: Shell + Curl source: |- 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_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/imports', qs: { 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' }, headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/imports'); $request->setMethod(HTTP_METH_GET); $request->setQueryData([ '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' ]); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/imports" querystring = {"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"} headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers, params=querystring) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("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_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("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") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body post: operationId: PostImport summary: Crear una importación description: Crear una importación. requestBody: required: true content: application/json: encoding: metadata: explode: true style: deepObject example: type: customers filename: a.csv original_filename: a.csv auto: true schema: type: object properties: type: type: string example: customers filename: type: string example: a.csv original_filename: type: string example: a.csv auto: type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} additionalProperties: false responses: '201': description: OK content: application/json: schema: properties: data: description: Este objeto representa una importación de su cuenta. type: object properties: id: description: Identificador único de la Importación. type: string example: IM129038120h readOnly: true batch_job: type: object additionalProperties: true properties: {} cancelled_at: description: > Hora en la que se canceló la importación. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' invalid_at: description: > Hora en la que la importación se marcó como inválida. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' processed_at: description: > Hora en la que la importación se marcó como procesada. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' ready_at: description: > Hora en la que la importación se marcó como lista. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`.type: string type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' invalid_rows_count: description: Cantidad de filas no válido type: number example: 0 valid_rows_count: description: Cantidad de filas válidas type: number example: 0 rows_count: description: Cantidad de filas type: number example: 0 livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true original_filename: type: string example: subscriptions-import-template.csv type: description: Tipo de importación type: string example: subscriptions status: description: Estado de importación type: string example: processed created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Importación '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '422': description: Unprocessable Entity content: application/json: example: errors: email: - El email es inválido. message: The given data was invalid. tags: - Importaciones x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/imports \ --header 'Authorization: Bearer sk_live_...' \ --header 'content-type: application/json' \ --data '{"type":"customers","filename":"a.csv","original_filename":"a.csv","auto":true,"metadata":{"some":"metadata"}}' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/imports', headers: { 'content-type': 'application/json', Authorization: 'Bearer sk_live_...' }, body: { type: 'customers', filename: 'a.csv', original_filename: 'a.csv', auto: true, metadata: {some: 'metadata'} }, json: true }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/imports'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'content-type' => 'application/json', 'Authorization' => 'Bearer sk_live_...' ]); $request->setBody('{"type":"customers","filename":"a.csv","original_filename":"a.csv","auto":true,"metadata":{"some":"metadata"}}'); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/imports" payload = { "type": "customers", "filename": "a.csv", "original_filename": "a.csv", "auto": True, "metadata": {"some": "metadata"} } headers = { "content-type": "application/json", "Authorization": "Bearer sk_live_..." } response = requests.request("POST", url, json=payload, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/imports") .header("content-type", "application/json") .header("Authorization", "Bearer sk_live_...") .body("{\"type\":\"customers\",\"filename\":\"a.csv\",\"original_filename\":\"a.csv\",\"auto\":true,\"metadata\":{\"some\":\"metadata\"}}") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/imports") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'application/json' request["Authorization"] = 'Bearer sk_live_...' request.body = "{\"type\":\"customers\",\"filename\":\"a.csv\",\"original_filename\":\"a.csv\",\"auto\":true,\"metadata\":{\"some\":\"metadata\"}}" response = http.request(request) puts response.read_body x-codegen-request-body-name: body /v1/imports/{id}: get: operationId: ImportsGetImport summary: Obtener una importación description: Obtener una importación. parameters: - name: id in: path description: Import ID. required: true schema: type: string example: IMKd7zlGJAna responses: '200': description: OK content: application/json: schema: properties: data: description: Este objeto representa una importación de su cuenta. type: object properties: id: description: Identificador único de la Importación. type: string example: IM129038120h readOnly: true batch_job: type: object additionalProperties: true properties: {} cancelled_at: description: > Hora en la que se canceló la importación. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' invalid_at: description: > Hora en la que la importación se marcó como inválida. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' processed_at: description: > Hora en la que la importación se marcó como procesada. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' ready_at: description: > Hora en la que la importación se marcó como lista. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`.type: string type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' invalid_rows_count: description: Cantidad de filas no válido type: number example: 0 valid_rows_count: description: Cantidad de filas válidas type: number example: 0 rows_count: description: Cantidad de filas type: number example: 0 livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true original_filename: type: string example: subscriptions-import-template.csv type: description: Tipo de importación type: string example: subscriptions status: description: Estado de importación type: string example: processed created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Importación '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '404': description: Recurso no encontrado content: application/json: schema: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found tags: - Importaciones x-codeSamples: - lang: Shell + Curl source: |- curl --request GET \ --url https://api.debi.pro/v1/imports/IMKd7zlGJAna \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/imports/IMKd7zlGJAna', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/imports/IMKd7zlGJAna'); $request->setMethod(HTTP_METH_GET); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: |- import requests url = "https://api.debi.pro/v1/imports/IMKd7zlGJAna" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("https://api.debi.pro/v1/imports/IMKd7zlGJAna") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/imports/IMKd7zlGJAna") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/imports/{id}/rows: get: operationId: ImportsListImportRows summary: Obtener filas de una Importación description: Obtener filas de una Importación. parameters: - name: id in: path description: Import ID. required: true schema: type: string example: IMKd7zlGJAna - name: filter in: query description: | **Validation**. _Example: valid_. Allows values: valid, invalid. schema: type: string - name: created_at in: query description: >- Un filtro en la lista, basado en el campo `created_at` del objeto. El valor puede ser un Unix Timestamp, o puede ser un diccionario con varias opciones de consulta diferentes. required: false schema: type: object properties: gt: description: Mínimo valor para filtrar (exclusivo) type: integer gte: description: Mínimo valor para filtrar (inclusivo) type: integer lt: description: Máximo valor para filtrar (exclusivo) type: integer lte: description: Máximo valor para filtrar (inclusivo) type: integer title: range_query_specs explode: true style: deepObject - name: ending_before in: query description: >- Un cursor para utilizar en la paginación. `ending_before` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, comenzando con `obj_ID`, la próxima llamda puede incluir `ending_before=obj_ID` para obtener la página previa. required: false schema: type: string style: form - name: limit in: query description: >- 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. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- Un cursor para utilizar en la paginación. `starting_after` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, terminando con `obj_ID`, la próxima llamda puede incluir `starting_after=obj_ID` para obtener la página siguiente. required: false schema: type: string style: form responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Fila de Importación description: >- Este objeto representa una fila de una importación de su cuenta. type: object properties: id: description: Identificador único de la Fila de Importación. type: string example: IR129038120h readOnly: true valid: description: Declara si la fila de importación es válida. type: boolean example: true data: description: Contenido de la fila de importación. type: object additionalProperties: true properties: {} livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true resource: description: Recurso relacionado con el evento. type: string example: customer enum: - customer - gateway - import - mandate - payment - payment_method - subscription resource_id: description: ID del recurso relacionado con el evento. type: string example: CS12312d1d1dl created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' links: description: Links de paginación type: object properties: first: type: - 'null' - string example: https://api.debi.pro/v1/customers last: type: - 'null' - string example: https://api.debi.pro/v1/customers next: type: - 'null' - string example: https://api.debi.pro/v1/customers prev: type: - 'null' - string example: https://api.debi.pro/v1/customers title: Metadata de Respuesta meta: description: Metadata de paginación type: object properties: per_page: type: number example: 25 total: type: number example: 2500 path: type: string example: https://api.debi.pro/v1/customers next_cursor: description: Cursor de Paginación. type: - 'null' - string prev_cursor: description: Cursor de Paginación. type: - 'null' - string title: Response Meta required: - data example: 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: first: https://api.debi.pro/v1/imports?page=1 last: https://api.debi.pro/v1/imports?page=1 meta: total: 2730 next_cursor: null path: https://debi.pro/api/imports/IMBPkWDn3J0y/rows per_page: 1000 prev_cursor: null '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Importaciones x-codeSamples: - lang: Shell + Curl source: |- 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_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/imports/IMKd7zlGJAna/rows', qs: { filter: 'SOME_STRING_VALUE', created_at: 'SOME_OBJECT_VALUE', ending_before: 'SOME_STRING_VALUE', limit: 'SOME_INTEGER_VALUE', starting_after: 'SOME_STRING_VALUE' }, headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/imports/IMKd7zlGJAna/rows'); $request->setMethod(HTTP_METH_GET); $request->setQueryData([ 'filter' => 'SOME_STRING_VALUE', 'created_at' => 'SOME_OBJECT_VALUE', 'ending_before' => 'SOME_STRING_VALUE', 'limit' => 'SOME_INTEGER_VALUE', 'starting_after' => 'SOME_STRING_VALUE' ]); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/imports/IMKd7zlGJAna/rows" querystring = {"filter":"SOME_STRING_VALUE","created_at":"SOME_OBJECT_VALUE","ending_before":"SOME_STRING_VALUE","limit":"SOME_INTEGER_VALUE","starting_after":"SOME_STRING_VALUE"} headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers, params=querystring) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("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_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("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") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/links: get: operationId: LinksGetLinks summary: Listado de Links description: Obtener una lista con todos sus Links. parameters: - name: search in: query description: Search. required: false schema: type: string example: foo@bar.com - name: created_at in: query description: >- Un filtro en la lista, basado en el campo `created_at` del objeto. El valor puede ser un Unix Timestamp, o puede ser un diccionario con varias opciones de consulta diferentes. required: false schema: type: object properties: gt: description: Mínimo valor para filtrar (exclusivo) type: integer gte: description: Mínimo valor para filtrar (inclusivo) type: integer lt: description: Máximo valor para filtrar (exclusivo) type: integer lte: description: Máximo valor para filtrar (inclusivo) type: integer title: range_query_specs explode: true style: deepObject - name: ending_before in: query description: >- Un cursor para utilizar en la paginación. `ending_before` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, comenzando con `obj_ID`, la próxima llamda puede incluir `ending_before=obj_ID` para obtener la página previa. required: false schema: type: string style: form - name: limit in: query description: >- 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. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- Un cursor para utilizar en la paginación. `starting_after` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, terminando con `obj_ID`, la próxima llamda puede incluir `starting_after=obj_ID` para obtener la página siguiente. required: false schema: type: string style: form responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Link description: Este objeto representa un Link de su organización. type: object properties: id: description: Identificador único del objeto. type: string readOnly: true uuid: description: Identificador UUID del objeto. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} extra_fields: description: > Una colección de campos diseñados para almacenarse como [metadatos](#section/Metadata) del objeto que la Sesión está generando, ya sea un [Pago](#tag/Payments), [Suscripción](#tag/Subscriptions) o [Adhesión](#tag/Mandates). 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. type: - object - 'null' example: - 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: description: > Una colección de campos diseñados para almacenarse como [metadatos](#section/Metadata) del [Cliente](#tag/Customers) 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. type: - object - 'null' example: - 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: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' object: type: string enum: - link title: description: Título del enlace de pago type: string example: Monthly Subscription body: description: Descripción del enlace de pago type: string example: Subscribe to our premium service button_text: description: Texto para el botón de pago type: string example: Pay Now name_text: description: Texto para el campo de nombre type: string example: Full Name success_url: description: URL para redirigir después del pago exitoso type: string format: uri example: https://example.com/success kind: description: Tipo de enlace de pago type: string example: payment enum: - payment - subscription - mandate enabled: description: Si el enlace está habilitado type: boolean example: true smart_merge: description: Habilitar funcionalidad de fusión inteligente type: boolean example: false binary_mode: description: > Fuerza el procesamiento instantáneo de pagos, proporcionando un estado inmediato de `approved` o `rejected` dentro de la respuesta de la solicitud. Esta configuración evita respuestas inconclusivas (como pagos con estado `submitted`) usando solo gateways que pueden procesar pagos instantáneamente, garantizando un resultado rápido y concluyente. Es particularmente útil cuando se procesan pagos en un flujo de checkout que requiere una respuesta sincrónica, permitiendo al cliente recibir instantáneamente el resultado de la transacción. También considere que este modo deshabilita los reintentos automáticos para pagos fallidos, pero este comportamiento puede ser gestionado también definiendo la cantidad máxima de veces que se puede volver a intentar el pago automáticamente estableciendo el parámetro `auto_retries_max_attempts`. type: boolean example: true payment_method_types: description: > Array de tipos de métodos de pago permitidos. Si no se especifica, se permitirán todos los métodos de pago disponibles. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Opciones de configuración para tipos específicos de métodos de pago, como no permitir ciertas redes de tarjetas o tipos de financiamiento. type: object example: card: disallow: funding: - prepaid network: - amex properties: card: type: object properties: disallow: type: object properties: funding: description: Funding types to disallow type: array items: type: string enum: - credit - debit - prepaid - unknown example: - prepaid network: description: Card networks to disallow type: array items: type: string enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa example: - amex supported_payment_methods: description: >- Métodos de pago disponibles basados en la configuración del gateway del usuario type: array items: type: object example: [] readOnly: true options: description: Opciones de pago para el enlace type: array items: type: object properties: description: description: Description of this payment option type: string example: Standard Payment amount: description: Amount for this option type: number example: 100 editable_amount: description: Allow customer to set the amount type: boolean example: false example: - description: Premium Plan amount: 29.99 editable_amount: false public_uri: description: La URL pública para este enlace de pago type: string example: https://debi.pro/link/LKnJZX0DMv2Mzd4Qp6 readOnly: true links: description: Links de paginación type: object properties: first: type: - 'null' - string example: https://api.debi.pro/v1/customers last: type: - 'null' - string example: https://api.debi.pro/v1/customers next: type: - 'null' - string example: https://api.debi.pro/v1/customers prev: type: - 'null' - string example: https://api.debi.pro/v1/customers title: Metadata de Respuesta meta: description: Metadata de paginación type: object properties: per_page: type: number example: 25 total: type: number example: 2500 path: type: string example: https://api.debi.pro/v1/customers next_cursor: description: Cursor de Paginación. type: - 'null' - string prev_cursor: description: Cursor de Paginación. type: - 'null' - string title: Response Meta required: - data '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Links x-codeSamples: - lang: Shell + Curl source: |- 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_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/links', qs: { search: 'SOME_STRING_VALUE', created_at: 'SOME_OBJECT_VALUE', ending_before: 'SOME_STRING_VALUE', limit: 'SOME_INTEGER_VALUE', starting_after: 'SOME_STRING_VALUE' }, headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/links'); $request->setMethod(HTTP_METH_GET); $request->setQueryData([ 'search' => 'SOME_STRING_VALUE', 'created_at' => 'SOME_OBJECT_VALUE', 'ending_before' => 'SOME_STRING_VALUE', 'limit' => 'SOME_INTEGER_VALUE', 'starting_after' => 'SOME_STRING_VALUE' ]); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/links" querystring = {"search":"SOME_STRING_VALUE","created_at":"SOME_OBJECT_VALUE","ending_before":"SOME_STRING_VALUE","limit":"SOME_INTEGER_VALUE","starting_after":"SOME_STRING_VALUE"} headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers, params=querystring) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("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_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("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") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body post: operationId: LinksCreateLink summary: Crear un link description: Crear un link. requestBody: required: true content: application/json: schema: type: object properties: title: description: Título del enlace de pago type: string example: Monthly Subscription body: description: Descripción del enlace de pago type: string example: Subscribe to our monthly service button_text: description: Texto para el botón de pago type: string example: Pay Now name_text: description: Texto para el campo de nombre type: string example: Full Name success_url: description: URL para redirigir después del pago exitoso type: string format: uri example: https://example.com/success kind: description: Tipo de enlace de pago type: string example: payment enum: - payment - subscription - mandate enabled: description: Si el enlace está habilitado type: boolean example: true smart_merge: description: Habilitar funcionalidad de fusión inteligente type: boolean example: false binary_mode: description: > Fuerza el procesamiento instantáneo de pagos, proporcionando un estado inmediato de `approved` o `rejected` dentro de la respuesta de la solicitud. Esta configuración evita respuestas inconclusivas (como pagos con estado `submitted`) usando solo gateways que pueden procesar pagos instantáneamente, garantizando un resultado rápido y concluyente. Es particularmente útil cuando se procesan pagos en un flujo de checkout que requiere una respuesta sincrónica, permitiendo al cliente recibir instantáneamente el resultado de la transacción. También considere que este modo deshabilita los reintentos automáticos para pagos fallidos, pero este comportamiento puede ser gestionado también definiendo la cantidad máxima de veces que se puede volver a intentar el pago automáticamente estableciendo el parámetro `auto_retries_max_attempts`. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} extra_fields: description: > Una colección de campos diseñados para almacenarse como [metadatos](#section/Metadata) del objeto que la Sesión está generando, ya sea un [Pago](#tag/Payments), [Suscripción](#tag/Subscriptions) o [Adhesión](#tag/Mandates). 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. type: - object - 'null' example: - 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: description: > Una colección de campos diseñados para almacenarse como [metadatos](#section/Metadata) del [Cliente](#tag/Customers) 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. type: - object - 'null' example: - 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 payment_method_types: description: > Array de tipos de métodos de pago permitidos. Si no se especifica, se permitirán todos los métodos de pago disponibles. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Opciones de configuración para tipos específicos de métodos de pago, como no permitir ciertas redes de tarjetas o tipos de financiamiento. type: object example: card: disallow: funding: - prepaid network: - amex properties: card: type: object properties: disallow: type: object properties: funding: description: Funding types to disallow type: array items: type: string enum: - credit - debit - prepaid - unknown example: - prepaid network: description: Card networks to disallow type: array items: type: string enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa example: - amex options: description: >- Opciones de pago para el enlace (requerido para tipos payment y subscription) type: array items: type: object required: - description properties: description: description: Description of this payment option type: string example: Standard Payment amount: description: >- Amount for this option (required if editable_amount is false) type: number example: 100 editable_amount: description: Allow customer to set the amount type: boolean example: false installments: description: Number of installments (for payments) type: integer example: 1 max_installments: description: Maximum installments allowed (for payments) type: integer example: 12 interval_unit: description: Interval unit for subscriptions type: string example: monthly enum: - weekly - monthly - yearly interval: description: Interval between charges type: integer example: 1 count: description: Total number of payments for subscriptions type: integer example: 12 editable_count: description: Allow customer to set subscription duration type: boolean example: false required: - title - kind example: title: Monthly Subscription body: Subscribe to our premium service kind: payment payment_method_types: - card - cbu payment_method_options: card: disallow: funding: - prepaid options: - description: Premium Plan amount: 29.99 editable_amount: false responses: '201': description: OK content: application/json: schema: properties: data: description: Este objeto representa un Link de su organización. type: object properties: id: description: Identificador único del objeto. type: string readOnly: true uuid: description: Identificador UUID del objeto. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} extra_fields: description: > Una colección de campos diseñados para almacenarse como [metadatos](#section/Metadata) del objeto que la Sesión está generando, ya sea un [Pago](#tag/Payments), [Suscripción](#tag/Subscriptions) o [Adhesión](#tag/Mandates). 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. type: - object - 'null' example: - 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: description: > Una colección de campos diseñados para almacenarse como [metadatos](#section/Metadata) del [Cliente](#tag/Customers) 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. type: - object - 'null' example: - 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: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' object: type: string enum: - link title: description: Título del enlace de pago type: string example: Monthly Subscription body: description: Descripción del enlace de pago type: string example: Subscribe to our premium service button_text: description: Texto para el botón de pago type: string example: Pay Now name_text: description: Texto para el campo de nombre type: string example: Full Name success_url: description: URL para redirigir después del pago exitoso type: string format: uri example: https://example.com/success kind: description: Tipo de enlace de pago type: string example: payment enum: - payment - subscription - mandate enabled: description: Si el enlace está habilitado type: boolean example: true smart_merge: description: Habilitar funcionalidad de fusión inteligente type: boolean example: false binary_mode: description: > Fuerza el procesamiento instantáneo de pagos, proporcionando un estado inmediato de `approved` o `rejected` dentro de la respuesta de la solicitud. Esta configuración evita respuestas inconclusivas (como pagos con estado `submitted`) usando solo gateways que pueden procesar pagos instantáneamente, garantizando un resultado rápido y concluyente. Es particularmente útil cuando se procesan pagos en un flujo de checkout que requiere una respuesta sincrónica, permitiendo al cliente recibir instantáneamente el resultado de la transacción. También considere que este modo deshabilita los reintentos automáticos para pagos fallidos, pero este comportamiento puede ser gestionado también definiendo la cantidad máxima de veces que se puede volver a intentar el pago automáticamente estableciendo el parámetro `auto_retries_max_attempts`. type: boolean example: true payment_method_types: description: > Array de tipos de métodos de pago permitidos. Si no se especifica, se permitirán todos los métodos de pago disponibles. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Opciones de configuración para tipos específicos de métodos de pago, como no permitir ciertas redes de tarjetas o tipos de financiamiento. type: object example: card: disallow: funding: - prepaid network: - amex properties: card: type: object properties: disallow: type: object properties: funding: description: Funding types to disallow type: array items: type: string enum: - credit - debit - prepaid - unknown example: - prepaid network: description: Card networks to disallow type: array items: type: string enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa example: - amex supported_payment_methods: description: >- Métodos de pago disponibles basados en la configuración del gateway del usuario type: array items: type: object example: [] readOnly: true options: description: Opciones de pago para el enlace type: array items: type: object properties: description: description: Description of this payment option type: string example: Standard Payment amount: description: Amount for this option type: number example: 100 editable_amount: description: Allow customer to set the amount type: boolean example: false example: - description: Premium Plan amount: 29.99 editable_amount: false public_uri: description: La URL pública para este enlace de pago type: string example: https://debi.pro/link/LKnJZX0DMv2Mzd4Qp6 readOnly: true title: Link '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Links x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/links \ --header 'Authorization: Bearer sk_live_...' \ --header 'content-type: application/json' \ --data '{"title":"Monthly Subscription","body":"Subscribe to our monthly service","button_text":"Pay Now","name_text":"Full Name","success_url":"https://example.com/success","kind":"payment","enabled":true,"smart_merge":false,"binary_mode":true,"metadata":{"some":"metadata"},"customer_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"}],"payment_method_types":["card","cbu","cvu"],"payment_method_options":{"card":{"disallow":{"funding":["prepaid"],"network":["amex"]}}},"options":[{"description":"Standard Payment","amount":100,"editable_amount":false,"installments":1,"max_installments":12,"interval_unit":"monthly","interval":1,"count":12,"editable_count":false}]}' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/links', headers: { 'content-type': 'application/json', Authorization: 'Bearer sk_live_...' }, body: { title: 'Monthly Subscription', body: 'Subscribe to our monthly service', button_text: 'Pay Now', name_text: 'Full Name', success_url: 'https://example.com/success', kind: 'payment', enabled: true, smart_merge: false, binary_mode: true, metadata: {some: 'metadata'}, customer_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'} ], payment_method_types: ['card', 'cbu', 'cvu'], payment_method_options: {card: {disallow: {funding: ['prepaid'], network: ['amex']}}}, options: [ { description: 'Standard Payment', amount: 100, editable_amount: false, installments: 1, max_installments: 12, interval_unit: 'monthly', interval: 1, count: 12, editable_count: false } ] }, json: true }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/links'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'content-type' => 'application/json', 'Authorization' => 'Bearer sk_live_...' ]); $request->setBody('{"title":"Monthly Subscription","body":"Subscribe to our monthly service","button_text":"Pay Now","name_text":"Full Name","success_url":"https://example.com/success","kind":"payment","enabled":true,"smart_merge":false,"binary_mode":true,"metadata":{"some":"metadata"},"customer_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"}],"payment_method_types":["card","cbu","cvu"],"payment_method_options":{"card":{"disallow":{"funding":["prepaid"],"network":["amex"]}}},"options":[{"description":"Standard Payment","amount":100,"editable_amount":false,"installments":1,"max_installments":12,"interval_unit":"monthly","interval":1,"count":12,"editable_count":false}]}'); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/links" payload = { "title": "Monthly Subscription", "body": "Subscribe to our monthly service", "button_text": "Pay Now", "name_text": "Full Name", "success_url": "https://example.com/success", "kind": "payment", "enabled": True, "smart_merge": False, "binary_mode": True, "metadata": {"some": "metadata"}, "customer_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" } ], "payment_method_types": ["card", "cbu", "cvu"], "payment_method_options": {"card": {"disallow": { "funding": ["prepaid"], "network": ["amex"] }}}, "options": [ { "description": "Standard Payment", "amount": 100, "editable_amount": False, "installments": 1, "max_installments": 12, "interval_unit": "monthly", "interval": 1, "count": 12, "editable_count": False } ] } headers = { "content-type": "application/json", "Authorization": "Bearer sk_live_..." } response = requests.request("POST", url, json=payload, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/links") .header("content-type", "application/json") .header("Authorization", "Bearer sk_live_...") .body("{\"title\":\"Monthly Subscription\",\"body\":\"Subscribe to our monthly service\",\"button_text\":\"Pay Now\",\"name_text\":\"Full Name\",\"success_url\":\"https://example.com/success\",\"kind\":\"payment\",\"enabled\":true,\"smart_merge\":false,\"binary_mode\":true,\"metadata\":{\"some\":\"metadata\"},\"customer_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\"}],\"payment_method_types\":[\"card\",\"cbu\",\"cvu\"],\"payment_method_options\":{\"card\":{\"disallow\":{\"funding\":[\"prepaid\"],\"network\":[\"amex\"]}}},\"options\":[{\"description\":\"Standard Payment\",\"amount\":100,\"editable_amount\":false,\"installments\":1,\"max_installments\":12,\"interval_unit\":\"monthly\",\"interval\":1,\"count\":12,\"editable_count\":false}]}") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/links") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'application/json' request["Authorization"] = 'Bearer sk_live_...' request.body = "{\"title\":\"Monthly Subscription\",\"body\":\"Subscribe to our monthly service\",\"button_text\":\"Pay Now\",\"name_text\":\"Full Name\",\"success_url\":\"https://example.com/success\",\"kind\":\"payment\",\"enabled\":true,\"smart_merge\":false,\"binary_mode\":true,\"metadata\":{\"some\":\"metadata\"},\"customer_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\"}],\"payment_method_types\":[\"card\",\"cbu\",\"cvu\"],\"payment_method_options\":{\"card\":{\"disallow\":{\"funding\":[\"prepaid\"],\"network\":[\"amex\"]}}},\"options\":[{\"description\":\"Standard Payment\",\"amount\":100,\"editable_amount\":false,\"installments\":1,\"max_installments\":12,\"interval_unit\":\"monthly\",\"interval\":1,\"count\":12,\"editable_count\":false}]}" response = http.request(request) puts response.read_body /v1/links/{id}: get: operationId: LinksGetLink summary: Obtener un link description: Obtener detalles de un enlace de pago específico. parameters: - name: id in: path description: The link ID required: true schema: type: string example: LKnJZX0DMv2Mzd4Qp6 responses: '200': description: Detalles del enlace content: application/json: schema: properties: data: description: Este objeto representa un Link de su organización. type: object properties: id: description: Identificador único del objeto. type: string readOnly: true uuid: description: Identificador UUID del objeto. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} extra_fields: description: > Una colección de campos diseñados para almacenarse como [metadatos](#section/Metadata) del objeto que la Sesión está generando, ya sea un [Pago](#tag/Payments), [Suscripción](#tag/Subscriptions) o [Adhesión](#tag/Mandates). 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. type: - object - 'null' example: - 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: description: > Una colección de campos diseñados para almacenarse como [metadatos](#section/Metadata) del [Cliente](#tag/Customers) 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. type: - object - 'null' example: - 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: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' object: type: string enum: - link title: description: Título del enlace de pago type: string example: Monthly Subscription body: description: Descripción del enlace de pago type: string example: Subscribe to our premium service button_text: description: Texto para el botón de pago type: string example: Pay Now name_text: description: Texto para el campo de nombre type: string example: Full Name success_url: description: URL para redirigir después del pago exitoso type: string format: uri example: https://example.com/success kind: description: Tipo de enlace de pago type: string example: payment enum: - payment - subscription - mandate enabled: description: Si el enlace está habilitado type: boolean example: true smart_merge: description: Habilitar funcionalidad de fusión inteligente type: boolean example: false binary_mode: description: > Fuerza el procesamiento instantáneo de pagos, proporcionando un estado inmediato de `approved` o `rejected` dentro de la respuesta de la solicitud. Esta configuración evita respuestas inconclusivas (como pagos con estado `submitted`) usando solo gateways que pueden procesar pagos instantáneamente, garantizando un resultado rápido y concluyente. Es particularmente útil cuando se procesan pagos en un flujo de checkout que requiere una respuesta sincrónica, permitiendo al cliente recibir instantáneamente el resultado de la transacción. También considere que este modo deshabilita los reintentos automáticos para pagos fallidos, pero este comportamiento puede ser gestionado también definiendo la cantidad máxima de veces que se puede volver a intentar el pago automáticamente estableciendo el parámetro `auto_retries_max_attempts`. type: boolean example: true payment_method_types: description: > Array de tipos de métodos de pago permitidos. Si no se especifica, se permitirán todos los métodos de pago disponibles. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Opciones de configuración para tipos específicos de métodos de pago, como no permitir ciertas redes de tarjetas o tipos de financiamiento. type: object example: card: disallow: funding: - prepaid network: - amex properties: card: type: object properties: disallow: type: object properties: funding: description: Funding types to disallow type: array items: type: string enum: - credit - debit - prepaid - unknown example: - prepaid network: description: Card networks to disallow type: array items: type: string enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa example: - amex supported_payment_methods: description: >- Métodos de pago disponibles basados en la configuración del gateway del usuario type: array items: type: object example: [] readOnly: true options: description: Opciones de pago para el enlace type: array items: type: object properties: description: description: Description of this payment option type: string example: Standard Payment amount: description: Amount for this option type: number example: 100 editable_amount: description: Allow customer to set the amount type: boolean example: false example: - description: Premium Plan amount: 29.99 editable_amount: false public_uri: description: La URL pública para este enlace de pago type: string example: https://debi.pro/link/LKnJZX0DMv2Mzd4Qp6 readOnly: true title: Link '401': description: No autorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '404': description: Recurso no encontrado content: application/json: schema: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found tags: - Links x-codeSamples: - lang: Shell + Curl source: |- curl --request GET \ --url https://api.debi.pro/v1/links/%7Bid%7D \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/links/%7Bid%7D', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/links/%7Bid%7D'); $request->setMethod(HTTP_METH_GET); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: |- import requests url = "https://api.debi.pro/v1/links/%7Bid%7D" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("https://api.debi.pro/v1/links/%7Bid%7D") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/links/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body put: operationId: LinksUpdateLink summary: Actualizar un link description: >- Actualizar un enlace de pago existente. Todos los campos son opcionales - solo proporcione los campos que desea actualizar. parameters: - name: id in: path description: The link ID required: true schema: type: string example: LKnJZX0DMv2Mzd4Qp6 requestBody: required: false content: application/json: schema: type: object properties: title: description: Título del enlace de pago type: string example: Updated Monthly Subscription body: description: Descripción del enlace de pago type: string example: Updated subscribe to our premium service button_text: description: Texto para el botón de pago type: string example: Subscribe Now name_text: description: Texto para el campo de nombre type: string example: Your Full Name success_url: description: URL para redirigir después del pago exitoso type: string format: uri example: https://example.com/updated-success kind: description: Tipo de enlace de pago type: string example: subscription enum: - payment - subscription - mandate enabled: description: Si el enlace está habilitado type: boolean example: false smart_merge: description: Habilitar funcionalidad de fusión inteligente type: boolean example: true binary_mode: description: > Fuerza el procesamiento instantáneo de pagos, proporcionando un estado inmediato de `approved` o `rejected` dentro de la respuesta de la solicitud. Esta configuración evita respuestas inconclusivas (como pagos con estado `submitted`) usando solo gateways que pueden procesar pagos instantáneamente, garantizando un resultado rápido y concluyente. Es particularmente útil cuando se procesan pagos en un flujo de checkout que requiere una respuesta sincrónica, permitiendo al cliente recibir instantáneamente el resultado de la transacción. También considere que este modo deshabilita los reintentos automáticos para pagos fallidos, pero este comportamiento puede ser gestionado también definiendo la cantidad máxima de veces que se puede volver a intentar el pago automáticamente estableciendo el parámetro `auto_retries_max_attempts`. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} extra_fields: description: > Una colección de campos diseñados para almacenarse como [metadatos](#section/Metadata) del objeto que la Sesión está generando, ya sea un [Pago](#tag/Payments), [Suscripción](#tag/Subscriptions) o [Adhesión](#tag/Mandates). 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. type: - object - 'null' example: - 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: description: > Una colección de campos diseñados para almacenarse como [metadatos](#section/Metadata) del [Cliente](#tag/Customers) 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. type: - object - 'null' example: - 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 payment_method_types: description: > Array de tipos de métodos de pago permitidos. Si no se especifica, se permitirán todos los métodos de pago disponibles. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Opciones de configuración para tipos específicos de métodos de pago, como no permitir ciertas redes de tarjetas o tipos de financiamiento. type: object example: card: disallow: funding: - prepaid network: - amex properties: card: type: object properties: disallow: type: object properties: funding: description: Funding types to disallow type: array items: type: string enum: - credit - debit - prepaid - unknown example: - prepaid network: description: Card networks to disallow type: array items: type: string enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa example: - amex options: description: >- Opciones de pago para el enlace (requerido para tipos payment y subscription) type: array items: type: object properties: description: description: Description of this payment option type: string example: Updated Standard Payment amount: description: >- Amount for this option (required if editable_amount is false) type: number example: 149.99 editable_amount: description: Allow customer to set the amount type: boolean example: true installments: description: Number of installments (for payments) type: integer example: 3 max_installments: description: Maximum installments allowed (for payments) type: integer example: 24 interval_unit: description: Interval unit for subscriptions type: string example: yearly enum: - weekly - monthly - yearly interval: description: Interval between charges type: integer example: 1 count: description: Total number of payments for subscriptions type: integer example: 5 editable_count: description: Allow customer to set subscription duration type: boolean example: true example: title: Updated Annual Subscription enabled: false payment_method_types: - card options: - description: Annual Premium Plan amount: 299.99 editable_amount: false responses: '200': description: Enlace actualizado exitosamente content: application/json: schema: properties: data: description: Este objeto representa un Link de su organización. type: object properties: id: description: Identificador único del objeto. type: string readOnly: true uuid: description: Identificador UUID del objeto. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} extra_fields: description: > Una colección de campos diseñados para almacenarse como [metadatos](#section/Metadata) del objeto que la Sesión está generando, ya sea un [Pago](#tag/Payments), [Suscripción](#tag/Subscriptions) o [Adhesión](#tag/Mandates). 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. type: - object - 'null' example: - 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: description: > Una colección de campos diseñados para almacenarse como [metadatos](#section/Metadata) del [Cliente](#tag/Customers) 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. type: - object - 'null' example: - 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: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' object: type: string enum: - link title: description: Título del enlace de pago type: string example: Monthly Subscription body: description: Descripción del enlace de pago type: string example: Subscribe to our premium service button_text: description: Texto para el botón de pago type: string example: Pay Now name_text: description: Texto para el campo de nombre type: string example: Full Name success_url: description: URL para redirigir después del pago exitoso type: string format: uri example: https://example.com/success kind: description: Tipo de enlace de pago type: string example: payment enum: - payment - subscription - mandate enabled: description: Si el enlace está habilitado type: boolean example: true smart_merge: description: Habilitar funcionalidad de fusión inteligente type: boolean example: false binary_mode: description: > Fuerza el procesamiento instantáneo de pagos, proporcionando un estado inmediato de `approved` o `rejected` dentro de la respuesta de la solicitud. Esta configuración evita respuestas inconclusivas (como pagos con estado `submitted`) usando solo gateways que pueden procesar pagos instantáneamente, garantizando un resultado rápido y concluyente. Es particularmente útil cuando se procesan pagos en un flujo de checkout que requiere una respuesta sincrónica, permitiendo al cliente recibir instantáneamente el resultado de la transacción. También considere que este modo deshabilita los reintentos automáticos para pagos fallidos, pero este comportamiento puede ser gestionado también definiendo la cantidad máxima de veces que se puede volver a intentar el pago automáticamente estableciendo el parámetro `auto_retries_max_attempts`. type: boolean example: true payment_method_types: description: > Array de tipos de métodos de pago permitidos. Si no se especifica, se permitirán todos los métodos de pago disponibles. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Opciones de configuración para tipos específicos de métodos de pago, como no permitir ciertas redes de tarjetas o tipos de financiamiento. type: object example: card: disallow: funding: - prepaid network: - amex properties: card: type: object properties: disallow: type: object properties: funding: description: Funding types to disallow type: array items: type: string enum: - credit - debit - prepaid - unknown example: - prepaid network: description: Card networks to disallow type: array items: type: string enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa example: - amex supported_payment_methods: description: >- Métodos de pago disponibles basados en la configuración del gateway del usuario type: array items: type: object example: [] readOnly: true options: description: Opciones de pago para el enlace type: array items: type: object properties: description: description: Description of this payment option type: string example: Standard Payment amount: description: Amount for this option type: number example: 100 editable_amount: description: Allow customer to set the amount type: boolean example: false example: - description: Premium Plan amount: 29.99 editable_amount: false public_uri: description: La URL pública para este enlace de pago type: string example: https://debi.pro/link/LKnJZX0DMv2Mzd4Qp6 readOnly: true title: Link '401': description: No autorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '404': description: Recurso no encontrado content: application/json: schema: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found '422': description: Error de validación content: application/json: schema: description: Error de Validación type: object properties: message: type: string errors: type: array items: type: string example: errors: email: - El email es inválido. message: The given data was invalid. title: Error de Validación tags: - Links x-codeSamples: - lang: Shell + Curl source: |- curl --request PUT \ --url https://api.debi.pro/v1/links/%7Bid%7D \ --header 'Authorization: Bearer sk_live_...' \ --header 'content-type: application/json' \ --data '{"title":"Updated Monthly Subscription","body":"Updated subscribe to our premium service","button_text":"Subscribe Now","name_text":"Your Full Name","success_url":"https://example.com/updated-success","kind":"subscription","enabled":false,"smart_merge":true,"binary_mode":true,"metadata":{"some":"metadata"},"customer_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"}],"payment_method_types":["card","cbu","cvu"],"payment_method_options":{"card":{"disallow":{"funding":["prepaid"],"network":["amex"]}}},"options":[{"description":"Updated Standard Payment","amount":149.99,"editable_amount":true,"installments":3,"max_installments":24,"interval_unit":"yearly","interval":1,"count":5,"editable_count":true}]}' - lang: Node + Request source: | const request = require('request'); const options = { method: 'PUT', url: 'https://api.debi.pro/v1/links/%7Bid%7D', headers: { 'content-type': 'application/json', Authorization: 'Bearer sk_live_...' }, body: { title: 'Updated Monthly Subscription', body: 'Updated subscribe to our premium service', button_text: 'Subscribe Now', name_text: 'Your Full Name', success_url: 'https://example.com/updated-success', kind: 'subscription', enabled: false, smart_merge: true, binary_mode: true, metadata: {some: 'metadata'}, customer_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'} ], payment_method_types: ['card', 'cbu', 'cvu'], payment_method_options: {card: {disallow: {funding: ['prepaid'], network: ['amex']}}}, options: [ { description: 'Updated Standard Payment', amount: 149.99, editable_amount: true, installments: 3, max_installments: 24, interval_unit: 'yearly', interval: 1, count: 5, editable_count: true } ] }, json: true }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/links/%7Bid%7D'); $request->setMethod(HTTP_METH_PUT); $request->setHeaders([ 'content-type' => 'application/json', 'Authorization' => 'Bearer sk_live_...' ]); $request->setBody('{"title":"Updated Monthly Subscription","body":"Updated subscribe to our premium service","button_text":"Subscribe Now","name_text":"Your Full Name","success_url":"https://example.com/updated-success","kind":"subscription","enabled":false,"smart_merge":true,"binary_mode":true,"metadata":{"some":"metadata"},"customer_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"}],"payment_method_types":["card","cbu","cvu"],"payment_method_options":{"card":{"disallow":{"funding":["prepaid"],"network":["amex"]}}},"options":[{"description":"Updated Standard Payment","amount":149.99,"editable_amount":true,"installments":3,"max_installments":24,"interval_unit":"yearly","interval":1,"count":5,"editable_count":true}]}'); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/links/%7Bid%7D" payload = { "title": "Updated Monthly Subscription", "body": "Updated subscribe to our premium service", "button_text": "Subscribe Now", "name_text": "Your Full Name", "success_url": "https://example.com/updated-success", "kind": "subscription", "enabled": False, "smart_merge": True, "binary_mode": True, "metadata": {"some": "metadata"}, "customer_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" } ], "payment_method_types": ["card", "cbu", "cvu"], "payment_method_options": {"card": {"disallow": { "funding": ["prepaid"], "network": ["amex"] }}}, "options": [ { "description": "Updated Standard Payment", "amount": 149.99, "editable_amount": True, "installments": 3, "max_installments": 24, "interval_unit": "yearly", "interval": 1, "count": 5, "editable_count": True } ] } headers = { "content-type": "application/json", "Authorization": "Bearer sk_live_..." } response = requests.request("PUT", url, json=payload, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.put("https://api.debi.pro/v1/links/%7Bid%7D") .header("content-type", "application/json") .header("Authorization", "Bearer sk_live_...") .body("{\"title\":\"Updated Monthly Subscription\",\"body\":\"Updated subscribe to our premium service\",\"button_text\":\"Subscribe Now\",\"name_text\":\"Your Full Name\",\"success_url\":\"https://example.com/updated-success\",\"kind\":\"subscription\",\"enabled\":false,\"smart_merge\":true,\"binary_mode\":true,\"metadata\":{\"some\":\"metadata\"},\"customer_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\"}],\"payment_method_types\":[\"card\",\"cbu\",\"cvu\"],\"payment_method_options\":{\"card\":{\"disallow\":{\"funding\":[\"prepaid\"],\"network\":[\"amex\"]}}},\"options\":[{\"description\":\"Updated Standard Payment\",\"amount\":149.99,\"editable_amount\":true,\"installments\":3,\"max_installments\":24,\"interval_unit\":\"yearly\",\"interval\":1,\"count\":5,\"editable_count\":true}]}") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/links/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'application/json' request["Authorization"] = 'Bearer sk_live_...' request.body = "{\"title\":\"Updated Monthly Subscription\",\"body\":\"Updated subscribe to our premium service\",\"button_text\":\"Subscribe Now\",\"name_text\":\"Your Full Name\",\"success_url\":\"https://example.com/updated-success\",\"kind\":\"subscription\",\"enabled\":false,\"smart_merge\":true,\"binary_mode\":true,\"metadata\":{\"some\":\"metadata\"},\"customer_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\"}],\"payment_method_types\":[\"card\",\"cbu\",\"cvu\"],\"payment_method_options\":{\"card\":{\"disallow\":{\"funding\":[\"prepaid\"],\"network\":[\"amex\"]}}},\"options\":[{\"description\":\"Updated Standard Payment\",\"amount\":149.99,\"editable_amount\":true,\"installments\":3,\"max_installments\":24,\"interval_unit\":\"yearly\",\"interval\":1,\"count\":5,\"editable_count\":true}]}" response = http.request(request) puts response.read_body delete: operationId: LinksDeleteLink summary: Eliminar un link description: Eliminar un enlace de pago. Esta acción no se puede deshacer. parameters: - name: id in: path description: The link ID required: true schema: type: string example: LKnJZX0DMv2Mzd4Qp6 responses: '202': description: Enlace eliminado exitosamente '401': description: No autorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '404': description: Recurso no encontrado content: application/json: schema: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found tags: - Links x-codeSamples: - lang: Shell + Curl source: |- curl --request DELETE \ --url https://api.debi.pro/v1/links/%7Bid%7D \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'DELETE', url: 'https://api.debi.pro/v1/links/%7Bid%7D', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/links/%7Bid%7D'); $request->setMethod(HTTP_METH_DELETE); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: |- import requests url = "https://api.debi.pro/v1/links/%7Bid%7D" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("DELETE", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.delete("https://api.debi.pro/v1/links/%7Bid%7D") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/links/%7Bid%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/links/{id}/actions/sendToCustomers: post: operationId: LinksSendToCustomers summary: Enviar enlace a clientes description: >- Enviar notificaciones del enlace de pago a clientes específicos por correo electrónico. parameters: - name: id in: path description: The link ID required: true schema: type: string example: LKnJZX0DMv2Mzd4Qp6 requestBody: required: true content: application/json: schema: type: object properties: customers: description: Array de IDs de clientes a los que enviar el enlace type: array items: type: string example: - CSgaZlLaPMZO - CSljikas98 - CSabcd1234 minItems: 1 required: - customers example: customers: - CSgaZlLaPMZO - CSljikas98 responses: '200': description: Enlace enviado exitosamente content: application/json: schema: type: object properties: message: description: Mensaje de éxito con el conteo de correos enviados type: string example: Se enviarán 2 mails '401': description: No autorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '404': description: Enlace o cliente no encontrado content: application/json: schema: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found '422': description: Error de validación content: application/json: schema: description: Error de Validación type: object properties: message: type: string errors: type: array items: type: string example: errors: email: - El email es inválido. message: The given data was invalid. title: Error de Validación tags: - Links x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/links/%7Bid%7D/actions/sendToCustomers \ --header 'Authorization: Bearer sk_live_...' \ --header 'content-type: application/json' \ --data '{"customers":["CSgaZlLaPMZO","CSljikas98","CSabcd1234"]}' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/links/%7Bid%7D/actions/sendToCustomers', headers: { 'content-type': 'application/json', Authorization: 'Bearer sk_live_...' }, body: {customers: ['CSgaZlLaPMZO', 'CSljikas98', 'CSabcd1234']}, json: true }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/links/%7Bid%7D/actions/sendToCustomers'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'content-type' => 'application/json', 'Authorization' => 'Bearer sk_live_...' ]); $request->setBody('{"customers":["CSgaZlLaPMZO","CSljikas98","CSabcd1234"]}'); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/links/%7Bid%7D/actions/sendToCustomers" payload = {"customers": ["CSgaZlLaPMZO", "CSljikas98", "CSabcd1234"]} headers = { "content-type": "application/json", "Authorization": "Bearer sk_live_..." } response = requests.request("POST", url, json=payload, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/links/%7Bid%7D/actions/sendToCustomers") .header("content-type", "application/json") .header("Authorization", "Bearer sk_live_...") .body("{\"customers\":[\"CSgaZlLaPMZO\",\"CSljikas98\",\"CSabcd1234\"]}") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/links/%7Bid%7D/actions/sendToCustomers") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'application/json' request["Authorization"] = 'Bearer sk_live_...' request.body = "{\"customers\":[\"CSgaZlLaPMZO\",\"CSljikas98\",\"CSabcd1234\"]}" response = http.request(request) puts response.read_body /v1/mandates: get: operationId: GetMandates summary: Obtener todos las adhesiones description: Por defecto, las adhesiones más nuevas serán los primeras en la lista. parameters: - name: all in: query description: Incluye adhesiones archivadas. required: false schema: type: boolean - name: customer_id in: query description: | [ID del Cliente](#tag/Clientes). schema: type: string example: CS9PL8eeo8aB - name: created_at in: query description: >- Un filtro en la lista, basado en el campo `created_at` del objeto. El valor puede ser un Unix Timestamp, o puede ser un diccionario con varias opciones de consulta diferentes. required: false schema: type: object properties: gt: description: Mínimo valor para filtrar (exclusivo) type: integer gte: description: Mínimo valor para filtrar (inclusivo) type: integer lt: description: Máximo valor para filtrar (exclusivo) type: integer lte: description: Máximo valor para filtrar (inclusivo) type: integer title: range_query_specs explode: true style: deepObject - name: ending_before in: query description: >- Un cursor para utilizar en la paginación. `ending_before` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, comenzando con `obj_ID`, la próxima llamda puede incluir `ending_before=obj_ID` para obtener la página previa. required: false schema: type: string style: form - name: limit in: query description: >- 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. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- Un cursor para utilizar en la paginación. `starting_after` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, terminando con `obj_ID`, la próxima llamda puede incluir `starting_after=obj_ID` para obtener la página siguiente. required: false schema: type: string style: form responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Adhesión description: Este objeto representa una adhesión de su organización. type: object properties: id: description: Identificador único de la Adhesión. type: string example: MAmQ6j9NWxblNv readOnly: true status: description: Estado. type: string enum: - active - revoked uuid: description: Identificador UUID del objeto. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc object: type: string enum: - mandate livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true customer: description: >- Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente payment_method: description: >- Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: >- Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: >- Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: >- Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: >- Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: >- Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: >- Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: >- Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: >- Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: >- Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: >- Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: >- Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: >- Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' links: description: Links de paginación type: object properties: first: type: - 'null' - string example: https://api.debi.pro/v1/customers last: type: - 'null' - string example: https://api.debi.pro/v1/customers next: type: - 'null' - string example: https://api.debi.pro/v1/customers prev: type: - 'null' - string example: https://api.debi.pro/v1/customers title: Metadata de Respuesta meta: description: Metadata de paginación type: object properties: per_page: type: number example: 25 total: type: number example: 2500 path: type: string example: https://api.debi.pro/v1/customers next_cursor: description: Cursor de Paginación. type: - 'null' - string prev_cursor: description: Cursor de Paginación. type: - 'null' - string title: Response Meta required: - data '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Adhesiones x-codeSamples: - lang: Shell + Curl source: |- 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_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/mandates', qs: { 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' }, headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/mandates'); $request->setMethod(HTTP_METH_GET); $request->setQueryData([ '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' ]); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/mandates" querystring = {"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"} headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers, params=querystring) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("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_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("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") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body post: operationId: MandatesPostMandate summary: Crear una adhesión description: Crear una adhesión. requestBody: required: false content: application/json: schema: type: object properties: customer_id: description: | [ID del Cliente](#tag/Clientes). type: string example: CSgaZlLaPMZO. payment_method_id: description: | [ID del Método de Pago](#tag/Metodos-de-Pago). type: string example: PMBja4YZ2GDR. example: customer_id: CS3oDRqz9wzB payment_method_id: PMBja4YZ2GDR responses: '201': description: OK content: application/json: example: 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' '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Adhesiones x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/mandates \ --header 'Authorization: Bearer sk_live_...' \ --header 'content-type: application/json' \ --data '{"customer_id":"CS3oDRqz9wzB","payment_method_id":"PMBja4YZ2GDR"}' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/mandates', headers: { 'content-type': 'application/json', Authorization: 'Bearer sk_live_...' }, body: {customer_id: 'CS3oDRqz9wzB', payment_method_id: 'PMBja4YZ2GDR'}, json: true }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/mandates'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'content-type' => 'application/json', 'Authorization' => 'Bearer sk_live_...' ]); $request->setBody('{"customer_id":"CS3oDRqz9wzB","payment_method_id":"PMBja4YZ2GDR"}'); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/mandates" payload = { "customer_id": "CS3oDRqz9wzB", "payment_method_id": "PMBja4YZ2GDR" } headers = { "content-type": "application/json", "Authorization": "Bearer sk_live_..." } response = requests.request("POST", url, json=payload, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/mandates") .header("content-type", "application/json") .header("Authorization", "Bearer sk_live_...") .body("{\"customer_id\":\"CS3oDRqz9wzB\",\"payment_method_id\":\"PMBja4YZ2GDR\"}") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/mandates") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'application/json' request["Authorization"] = 'Bearer sk_live_...' request.body = "{\"customer_id\":\"CS3oDRqz9wzB\",\"payment_method_id\":\"PMBja4YZ2GDR\"}" response = http.request(request) puts response.read_body x-codegen-request-body-name: body /v1/mandates/{id}: get: operationId: MandatesGetMandate summary: Obtener una adhesión description: Obtener una adhesión. parameters: - name: id in: path description: | [ID de la Adhesión](#tag/Adhesiones). required: true schema: type: string example: MA9aQOWen2kZe6qypB responses: '200': description: OK content: application/json: schema: properties: data: description: Este objeto representa una adhesión de su organización. type: object properties: id: description: Identificador único de la Adhesión. type: string example: MAmQ6j9NWxblNv readOnly: true status: description: Estado. type: string enum: - active - revoked uuid: description: Identificador UUID del objeto. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc object: type: string enum: - mandate livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true customer: description: >- Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente payment_method: description: Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: >- Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: >- Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: >- Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: >- Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: >- Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: >- Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' title: Adhesión '401': description: No autorizado content: application/json: schema: properties: data: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '404': description: Recurso no encontrado content: application/json: schema: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found tags: - Adhesiones x-codeSamples: - lang: Shell + Curl source: |- curl --request GET \ --url https://api.debi.pro/v1/mandates/MA9aQOWen2kZe6qypB \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/mandates/MA9aQOWen2kZe6qypB', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/mandates/MA9aQOWen2kZe6qypB'); $request->setMethod(HTTP_METH_GET); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: |- import requests url = "https://api.debi.pro/v1/mandates/MA9aQOWen2kZe6qypB" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("https://api.debi.pro/v1/mandates/MA9aQOWen2kZe6qypB") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/mandates/MA9aQOWen2kZe6qypB") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/mandates/{id}/actions/revoke: post: operationId: MandatesRevokeMandate summary: Revocar una adhesión description: >- Esta acción revocará la adhesión y también cancelará todos las suscripciones cancelables adjuntas al mismo `customer` y al mismo `payment_method`. parameters: - name: id in: path description: | [ID de la Adhesión](#tag/Adhesiones). required: true schema: type: string example: MA9aQOWen2kZe6qypB responses: '202': description: Adhesión revocada '401': description: No autorizado content: application/json: schema: properties: data: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Adhesiones x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/mandates/MA9aQOWen2kZe6qypB/actions/revoke \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/mandates/MA9aQOWen2kZe6qypB/actions/revoke', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/mandates/MA9aQOWen2kZe6qypB/actions/revoke'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/mandates/MA9aQOWen2kZe6qypB/actions/revoke" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("POST", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/mandates/MA9aQOWen2kZe6qypB/actions/revoke") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/mandates/MA9aQOWen2kZe6qypB/actions/revoke") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/mandates/{id}/actions/restore: post: operationId: MandatesRestoreMandate summary: Restaurar la adhesión description: Esta acción restaurará la adhesión revocada. parameters: - name: id in: path description: | [ID de la Adhesión](#tag/Adhesiones). required: true schema: type: string example: MA9aQOWen2kZe6qypB responses: '202': description: Adhesión restaurada '401': description: No autorizado content: application/json: schema: properties: data: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Adhesiones x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/mandates/MA9aQOWen2kZe6qypB/actions/restore \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/mandates/MA9aQOWen2kZe6qypB/actions/restore', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/mandates/MA9aQOWen2kZe6qypB/actions/restore'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/mandates/MA9aQOWen2kZe6qypB/actions/restore" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("POST", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/mandates/MA9aQOWen2kZe6qypB/actions/restore") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/mandates/MA9aQOWen2kZe6qypB/actions/restore") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/mandates/search: get: operationId: MandatesSearch summary: Buscar adhesiones description: Buscar adhesiones. parameters: - name: q in: query description: > Puede usar [la sintáxis de búsqueda](https://debi.pro/docs/docs/producto/Sistema%20de%20B%C3%BAsquedas/). required: true schema: type: string example: john doe - name: limit in: query description: >- 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. required: false schema: type: integer example: 20 - name: page in: query description: > 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 `next_page` devuelto en una respuesta anterior para solicitar resultados posteriores. required: true schema: type: string example: john doe responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Adhesión description: Este objeto representa una adhesión de su organización. type: object properties: id: description: Identificador único de la Adhesión. type: string example: MAmQ6j9NWxblNv readOnly: true status: description: Estado. type: string enum: - active - revoked uuid: description: Identificador UUID del objeto. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc object: type: string enum: - mandate livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true customer: description: >- Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente payment_method: description: >- Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: >- Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: >- Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: >- Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: >- Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: >- Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: >- Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: >- Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: >- Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: >- Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: >- Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: >- Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: >- Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' links: description: Links de paginación type: object properties: first: type: - 'null' - string example: https://api.debi.pro/v1/customers last: type: - 'null' - string example: https://api.debi.pro/v1/customers next: type: - 'null' - string example: https://api.debi.pro/v1/customers prev: type: - 'null' - string example: https://api.debi.pro/v1/customers title: Metadata de Respuesta meta: description: Metadata de paginación type: object properties: per_page: type: number example: 25 total: type: number example: 2500 path: type: string example: https://api.debi.pro/v1/customers next_cursor: description: Cursor de Paginación. type: - 'null' - string prev_cursor: description: Cursor de Paginación. type: - 'null' - string title: Response Meta required: - data example: 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: prev: https://api.debi.pro/mandates/search?q=john%20doe&page=1 next: https://api.debi.pro/mandates/search?q=john%20doe&page=3 meta: per_page: 25 total: 2500 '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Adhesiones x-codeSamples: - lang: Shell + Curl source: |- 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_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/mandates/search', qs: {q: 'SOME_STRING_VALUE', limit: 'SOME_INTEGER_VALUE', page: 'SOME_STRING_VALUE'}, headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/mandates/search'); $request->setMethod(HTTP_METH_GET); $request->setQueryData([ 'q' => 'SOME_STRING_VALUE', 'limit' => 'SOME_INTEGER_VALUE', 'page' => 'SOME_STRING_VALUE' ]); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/mandates/search" querystring = {"q":"SOME_STRING_VALUE","limit":"SOME_INTEGER_VALUE","page":"SOME_STRING_VALUE"} headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers, params=querystring) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("https://api.debi.pro/v1/mandates/search?q=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&page=SOME_STRING_VALUE") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/mandates/search?q=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&page=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/payment_methods: get: operationId: PaymentMethodsGetPaymentMethods summary: Obtener todos los métodos de pago description: Obtener una lista de métodos de pago. parameters: - name: page in: query description: Cursor value to paginate response. required: false schema: type: number example: 1 - name: limit in: query description: >- 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. required: false schema: type: integer example: 20 responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Método de pago description: Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: >- Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: >- Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: >- Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: >- Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' links: description: Links de paginación type: object properties: first: type: - 'null' - string example: https://api.debi.pro/v1/customers last: type: - 'null' - string example: https://api.debi.pro/v1/customers next: type: - 'null' - string example: https://api.debi.pro/v1/customers prev: type: - 'null' - string example: https://api.debi.pro/v1/customers title: Metadata de Respuesta meta: description: Metadata de paginación type: object properties: per_page: type: number example: 25 total: type: number example: 2500 path: type: string example: https://api.debi.pro/v1/customers next_cursor: description: Cursor de Paginación. type: - 'null' - string prev_cursor: description: Cursor de Paginación. type: - 'null' - string title: Response Meta required: - data example: 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 next: >- https://api.debi.pro/v1/payment_methods?starting_after=PMVdYaYwkqOw meta: path: https://api.debi.pro/v1/payment_methods per_page: 25 total: 34 '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Métodos de Pago x-codeSamples: - lang: Shell + Curl source: |- curl --request GET \ --url 'https://api.debi.pro/v1/payment_methods?page=SOME_NUMBER_VALUE&limit=SOME_INTEGER_VALUE' \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/payment_methods', qs: {page: 'SOME_NUMBER_VALUE', limit: 'SOME_INTEGER_VALUE'}, headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/payment_methods'); $request->setMethod(HTTP_METH_GET); $request->setQueryData([ 'page' => 'SOME_NUMBER_VALUE', 'limit' => 'SOME_INTEGER_VALUE' ]); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/payment_methods" querystring = {"page":"SOME_NUMBER_VALUE","limit":"SOME_INTEGER_VALUE"} headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers, params=querystring) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("https://api.debi.pro/v1/payment_methods?page=SOME_NUMBER_VALUE&limit=SOME_INTEGER_VALUE") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/payment_methods?page=SOME_NUMBER_VALUE&limit=SOME_INTEGER_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body post: operationId: PaymentMethodsCreatePaymentMethod summary: >- Crear un método de pago para validación, clasificación, identificación o futuro uso en pagos. description: > Crear un método de pago, permite tokenizar el método de pago, validar que cumple las reglas de validación, y ser usado en futuros pagos. A su vez nos permite clasificarlo según sus propiedades para tomar decisiones de negocio. Adicionalmente, para el tipo de método de pago `cbu`, agregando el parámetro `identification` con el valor `true`, podemos identificar la cuenta bancaria para determinar su propietario, o enviar un alias y determinar cual es su CBU correspondiente y quién es su propietario. En caso de cuentas empresariales, el objeto creado contendrá un array con los co propietarios correspondientes. Si envías un parámetro `alias` en el payload, no es necesario indicar el número de CBU, y como respuesta obtendremos el CBU correspondiente a ese alias. requestBody: required: false content: application/json: schema: type: object properties: type: description: Uno de `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string enum: - card - sepa_debit - cbu - cvu - transfer card: description: Este objeto representa una tarjeta de su cuenta. type: object properties: number: description: Número de tarjeta de crédito/débito/prepaga. type: string expiration_year: description: Año de vencimiento de la tarjeta de crédito/débito. type: number expiration_month: description: Mes de vencimiento de la tarjeta. type: number security_code: description: >- Código de seguridad de la tarjeta. Es recomendable incluir siempre este valor. type: string title: Tarjeta cbu: description: >- Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: number: description: >- Número de cuenta bancaria llamado `CBU` en Argentina (22 dígitos). Si el parámetro `identification` es `true`, requiere enviar la `secret key` en el header de la solicitud, de lo contrario con la `public key` es suficiente (útil cuando se crean métodos de pago desde el navegador). `Requerido` si no envías un `alias` en el payload. Si envías el `alias` en el POST y el parámetro `identification` es `true`, no es necesario indicar el número de CBU, y como respuesta obtendremos el número de CBU correspondiente a ese `alias`. type: string alias: description: >- Alias de la cuenta bancaria. Si envía el `alias` en el POST y el parámetro `identification` es `true`, devolverá el número de CBU correspondiente. Para activar esta funcionalidad, contacte a Soporte. type: string example: juanperez identification: description: >- Requiere enviar la `secret key` en el header de la solicitud. Identificación extendida de la cuenta bancaria, al enviar en el POST, realizará la identificación, devolviendo en este parámetro los propietarios o co propietarios de la cuenta. También si envías un `alias` en el payload, no es necesario indicar el número de `cbu`, y como respuesta obtendremos el número de `cbu` correspondiente a ese `alias`. Para activar esta funcionalidad, contacte a Soporte. type: boolean title: CBU sepa_debit: description: >- Este objeto representa un método de pago para débito directo a una cuenta IBAN de la región de pagos Europea. type: object properties: iban: description: Código internacional de cuenta bancaria IBAN type: string title: Débito Sepa (Iban) cvu: description: >- Este objeto representa una cuenta CVU (Clave Virtual Uniforme). type: object properties: {} title: CVU transfer: description: >- Este objeto representa un método de pago por transferencia bancaria. type: object properties: sender_name: description: >- Nombre de la persona o entidad que realiza la transferencia. type: string sender_id: description: >- Número de identificación de la persona o entidad que realiza la transferencia. type: string title: Transferencia strict: description: >- 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. type: boolean examples: card-basic: summary: Tarjeta - Básico value: type: card card: number: '4242424242424242' card-complete: summary: Tarjeta - Completo con Vencimiento y Código de Seguridad value: type: card card: number: '4242424242424242' expiration_year: 2035 expiration_month: 12 security_code: '123' cbu-alias: summary: CBU - Usando Alias con Identificación value: type: cbu cbu: alias: juanperez identification: true cbu-number: summary: CBU - Usando Número de Cuenta con Identificación value: type: cbu cbu: number: '2859363672283668188432' identification: true sepa_debit: summary: SEPA Débito - Cuenta IBAN value: type: sepa_debit sepa_debit: iban: ES9121000418450200051332 transfer: summary: Transferencia - Con Información del Remitente value: type: transfer transfer: sender_name: Juan Perez sender_id: '1234567890' cvu: summary: CVU - Básico value: type: cvu responses: '201': description: Método de Pago creado content: application/json: schema: properties: data: description: Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: >- Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: >- Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: >- Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago examples: card: summary: Tarjeta de Crédito value: 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' sepa_debit-enhanced: summary: Método de Pago SEPA Débito para cuentas IBAN value: data: id: PMja4OP0e4WR object: payment_method type: sepa_debit sepa_debit: bank: CAIXABANK country: ES last_four_digits: '1332' providers: available: [] preferred: null created_at: '2024-04-28T17:40:01-03:00' livemode: true metadata: null updated_at: '2024-04-28T17:40:01-03:00' cbu: summary: Cuenta Bancaria CBU value: data: cbu: bank: Banco de la Nación Argentina country: AR fingerprint: jhA2lx68sNppN90k last_four_digits: '0013' providers: available: - cbu-galicia preferred: cbu-galicia created_at: '2022-11-05T20:43:29-03:00' id: PMBKkz3wjEW9 livemode: false metadata: null object: payment_method type: cbu updated_at: '2022-11-05T20:43:29-03:00' cbu-enhanced: summary: Cuenta Bancaria CBU con Identificación Extendida value: data: cbu: bank: Banco de la Nación Argentina country: AR fingerprint: jhA2lx68sNppN90k identification: account_routing: address: '******************0025' scheme: CBU bank_routing: address: BANCO INDUSTRIAL S.A. code: '322' scheme: NAME currency: ARS is_active: true label: BOCHA.ASTRO.NUEZ owners: - display_name: Diaz, Bruno id: '20223385072' id_type: CUIT is_physical_person: true - display_name: Parker, Peter id: '20313380002' id_type: CUIT is_physical_person: true type: CC last_four_digits: '0013' providers: available: - cbu-galicia preferred: cbu-galicia created_at: '2022-11-05T20:43:29-03:00' id: PMBKkz3wjEW9 livemode: false metadata: null object: payment_method type: cbu updated_at: '2022-11-05T20:43:29-03:00' cvu: summary: Cuenta CVU value: data: id: PMr0AkerW4N1 object: payment_method type: cvu cvu: account_number: '0001371211179340101691' last_four_digits: '1691' providers: available: - bind-transfers preferred: bind-transfers fingerprint: R1YRXJAn7SVSH8Jb livemode: false metadata: null customer_id: null created_at: '2025-09-25T16:52:58-03:00' updated_at: '2025-09-25T16:52:58-03:00' transfer: summary: Método de Pago por Transferencia value: data: id: PMeO2koZD7jG object: payment_method type: transfer transfer: sender_id: null sender_name: null providers: available: [] preferred: null livemode: false metadata: null customer_id: null created_at: '2025-09-25T16:54:02-03:00' updated_at: '2025-09-25T16:54:02-03:00' '401': description: No Autorizado content: application/json: schema: properties: data: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '422': description: Errores de validación content: application/json: schema: properties: errors: type: object additionalProperties: true properties: {} message: type: string example: errors: card.number: - El número de la tarjeta es inválido. message: Could not create new payment method. security: - PublishableKeyAuthentication: [] - SecretKeyAuthentication: [] tags: - Métodos de Pago x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/payment_methods \ --header 'Authorization: Bearer sk_live_...' \ --header 'content-type: application/json' \ --data '{"type":"card","card":{"number":"string","expiration_year":0,"expiration_month":0,"security_code":"string"},"cbu":{"number":"string","alias":"juanperez","identification":true},"sepa_debit":{"iban":"string"},"cvu":{},"transfer":{"sender_name":"string","sender_id":"string"},"strict":true}' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/payment_methods', headers: { 'content-type': 'application/json', Authorization: 'Bearer sk_live_...' }, body: { type: 'card', card: { number: 'string', expiration_year: 0, expiration_month: 0, security_code: 'string' }, cbu: {number: 'string', alias: 'juanperez', identification: true}, sepa_debit: {iban: 'string'}, cvu: {}, transfer: {sender_name: 'string', sender_id: 'string'}, strict: true }, json: true }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/payment_methods'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'content-type' => 'application/json', 'Authorization' => 'Bearer sk_live_...' ]); $request->setBody('{"type":"card","card":{"number":"string","expiration_year":0,"expiration_month":0,"security_code":"string"},"cbu":{"number":"string","alias":"juanperez","identification":true},"sepa_debit":{"iban":"string"},"cvu":{},"transfer":{"sender_name":"string","sender_id":"string"},"strict":true}'); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/payment_methods" payload = { "type": "card", "card": { "number": "string", "expiration_year": 0, "expiration_month": 0, "security_code": "string" }, "cbu": { "number": "string", "alias": "juanperez", "identification": True }, "sepa_debit": {"iban": "string"}, "cvu": {}, "transfer": { "sender_name": "string", "sender_id": "string" }, "strict": True } headers = { "content-type": "application/json", "Authorization": "Bearer sk_live_..." } response = requests.request("POST", url, json=payload, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/payment_methods") .header("content-type", "application/json") .header("Authorization", "Bearer sk_live_...") .body("{\"type\":\"card\",\"card\":{\"number\":\"string\",\"expiration_year\":0,\"expiration_month\":0,\"security_code\":\"string\"},\"cbu\":{\"number\":\"string\",\"alias\":\"juanperez\",\"identification\":true},\"sepa_debit\":{\"iban\":\"string\"},\"cvu\":{},\"transfer\":{\"sender_name\":\"string\",\"sender_id\":\"string\"},\"strict\":true}") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/payment_methods") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'application/json' request["Authorization"] = 'Bearer sk_live_...' request.body = "{\"type\":\"card\",\"card\":{\"number\":\"string\",\"expiration_year\":0,\"expiration_month\":0,\"security_code\":\"string\"},\"cbu\":{\"number\":\"string\",\"alias\":\"juanperez\",\"identification\":true},\"sepa_debit\":{\"iban\":\"string\"},\"cvu\":{},\"transfer\":{\"sender_name\":\"string\",\"sender_id\":\"string\"},\"strict\":true}" response = http.request(request) puts response.read_body /v1/payment_methods/{id}: get: operationId: PaymentMethodsGetPaymentMethod summary: Obtener un Método de Pago description: Obtener un Método de Pago. parameters: - name: id in: path description: Payment method ID. required: true schema: type: string example: PMVA0W8y1aQO responses: '200': description: Obtener un método de pago content: application/json: schema: properties: data: description: Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: >- Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: >- Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: >- Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago examples: card-basic: summary: Tarjeta - Básico value: type: card card: number: '4242424242424242' card-complete: summary: Tarjeta - Completo con Vencimiento y Código de Seguridad value: type: card card: number: '4242424242424242' expiration_year: 2035 expiration_month: 12 security_code: '123' cbu-alias: summary: CBU - Usando Alias con Identificación value: type: cbu cbu: alias: juanperez identification: true cbu-number: summary: CBU - Usando Número de Cuenta con Identificación value: type: cbu cbu: number: '2859363672283668188432' identification: true sepa_debit: summary: SEPA Débito - Cuenta IBAN value: type: sepa_debit sepa_debit: iban: ES9121000418450200051332 transfer: summary: Transferencia - Con Información del Remitente value: type: transfer transfer: sender_name: Juan Perez sender_id: '1234567890' cvu: summary: CVU - Básico value: type: cvu '401': description: No autorizado content: application/json: schema: properties: data: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '404': description: Método de pago no encontrado content: application/json: schema: properties: data: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found tags: - Métodos de Pago x-codeSamples: - lang: Shell + Curl source: |- curl --request GET \ --url https://api.debi.pro/v1/payment_methods/PMVA0W8y1aQO \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/payment_methods/PMVA0W8y1aQO', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/payment_methods/PMVA0W8y1aQO'); $request->setMethod(HTTP_METH_GET); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: |- import requests url = "https://api.debi.pro/v1/payment_methods/PMVA0W8y1aQO" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("https://api.debi.pro/v1/payment_methods/PMVA0W8y1aQO") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/payment_methods/PMVA0W8y1aQO") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/payment_methods/search: get: operationId: PaymentMethodsSearch summary: Buscar métodos de pago description: Buscar métodos de pago. parameters: - name: q in: query description: > Puede usar [la sintáxis de búsqueda](https://debi.pro/docs/docs/producto/Sistema%20de%20B%C3%BAsquedas/). required: true schema: type: string example: john doe - name: limit in: query description: >- 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. required: false schema: type: integer example: 20 - name: page in: query description: > 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 `next_page` devuelto en una respuesta anterior para solicitar resultados posteriores. required: true schema: type: string example: john doe responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Método de pago description: Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: >- Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: >- Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: >- Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: >- Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' links: description: Links de paginación type: object properties: first: type: - 'null' - string example: https://api.debi.pro/v1/customers last: type: - 'null' - string example: https://api.debi.pro/v1/customers next: type: - 'null' - string example: https://api.debi.pro/v1/customers prev: type: - 'null' - string example: https://api.debi.pro/v1/customers title: Metadata de Respuesta meta: description: Metadata de paginación type: object properties: per_page: type: number example: 25 total: type: number example: 2500 path: type: string example: https://api.debi.pro/v1/customers next_cursor: description: Cursor de Paginación. type: - 'null' - string prev_cursor: description: Cursor de Paginación. type: - 'null' - string title: Response Meta required: - data example: 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: next: >- https://api.debi.pro/payment_methods/search?q=john%20doe&page=3 prev: >- https://api.debi.pro/payment_methods/search?q=john%20doe&page=1 meta: per_page: 25 total: 2500 '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Métodos de Pago x-codeSamples: - lang: Shell + Curl source: |- 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_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/payment_methods/search', qs: {q: 'SOME_STRING_VALUE', limit: 'SOME_INTEGER_VALUE', page: 'SOME_STRING_VALUE'}, headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/payment_methods/search'); $request->setMethod(HTTP_METH_GET); $request->setQueryData([ 'q' => 'SOME_STRING_VALUE', 'limit' => 'SOME_INTEGER_VALUE', 'page' => 'SOME_STRING_VALUE' ]); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/payment_methods/search" querystring = {"q":"SOME_STRING_VALUE","limit":"SOME_INTEGER_VALUE","page":"SOME_STRING_VALUE"} headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers, params=querystring) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("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_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/payment_methods/search?q=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&page=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/payment_methods/{id}/attach: post: operationId: attachPaymentMethodToCustomer summary: Adjuntar método de pago a cliente description: > Adjuntar un método de pago a un cliente. Esto permite que el método de pago se use para futuros pagos de este cliente. parameters: - name: id in: path description: El ID del método de pago required: true schema: type: string example: PMrLnDA9D6oQ requestBody: required: true content: application/json: schema: type: object properties: customer: description: El ID del cliente al que adjuntar el método de pago type: string example: CSbJrDMEDaW9 required: - customer responses: '204': description: Método de pago adjuntado exitosamente content: {} '404': description: Método de pago o cliente no encontrado content: application/json: schema: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found '422': description: Error de validación content: application/json: schema: description: Error de Validación type: object properties: message: type: string errors: type: array items: type: string example: errors: email: - El email es inválido. message: The given data was invalid. title: Error de Validación tags: - Métodos de Pago x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/payment_methods/%7Bid%7D/attach \ --header 'Authorization: Bearer sk_live_...' \ --header 'content-type: application/json' \ --data '{"customer":"CSbJrDMEDaW9"}' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/payment_methods/%7Bid%7D/attach', headers: { 'content-type': 'application/json', Authorization: 'Bearer sk_live_...' }, body: {customer: 'CSbJrDMEDaW9'}, json: true }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/payment_methods/%7Bid%7D/attach'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'content-type' => 'application/json', 'Authorization' => 'Bearer sk_live_...' ]); $request->setBody('{"customer":"CSbJrDMEDaW9"}'); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/payment_methods/%7Bid%7D/attach" payload = {"customer": "CSbJrDMEDaW9"} headers = { "content-type": "application/json", "Authorization": "Bearer sk_live_..." } response = requests.request("POST", url, json=payload, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/payment_methods/%7Bid%7D/attach") .header("content-type", "application/json") .header("Authorization", "Bearer sk_live_...") .body("{\"customer\":\"CSbJrDMEDaW9\"}") .asString(); - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/payment_methods/%7Bid%7D/attach") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'application/json' request["Authorization"] = 'Bearer sk_live_...' request.body = "{\"customer\":\"CSbJrDMEDaW9\"}" response = http.request(request) puts response.read_body /v1/payment_methods/{id}/detach: post: operationId: detachPaymentMethodFromCustomer summary: Desasociar método de pago de cliente description: > Desasociar un método de pago de un cliente. Esto elimina la asociación entre el método de pago y el cliente. parameters: - name: id in: path description: El ID del método de pago required: true schema: type: string example: PMrLnDA9D6oQ responses: '204': description: Método de pago desasociado exitosamente content: {} '404': description: Método de pago no encontrado content: application/json: schema: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found tags: - Métodos de Pago x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/payment_methods/%7Bid%7D/detach \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/payment_methods/%7Bid%7D/detach', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/payment_methods/%7Bid%7D/detach'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: |- import requests url = "https://api.debi.pro/v1/payment_methods/%7Bid%7D/detach" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("POST", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/payment_methods/%7Bid%7D/detach") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/payment_methods/%7Bid%7D/detach") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/payments: get: operationId: PaymentsGetPayments summary: Obtener pagos description: Obtener pagos en order cronológico, los más nuevos aparecerán primero. parameters: - name: customer_id in: query description: Mostrar solo los métodos de pago de un cliente determinado. required: false schema: type: string example: CS9PL8eeo8aB - name: subscription_id in: query description: Mostrar solo los métodos de pago de una suscripción determinada. required: false schema: type: string example: SBmX1MrZ77Mwq3 - name: created_at in: query description: >- Un filtro en la lista, basado en el campo `created_at` del objeto. El valor puede ser un Unix Timestamp, o puede ser un diccionario con varias opciones de consulta diferentes. required: false schema: type: object properties: gt: description: Mínimo valor para filtrar (exclusivo) type: integer gte: description: Mínimo valor para filtrar (inclusivo) type: integer lt: description: Máximo valor para filtrar (exclusivo) type: integer lte: description: Máximo valor para filtrar (inclusivo) type: integer title: range_query_specs explode: true style: deepObject - name: ending_before in: query description: >- Un cursor para utilizar en la paginación. `ending_before` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, comenzando con `obj_ID`, la próxima llamda puede incluir `ending_before=obj_ID` para obtener la página previa. required: false schema: type: string style: form - name: limit in: query description: >- 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. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- Un cursor para utilizar en la paginación. `starting_after` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, terminando con `obj_ID`, la próxima llamda puede incluir `starting_after=obj_ID` para obtener la página siguiente. required: false schema: type: string style: form responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Payment description: Este objeto representa un pago de su organización. type: object properties: id: description: Identificador único del Pago. type: string example: PYljikas9Fa8 readOnly: true object: type: string enum: - payment amount: description: Monto del pago type: number example: 12.5 amount_refunded: description: Payment amount refunded. type: number example: 0 currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD description: description: Descripción del pago type: string example: Ajuste por deuda pasada status: description: Estado del pago type: string example: rejected enum: - pending_submission - cancelled - submitted - failed - will_retry - approved - rejected - chargeback - refunded - partially_refunded - requires_action - incomplete response_message: description: Respuesta detallada de la institución financiera type: string example: Falta de fondos rejection_code: description: Código de rechazo interno type: - 'null' - string example: null provider_rejection_code: description: Código de rechazo específico del proveedor type: - 'null' - string example: null paid: description: El pago se ha cobrado con éxito. type: boolean example: false readOnly: true retryable: description: Se puede volver a intentar el pago. type: boolean example: true readOnly: true refundable: description: El pago puede ser reembolsado. type: boolean example: false readOnly: true amount_refundable: description: El monto del pago que se puede reembolsar. type: number example: 0 livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' charge_date: description: >- Una fecha futura en la que se debe cobrar el pago. Si no se especifica, el pago se cobrará lo antes posible. type: string example: '2022-08-04' submissions_count: description: >- El número de veces que el pago ha sido enviado a la institución financiera. type: number example: 1 can_auto_retry_until: description: >- La última fecha en que se enviará el pago a la institución financiera. Nulo significa sin límite type: - 'null' - string example: '2022-08-31' auto_retries_max_attempts: description: >- El número máximo de veces que se puede volver a intentar el pago automáticamente. type: - 'null' - number example: null effective_charged_date: description: La fecha en que se cobrará el pago. type: - 'null' - string example: null estimated_accreditation_date: description: >- La fecha estimada en la que la entidad financiera enviará el monto a cobrar a tu cuenta. type: - 'null' - string example: null updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_status: description: La última fecha en que se cambió el estado del pago. type: - 'null' - string example: '2022-08-31' customer: description: >- Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente subscription: description: >- La [Suscripción](#tag/Suscripciones) asociada con el pago si existe. type: - 'null' - string example: SBmX1MrZ77Mwq3 subscription_payment_number: description: >- El número de pago de la Suscripción asociada, si existiera. type: - 'null' - string example: null gateway: description: El [Gateway](#tag/Gateways) asociada con el pago. type: string example: GW1L49J7ARW3 session: description: >- La [Sesión](#tag/Sesiones) asociada con el pago si existe. type: - 'null' - string example: SS167GrPwXyd90qQoK payment_method: description: >- Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: >- Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: >- Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: >- Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: >- Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: >- Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: >- Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: >- Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: >- Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: >- Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: >- Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: >- Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: >- Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago gateway_identifier: description: >- El número personalizado que envía al Gateway. En la mayoría de los casos este valor es nulo. type: - 'null' - string example: null binary_mode: description: > Fuerza el procesamiento instantáneo de pagos, proporcionando un estado inmediato de `approved` o `rejected` dentro de la respuesta de la solicitud. Esta configuración evita respuestas inconclusivas (como pagos con estado `submitted`) usando solo gateways que pueden procesar pagos instantáneamente, garantizando un resultado rápido y concluyente. Es particularmente útil cuando se procesan pagos en un flujo de checkout que requiere una respuesta sincrónica, permitiendo al cliente recibir instantáneamente el resultado de la transacción. También considere que este modo deshabilita los reintentos automáticos para pagos fallidos, pero este comportamiento puede ser gestionado también definiendo la cantidad máxima de veces que se puede volver a intentar el pago automáticamente estableciendo el parámetro `auto_retries_max_attempts`. type: boolean example: true next_action: description: Acciones adicionales requeridas para el pago type: - 'null' - object example: null recovery_link: description: URL para que el cliente recupere/reintente el pago type: string format: uri example: >- https://debi.test/session_recovery/payment?id=PYA8EJ1DkDnY&signature=... logs: description: Registros de procesamiento del pago type: array items: type: object properties: processed_at: type: string format: date-time action: type: string status: type: string response_message: type: string gateway: type: string refunds: description: Reembolsos asociados con este pago. type: array items: title: Devolución description: >- Este objeto representa una devolución de su organización. type: object properties: id: description: Identificador único de la Devolución. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [ID del Pago](#tag/Pagos). type: string example: PYgaZlLaPMZO amount: description: Monto devuelto. type: number example: 12.5 currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Motivo del reembolso type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Estado del reembolso type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} example: [] metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} links: description: Links de paginación type: object properties: first: type: - 'null' - string example: https://api.debi.pro/v1/customers last: type: - 'null' - string example: https://api.debi.pro/v1/customers next: type: - 'null' - string example: https://api.debi.pro/v1/customers prev: type: - 'null' - string example: https://api.debi.pro/v1/customers title: Metadata de Respuesta meta: description: Metadata de paginación type: object properties: per_page: type: number example: 25 total: type: number example: 2500 path: type: string example: https://api.debi.pro/v1/customers next_cursor: description: Cursor de Paginación. type: - 'null' - string prev_cursor: description: Cursor de Paginación. type: - 'null' - string title: Response Meta required: - data '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Pagos x-codeSamples: - lang: Shell + Curl source: |- 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_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/payments', qs: { 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' }, headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/payments'); $request->setMethod(HTTP_METH_GET); $request->setQueryData([ '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' ]); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/payments" querystring = {"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"} headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers, params=querystring) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("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_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("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") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body post: operationId: PaymentsCreatePayment summary: Crear un pago description: Crear un pago. requestBody: required: true content: application/json: schema: type: object properties: amount: description: El monto del pago. type: number description: description: La descripción del pago. type: string customer_id: description: | [ID del Cliente](#tag/Clientes). type: string example: CSgaZlLaPMZO. payment_method_id: description: > El [ID del Método de Pago](#tag/Metodos-de-Pago) para este pago. Si no envías este parámetro, el pago se cobrará usando el método de pago predeterminado para el cliente. Si el cliente no tiene un método de pago predeterminado, el pago permanecerá en estado `incomplete`, hasta que se actualice via sesión, portal de facturación, o API. type: string example: PMBja4YZ2GDR. charge_date: description: >- Una fecha futura o presente en la que se debe cobrar el pago (Debe ser hoy o una fecha futura). Si no se especifica, el pago se cobrará lo antes posible. type: string format: date can_auto_retry_until: description: >- La fecha máxima en la que se puede volver a intentar el pago automáticamente. Si es nulo, se aplicará el valor por defecto para el usuario. type: string format: date auto_retries_max_attempts: description: >- La cantidad máxima de veces que se puede volver a intentar el pago automáticamente. Si es nulo, se aplicará el valor por defecto para el usuario. type: integer gateway_identifier: description: >- Identificador de Gateway para su pago. Este valor se utiliza para identificar el pago en el gateway. Algunas veces los gateways muestran este valor como un descriptor en extractos bancarios. Si no envías este parámetro, el gateway generará un identificador aleatorio. Este valor no se puede actualizar una vez creado el pago. type: string binary_mode: description: > Fuerza el procesamiento instantáneo de pagos, proporcionando un estado inmediato de `approved` o `rejected` dentro de la respuesta de la solicitud. Esta configuración evita respuestas inconclusivas (como pagos con estado `submitted`) usando solo gateways que pueden procesar pagos instantáneamente, garantizando un resultado rápido y concluyente. Es particularmente útil cuando se procesan pagos en un flujo de checkout que requiere una respuesta sincrónica, permitiendo al cliente recibir instantáneamente el resultado de la transacción. También considere que este modo deshabilita los reintentos automáticos para pagos fallidos, pero este comportamiento puede ser gestionado también definiendo la cantidad máxima de veces que se puede volver a intentar el pago automáticamente estableciendo el parámetro `auto_retries_max_attempts`. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} example: amount: 100 description: Unique payment gateway_identifier: '001234' customer_id: CSr7Dg3LkDP2 payment_method_id: PMBja4YZ2GDR required: - amount - description - customer_id responses: '201': description: OK content: application/json: schema: properties: data: description: Este objeto representa un pago de su organización. type: object properties: id: description: Identificador único del Pago. type: string example: PYljikas9Fa8 readOnly: true object: type: string enum: - payment amount: description: Monto del pago type: number example: 12.5 amount_refunded: description: Payment amount refunded. type: number example: 0 currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD description: description: Descripción del pago type: string example: Ajuste por deuda pasada status: description: Estado del pago type: string example: rejected enum: - pending_submission - cancelled - submitted - failed - will_retry - approved - rejected - chargeback - refunded - partially_refunded - requires_action - incomplete response_message: description: Respuesta detallada de la institución financiera type: string example: Falta de fondos rejection_code: description: Código de rechazo interno type: - 'null' - string example: null provider_rejection_code: description: Código de rechazo específico del proveedor type: - 'null' - string example: null paid: description: El pago se ha cobrado con éxito. type: boolean example: false readOnly: true retryable: description: Se puede volver a intentar el pago. type: boolean example: true readOnly: true refundable: description: El pago puede ser reembolsado. type: boolean example: false readOnly: true amount_refundable: description: El monto del pago que se puede reembolsar. type: number example: 0 livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' charge_date: description: >- Una fecha futura en la que se debe cobrar el pago. Si no se especifica, el pago se cobrará lo antes posible. type: string example: '2022-08-04' submissions_count: description: >- El número de veces que el pago ha sido enviado a la institución financiera. type: number example: 1 can_auto_retry_until: description: >- La última fecha en que se enviará el pago a la institución financiera. Nulo significa sin límite type: - 'null' - string example: '2022-08-31' auto_retries_max_attempts: description: >- El número máximo de veces que se puede volver a intentar el pago automáticamente. type: - 'null' - number example: null effective_charged_date: description: La fecha en que se cobrará el pago. type: - 'null' - string example: null estimated_accreditation_date: description: >- La fecha estimada en la que la entidad financiera enviará el monto a cobrar a tu cuenta. type: - 'null' - string example: null updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_status: description: La última fecha en que se cambió el estado del pago. type: - 'null' - string example: '2022-08-31' customer: description: >- Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente subscription: description: >- La [Suscripción](#tag/Suscripciones) asociada con el pago si existe. type: - 'null' - string example: SBmX1MrZ77Mwq3 subscription_payment_number: description: >- El número de pago de la Suscripción asociada, si existiera. type: - 'null' - string example: null gateway: description: El [Gateway](#tag/Gateways) asociada con el pago. type: string example: GW1L49J7ARW3 session: description: >- La [Sesión](#tag/Sesiones) asociada con el pago si existe. type: - 'null' - string example: SS167GrPwXyd90qQoK payment_method: description: Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: >- Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: >- Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: >- Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: >- Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: >- Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: >- Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago gateway_identifier: description: >- El número personalizado que envía al Gateway. En la mayoría de los casos este valor es nulo. type: - 'null' - string example: null binary_mode: description: > Fuerza el procesamiento instantáneo de pagos, proporcionando un estado inmediato de `approved` o `rejected` dentro de la respuesta de la solicitud. Esta configuración evita respuestas inconclusivas (como pagos con estado `submitted`) usando solo gateways que pueden procesar pagos instantáneamente, garantizando un resultado rápido y concluyente. Es particularmente útil cuando se procesan pagos en un flujo de checkout que requiere una respuesta sincrónica, permitiendo al cliente recibir instantáneamente el resultado de la transacción. También considere que este modo deshabilita los reintentos automáticos para pagos fallidos, pero este comportamiento puede ser gestionado también definiendo la cantidad máxima de veces que se puede volver a intentar el pago automáticamente estableciendo el parámetro `auto_retries_max_attempts`. type: boolean example: true next_action: description: Acciones adicionales requeridas para el pago type: - 'null' - object example: null recovery_link: description: URL para que el cliente recupere/reintente el pago type: string format: uri example: >- https://debi.test/session_recovery/payment?id=PYA8EJ1DkDnY&signature=... logs: description: Registros de procesamiento del pago type: array items: type: object properties: processed_at: type: string format: date-time action: type: string status: type: string response_message: type: string gateway: type: string refunds: description: Reembolsos asociados con este pago. type: array items: title: Devolución description: >- Este objeto representa una devolución de su organización. type: object properties: id: description: Identificador único de la Devolución. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [ID del Pago](#tag/Pagos). type: string example: PYgaZlLaPMZO amount: description: Monto devuelto. type: number example: 12.5 currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Motivo del reembolso type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Estado del reembolso type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} example: [] metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} title: Payment '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Pagos x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/payments \ --header 'Authorization: Bearer sk_live_...' \ --header 'content-type: application/json' \ --data '{"amount":100,"description":"Unique payment","gateway_identifier":"001234","customer_id":"CSr7Dg3LkDP2","payment_method_id":"PMBja4YZ2GDR"}' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/payments', headers: { 'content-type': 'application/json', Authorization: 'Bearer sk_live_...' }, body: { amount: 100, description: 'Unique payment', gateway_identifier: '001234', customer_id: 'CSr7Dg3LkDP2', payment_method_id: 'PMBja4YZ2GDR' }, json: true }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/payments'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'content-type' => 'application/json', 'Authorization' => 'Bearer sk_live_...' ]); $request->setBody('{"amount":100,"description":"Unique payment","gateway_identifier":"001234","customer_id":"CSr7Dg3LkDP2","payment_method_id":"PMBja4YZ2GDR"}'); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/payments" payload = { "amount": 100, "description": "Unique payment", "gateway_identifier": "001234", "customer_id": "CSr7Dg3LkDP2", "payment_method_id": "PMBja4YZ2GDR" } headers = { "content-type": "application/json", "Authorization": "Bearer sk_live_..." } response = requests.request("POST", url, json=payload, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/payments") .header("content-type", "application/json") .header("Authorization", "Bearer sk_live_...") .body("{\"amount\":100,\"description\":\"Unique payment\",\"gateway_identifier\":\"001234\",\"customer_id\":\"CSr7Dg3LkDP2\",\"payment_method_id\":\"PMBja4YZ2GDR\"}") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/payments") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'application/json' request["Authorization"] = 'Bearer sk_live_...' request.body = "{\"amount\":100,\"description\":\"Unique payment\",\"gateway_identifier\":\"001234\",\"customer_id\":\"CSr7Dg3LkDP2\",\"payment_method_id\":\"PMBja4YZ2GDR\"}" response = http.request(request) puts response.read_body x-codegen-request-body-name: body /v1/payments/{id}: get: operationId: PaymentsGetPayment summary: Obtener un pago description: Obtener un pago. parameters: - name: id in: path description: | [ID del Pago](#tag/Pagos). required: true schema: type: string example: PYdOz9bgVReV responses: '200': description: Retrieve a payment. content: application/json: schema: properties: data: description: Este objeto representa un pago de su organización. type: object properties: id: description: Identificador único del Pago. type: string example: PYljikas9Fa8 readOnly: true object: type: string enum: - payment amount: description: Monto del pago type: number example: 12.5 amount_refunded: description: Payment amount refunded. type: number example: 0 currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD description: description: Descripción del pago type: string example: Ajuste por deuda pasada status: description: Estado del pago type: string example: rejected enum: - pending_submission - cancelled - submitted - failed - will_retry - approved - rejected - chargeback - refunded - partially_refunded - requires_action - incomplete response_message: description: Respuesta detallada de la institución financiera type: string example: Falta de fondos rejection_code: description: Código de rechazo interno type: - 'null' - string example: null provider_rejection_code: description: Código de rechazo específico del proveedor type: - 'null' - string example: null paid: description: El pago se ha cobrado con éxito. type: boolean example: false readOnly: true retryable: description: Se puede volver a intentar el pago. type: boolean example: true readOnly: true refundable: description: El pago puede ser reembolsado. type: boolean example: false readOnly: true amount_refundable: description: El monto del pago que se puede reembolsar. type: number example: 0 livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' charge_date: description: >- Una fecha futura en la que se debe cobrar el pago. Si no se especifica, el pago se cobrará lo antes posible. type: string example: '2022-08-04' submissions_count: description: >- El número de veces que el pago ha sido enviado a la institución financiera. type: number example: 1 can_auto_retry_until: description: >- La última fecha en que se enviará el pago a la institución financiera. Nulo significa sin límite type: - 'null' - string example: '2022-08-31' auto_retries_max_attempts: description: >- El número máximo de veces que se puede volver a intentar el pago automáticamente. type: - 'null' - number example: null effective_charged_date: description: La fecha en que se cobrará el pago. type: - 'null' - string example: null estimated_accreditation_date: description: >- La fecha estimada en la que la entidad financiera enviará el monto a cobrar a tu cuenta. type: - 'null' - string example: null updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_status: description: La última fecha en que se cambió el estado del pago. type: - 'null' - string example: '2022-08-31' customer: description: >- Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente subscription: description: >- La [Suscripción](#tag/Suscripciones) asociada con el pago si existe. type: - 'null' - string example: SBmX1MrZ77Mwq3 subscription_payment_number: description: >- El número de pago de la Suscripción asociada, si existiera. type: - 'null' - string example: null gateway: description: El [Gateway](#tag/Gateways) asociada con el pago. type: string example: GW1L49J7ARW3 session: description: >- La [Sesión](#tag/Sesiones) asociada con el pago si existe. type: - 'null' - string example: SS167GrPwXyd90qQoK payment_method: description: Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: >- Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: >- Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: >- Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: >- Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: >- Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: >- Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago gateway_identifier: description: >- El número personalizado que envía al Gateway. En la mayoría de los casos este valor es nulo. type: - 'null' - string example: null binary_mode: description: > Fuerza el procesamiento instantáneo de pagos, proporcionando un estado inmediato de `approved` o `rejected` dentro de la respuesta de la solicitud. Esta configuración evita respuestas inconclusivas (como pagos con estado `submitted`) usando solo gateways que pueden procesar pagos instantáneamente, garantizando un resultado rápido y concluyente. Es particularmente útil cuando se procesan pagos en un flujo de checkout que requiere una respuesta sincrónica, permitiendo al cliente recibir instantáneamente el resultado de la transacción. También considere que este modo deshabilita los reintentos automáticos para pagos fallidos, pero este comportamiento puede ser gestionado también definiendo la cantidad máxima de veces que se puede volver a intentar el pago automáticamente estableciendo el parámetro `auto_retries_max_attempts`. type: boolean example: true next_action: description: Acciones adicionales requeridas para el pago type: - 'null' - object example: null recovery_link: description: URL para que el cliente recupere/reintente el pago type: string format: uri example: >- https://debi.test/session_recovery/payment?id=PYA8EJ1DkDnY&signature=... logs: description: Registros de procesamiento del pago type: array items: type: object properties: processed_at: type: string format: date-time action: type: string status: type: string response_message: type: string gateway: type: string refunds: description: Reembolsos asociados con este pago. type: array items: title: Devolución description: >- Este objeto representa una devolución de su organización. type: object properties: id: description: Identificador único de la Devolución. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [ID del Pago](#tag/Pagos). type: string example: PYgaZlLaPMZO amount: description: Monto devuelto. type: number example: 12.5 currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Motivo del reembolso type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Estado del reembolso type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} example: [] metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} title: Payment '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '404': description: Payment not found content: application/json: schema: properties: data: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found tags: - Pagos x-codeSamples: - lang: Shell + Curl source: |- curl --request GET \ --url https://api.debi.pro/v1/payments/PYdOz9bgVReV \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/payments/PYdOz9bgVReV', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/payments/PYdOz9bgVReV'); $request->setMethod(HTTP_METH_GET); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: |- import requests url = "https://api.debi.pro/v1/payments/PYdOz9bgVReV" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("https://api.debi.pro/v1/payments/PYdOz9bgVReV") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/payments/PYdOz9bgVReV") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body put: operationId: PaymentsUpdatePayment summary: Actualizar un pago description: Actualizar un pago. parameters: - name: id in: path description: | [ID del Pago](#tag/Pagos). required: true schema: type: string example: PYdOz9bgVReV requestBody: required: true content: application/json: schema: type: object properties: amount: description: El nuevo monto del pago. type: number auto_retries_max_attempts: description: >- La cantidad máxima de veces que se puede volver a intentar el pago automáticamente. type: integer can_auto_retry_until: description: >- La fecha máxima en la que se puede volver a intentar el pago automáticamente. type: string format: date charge_date: description: Una fecha futura en la que se debe cobrar el pago. type: string format: date description: description: La nueva descripción del pago. type: string payment_method_id: description: > El [ID del Método de Pago](#tag/Metodos-de-Pago) para este pago. type: string example: PMBja4YZ2GDR. metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} example: description: New payment title responses: '200': description: Pago actualizado content: application/json: schema: properties: data: description: Este objeto representa un pago de su organización. type: object properties: id: description: Identificador único del Pago. type: string example: PYljikas9Fa8 readOnly: true object: type: string enum: - payment amount: description: Monto del pago type: number example: 12.5 amount_refunded: description: Payment amount refunded. type: number example: 0 currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD description: description: Descripción del pago type: string example: Ajuste por deuda pasada status: description: Estado del pago type: string example: rejected enum: - pending_submission - cancelled - submitted - failed - will_retry - approved - rejected - chargeback - refunded - partially_refunded - requires_action - incomplete response_message: description: Respuesta detallada de la institución financiera type: string example: Falta de fondos rejection_code: description: Código de rechazo interno type: - 'null' - string example: null provider_rejection_code: description: Código de rechazo específico del proveedor type: - 'null' - string example: null paid: description: El pago se ha cobrado con éxito. type: boolean example: false readOnly: true retryable: description: Se puede volver a intentar el pago. type: boolean example: true readOnly: true refundable: description: El pago puede ser reembolsado. type: boolean example: false readOnly: true amount_refundable: description: El monto del pago que se puede reembolsar. type: number example: 0 livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' charge_date: description: >- Una fecha futura en la que se debe cobrar el pago. Si no se especifica, el pago se cobrará lo antes posible. type: string example: '2022-08-04' submissions_count: description: >- El número de veces que el pago ha sido enviado a la institución financiera. type: number example: 1 can_auto_retry_until: description: >- La última fecha en que se enviará el pago a la institución financiera. Nulo significa sin límite type: - 'null' - string example: '2022-08-31' auto_retries_max_attempts: description: >- El número máximo de veces que se puede volver a intentar el pago automáticamente. type: - 'null' - number example: null effective_charged_date: description: La fecha en que se cobrará el pago. type: - 'null' - string example: null estimated_accreditation_date: description: >- La fecha estimada en la que la entidad financiera enviará el monto a cobrar a tu cuenta. type: - 'null' - string example: null updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_status: description: La última fecha en que se cambió el estado del pago. type: - 'null' - string example: '2022-08-31' customer: description: >- Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente subscription: description: >- La [Suscripción](#tag/Suscripciones) asociada con el pago si existe. type: - 'null' - string example: SBmX1MrZ77Mwq3 subscription_payment_number: description: >- El número de pago de la Suscripción asociada, si existiera. type: - 'null' - string example: null gateway: description: El [Gateway](#tag/Gateways) asociada con el pago. type: string example: GW1L49J7ARW3 session: description: >- La [Sesión](#tag/Sesiones) asociada con el pago si existe. type: - 'null' - string example: SS167GrPwXyd90qQoK payment_method: description: Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: >- Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: >- Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: >- Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: >- Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: >- Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: >- Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago gateway_identifier: description: >- El número personalizado que envía al Gateway. En la mayoría de los casos este valor es nulo. type: - 'null' - string example: null binary_mode: description: > Fuerza el procesamiento instantáneo de pagos, proporcionando un estado inmediato de `approved` o `rejected` dentro de la respuesta de la solicitud. Esta configuración evita respuestas inconclusivas (como pagos con estado `submitted`) usando solo gateways que pueden procesar pagos instantáneamente, garantizando un resultado rápido y concluyente. Es particularmente útil cuando se procesan pagos en un flujo de checkout que requiere una respuesta sincrónica, permitiendo al cliente recibir instantáneamente el resultado de la transacción. También considere que este modo deshabilita los reintentos automáticos para pagos fallidos, pero este comportamiento puede ser gestionado también definiendo la cantidad máxima de veces que se puede volver a intentar el pago automáticamente estableciendo el parámetro `auto_retries_max_attempts`. type: boolean example: true next_action: description: Acciones adicionales requeridas para el pago type: - 'null' - object example: null recovery_link: description: URL para que el cliente recupere/reintente el pago type: string format: uri example: >- https://debi.test/session_recovery/payment?id=PYA8EJ1DkDnY&signature=... logs: description: Registros de procesamiento del pago type: array items: type: object properties: processed_at: type: string format: date-time action: type: string status: type: string response_message: type: string gateway: type: string refunds: description: Reembolsos asociados con este pago. type: array items: title: Devolución description: >- Este objeto representa una devolución de su organización. type: object properties: id: description: Identificador único de la Devolución. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [ID del Pago](#tag/Pagos). type: string example: PYgaZlLaPMZO amount: description: Monto devuelto. type: number example: 12.5 currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Motivo del reembolso type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Estado del reembolso type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} example: [] metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} title: Payment '401': description: No autorizado content: application/json: schema: properties: data: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Pagos x-codeSamples: - lang: Shell + Curl source: |- curl --request PUT \ --url https://api.debi.pro/v1/payments/PYdOz9bgVReV \ --header 'Authorization: Bearer sk_live_...' \ --header 'content-type: application/json' \ --data '{"description":"New payment title"}' - lang: Node + Request source: | const request = require('request'); const options = { method: 'PUT', url: 'https://api.debi.pro/v1/payments/PYdOz9bgVReV', headers: { 'content-type': 'application/json', Authorization: 'Bearer sk_live_...' }, body: {description: 'New payment title'}, json: true }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/payments/PYdOz9bgVReV'); $request->setMethod(HTTP_METH_PUT); $request->setHeaders([ 'content-type' => 'application/json', 'Authorization' => 'Bearer sk_live_...' ]); $request->setBody('{"description":"New payment title"}'); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/payments/PYdOz9bgVReV" payload = {"description": "New payment title"} headers = { "content-type": "application/json", "Authorization": "Bearer sk_live_..." } response = requests.request("PUT", url, json=payload, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.put("https://api.debi.pro/v1/payments/PYdOz9bgVReV") .header("content-type", "application/json") .header("Authorization", "Bearer sk_live_...") .body("{\"description\":\"New payment title\"}") .asString(); - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/payments/PYdOz9bgVReV") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'application/json' request["Authorization"] = 'Bearer sk_live_...' request.body = "{\"description\":\"New payment title\"}" response = http.request(request) puts response.read_body x-codegen-request-body-name: body /v1/payments/{id}/actions/cancel: post: operationId: PaymentsCancelPayment summary: Cancelar pago description: Cancelar pago. parameters: - name: id in: path description: | [ID del Pago](#tag/Pagos). required: true schema: type: string example: PYdOz9bgVReV responses: '201': description: Created content: application/json: example: message: Cancelled successfully '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Pagos x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/payments/PYdOz9bgVReV/actions/cancel \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/payments/PYdOz9bgVReV/actions/cancel', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/payments/PYdOz9bgVReV/actions/cancel'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: |- import requests url = "https://api.debi.pro/v1/payments/PYdOz9bgVReV/actions/cancel" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("POST", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/payments/PYdOz9bgVReV/actions/cancel") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/payments/PYdOz9bgVReV/actions/cancel") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/payments/{id}/actions/retry: post: operationId: PaymentsRetryPayment summary: Reintentar un pago description: Reintentar un pago. parameters: - name: id in: path description: | [ID del Pago](#tag/Pagos). required: true schema: type: string example: PYdOz9bgVReV responses: '201': description: Reintentado exitosamente content: application/json: example: message: Retried successfully '401': description: No autorizado content: application/json: schema: properties: data: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Pagos x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/payments/PYdOz9bgVReV/actions/retry \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/payments/PYdOz9bgVReV/actions/retry', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/payments/PYdOz9bgVReV/actions/retry'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: |- import requests url = "https://api.debi.pro/v1/payments/PYdOz9bgVReV/actions/retry" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("POST", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/payments/PYdOz9bgVReV/actions/retry") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/payments/PYdOz9bgVReV/actions/retry") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/payments/{id}/actions/stop_auto_retrying: post: operationId: PaymentsStopAutoRetryingPayment summary: Detener reintentos automáticos description: >- 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. parameters: - name: id in: path description: | [ID del Pago](#tag/Pagos). required: true schema: type: string example: PYdOz9bgVReV responses: '201': description: Updated content: application/json: example: message: Stopped autoretries successfully '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Pagos x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/payments/PYdOz9bgVReV/actions/stop_auto_retrying \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/payments/PYdOz9bgVReV/actions/stop_auto_retrying', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/payments/PYdOz9bgVReV/actions/stop_auto_retrying'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/payments/PYdOz9bgVReV/actions/stop_auto_retrying" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("POST", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/payments/PYdOz9bgVReV/actions/stop_auto_retrying") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/payments/PYdOz9bgVReV/actions/stop_auto_retrying") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/payments/{id}/actions/confirm: post: operationId: confirmPayment summary: ⚠️ BETA - Confirm a payment description: > **⚠️ Este endpoint está en BETA** - Esta funcionalidad está actualmente en pruebas beta. - Puede cambiar sin previo aviso - Usar con precaución en producción - Posibles cambios que rompan compatibilidad - Soporte limitado proporcionado Marcar un pago como confirmado. parameters: - name: id in: path description: The payment ID required: true schema: type: string example: PYA8EJ1DkDnY responses: '200': description: Payment confirmed successfully content: application/json: schema: description: Este objeto representa un pago de su organización. type: object properties: id: description: Identificador único del Pago. type: string example: PYljikas9Fa8 readOnly: true object: type: string enum: - payment amount: description: Monto del pago type: number example: 12.5 amount_refunded: description: Payment amount refunded. type: number example: 0 currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD description: description: Descripción del pago type: string example: Ajuste por deuda pasada status: description: Estado del pago type: string example: rejected enum: - pending_submission - cancelled - submitted - failed - will_retry - approved - rejected - chargeback - refunded - partially_refunded - requires_action - incomplete response_message: description: Respuesta detallada de la institución financiera type: string example: Falta de fondos rejection_code: description: Código de rechazo interno type: - 'null' - string example: null provider_rejection_code: description: Código de rechazo específico del proveedor type: - 'null' - string example: null paid: description: El pago se ha cobrado con éxito. type: boolean example: false readOnly: true retryable: description: Se puede volver a intentar el pago. type: boolean example: true readOnly: true refundable: description: El pago puede ser reembolsado. type: boolean example: false readOnly: true amount_refundable: description: El monto del pago que se puede reembolsar. type: number example: 0 livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' charge_date: description: >- Una fecha futura en la que se debe cobrar el pago. Si no se especifica, el pago se cobrará lo antes posible. type: string example: '2022-08-04' submissions_count: description: >- El número de veces que el pago ha sido enviado a la institución financiera. type: number example: 1 can_auto_retry_until: description: >- La última fecha en que se enviará el pago a la institución financiera. Nulo significa sin límite type: - 'null' - string example: '2022-08-31' auto_retries_max_attempts: description: >- El número máximo de veces que se puede volver a intentar el pago automáticamente. type: - 'null' - number example: null effective_charged_date: description: La fecha en que se cobrará el pago. type: - 'null' - string example: null estimated_accreditation_date: description: >- La fecha estimada en la que la entidad financiera enviará el monto a cobrar a tu cuenta. type: - 'null' - string example: null updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_status: description: La última fecha en que se cambió el estado del pago. type: - 'null' - string example: '2022-08-31' customer: description: Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente subscription: description: >- La [Suscripción](#tag/Suscripciones) asociada con el pago si existe. type: - 'null' - string example: SBmX1MrZ77Mwq3 subscription_payment_number: description: >- El número de pago de la Suscripción asociada, si existiera. type: - 'null' - string example: null gateway: description: El [Gateway](#tag/Gateways) asociada con el pago. type: string example: GW1L49J7ARW3 session: description: La [Sesión](#tag/Sesiones) asociada con el pago si existe. type: - 'null' - string example: SS167GrPwXyd90qQoK payment_method: description: Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: >- Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: >- Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: >- Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago gateway_identifier: description: >- El número personalizado que envía al Gateway. En la mayoría de los casos este valor es nulo. type: - 'null' - string example: null binary_mode: description: > Fuerza el procesamiento instantáneo de pagos, proporcionando un estado inmediato de `approved` o `rejected` dentro de la respuesta de la solicitud. Esta configuración evita respuestas inconclusivas (como pagos con estado `submitted`) usando solo gateways que pueden procesar pagos instantáneamente, garantizando un resultado rápido y concluyente. Es particularmente útil cuando se procesan pagos en un flujo de checkout que requiere una respuesta sincrónica, permitiendo al cliente recibir instantáneamente el resultado de la transacción. También considere que este modo deshabilita los reintentos automáticos para pagos fallidos, pero este comportamiento puede ser gestionado también definiendo la cantidad máxima de veces que se puede volver a intentar el pago automáticamente estableciendo el parámetro `auto_retries_max_attempts`. type: boolean example: true next_action: description: Acciones adicionales requeridas para el pago type: - 'null' - object example: null recovery_link: description: URL para que el cliente recupere/reintente el pago type: string format: uri example: >- https://debi.test/session_recovery/payment?id=PYA8EJ1DkDnY&signature=... logs: description: Registros de procesamiento del pago type: array items: type: object properties: processed_at: type: string format: date-time action: type: string status: type: string response_message: type: string gateway: type: string refunds: description: Reembolsos asociados con este pago. type: array items: title: Devolución description: >- Este objeto representa una devolución de su organización. type: object properties: id: description: Identificador único de la Devolución. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [ID del Pago](#tag/Pagos). type: string example: PYgaZlLaPMZO amount: description: Monto devuelto. type: number example: 12.5 currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Motivo del reembolso type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Estado del reembolso type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} example: [] metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} title: Payment examples: sample: summary: Ejemplo de Pago value: 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: [] '404': description: Payment not found content: application/json: schema: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found '422': description: Validation error content: application/json: schema: description: Error de Validación type: object properties: message: type: string errors: type: array items: type: string example: errors: email: - El email es inválido. message: The given data was invalid. title: Error de Validación tags: - Pagos x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/payments/%7Bid%7D/actions/confirm \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/payments/%7Bid%7D/actions/confirm', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/payments/%7Bid%7D/actions/confirm'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: |- import requests url = "https://api.debi.pro/v1/payments/%7Bid%7D/actions/confirm" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("POST", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/payments/%7Bid%7D/actions/confirm") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/payments/%7Bid%7D/actions/confirm") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/payments/{id}/transaction: get: operationId: getPaymentTransaction summary: ⚠️ BETA - Get payment bank transaction description: > **⚠️ Este endpoint está en BETA** - Esta funcionalidad está actualmente en pruebas beta. - Puede cambiar sin previo aviso - Usar con precaución en producción - Posibles cambios que rompan compatibilidad - Soporte limitado proporcionado Obtiene la transacción bancaria asociada a un pago. Esto muestra los detalles de la transferencia bancaria real. parameters: - name: id in: path description: El ID del pago required: true schema: type: string example: PYA8EJ1DkDnY responses: '200': description: Detalles de la transacción bancaria content: application/json: schema: type: object properties: id: description: ID de transacción type: string object: type: string enum: - bank_transaction amount: description: Monto de la transacción type: number format: float currency: description: Código de moneda type: string status: description: Estado de la transacción type: string created_at: description: Fecha de creación de la transacción type: string format: date-time processed_at: description: Fecha de procesamiento de la transacción type: string format: date-time '404': description: Pago o transacción no encontrada content: application/json: schema: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found tags: - Pagos x-codeSamples: - lang: Shell + Curl source: |- curl --request GET \ --url https://api.debi.pro/v1/payments/%7Bid%7D/transaction \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/payments/%7Bid%7D/transaction', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/payments/%7Bid%7D/transaction'); $request->setMethod(HTTP_METH_GET); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: |- import requests url = "https://api.debi.pro/v1/payments/%7Bid%7D/transaction" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("https://api.debi.pro/v1/payments/%7Bid%7D/transaction") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/payments/%7Bid%7D/transaction") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/payments/{id}/transaction/match_candidates: get: operationId: getPaymentTransactionMatchCandidates summary: ⚠️ BETA - Get transaction match candidates description: > **⚠️ Este endpoint está en BETA** - Esta funcionalidad está actualmente en pruebas beta. - Puede cambiar sin previo aviso - Usar con precaución en producción - Posibles cambios que rompan compatibilidad - Soporte limitado proporcionado Obtiene transacciones bancarias potenciales que podrían coincidir con este pago para conciliación manual. parameters: - name: id in: path description: El ID del pago required: true schema: type: string example: PYA8EJ1DkDnY responses: '200': description: Lista de transacciones potencialmente coincidentes content: application/json: schema: type: object properties: object: type: string enum: - list data: type: array items: type: object properties: id: description: ID de transacción remota type: string amount: description: Monto de la transacción type: number format: float currency: description: Código de moneda type: string date: description: Fecha de la transacción type: string format: date description: description: Descripción de la transacción type: string confidence_score: description: Puntaje de confianza de coincidencia type: number format: float maximum: 1 minimum: 0 '404': description: Pago no encontrado content: application/json: schema: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found tags: - Pagos x-codeSamples: - lang: Shell + Curl source: |- curl --request GET \ --url https://api.debi.pro/v1/payments/%7Bid%7D/transaction/match_candidates \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/payments/%7Bid%7D/transaction/match_candidates', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/payments/%7Bid%7D/transaction/match_candidates'); $request->setMethod(HTTP_METH_GET); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/payments/%7Bid%7D/transaction/match_candidates" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("https://api.debi.pro/v1/payments/%7Bid%7D/transaction/match_candidates") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/payments/%7Bid%7D/transaction/match_candidates") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/payments/{id}/transaction/match: post: operationId: matchPaymentTransaction summary: ⚠️ BETA - Match payment with bank transaction description: > **⚠️ Este endpoint está en BETA** - Esta funcionalidad está actualmente en pruebas beta. - Puede cambiar sin previo aviso - Usar con precaución en producción - Posibles cambios que rompan compatibilidad - Soporte limitado proporcionado Coincide manualmente un pago con una transacción bancaria específica para propósitos de conciliación. parameters: - name: id in: path description: El ID del pago required: true schema: type: string example: PYA8EJ1DkDnY requestBody: required: true content: application/json: schema: type: object properties: remote_transaction_id: description: >- El ID de la transacción bancaria remota con la que hacer coincidir type: string example: RT123456789 notes: description: Notas opcionales sobre la coincidencia type: string example: Manual match confirmed by admin required: - remote_transaction_id responses: '200': description: Transacción coincidida exitosamente content: application/json: schema: type: object properties: message: type: string example: Transaction matched successfully bank_transaction: type: object properties: id: type: string remote_transaction_id: type: string matched_at: type: string format: date-time '404': description: Pago o transacción no encontrada content: application/json: schema: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found '422': description: Error de validación content: application/json: schema: description: Error de Validación type: object properties: message: type: string errors: type: array items: type: string example: errors: email: - El email es inválido. message: The given data was invalid. title: Error de Validación tags: - Pagos x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/payments/%7Bid%7D/transaction/match \ --header 'Authorization: Bearer sk_live_...' \ --header 'content-type: application/json' \ --data '{"remote_transaction_id":"RT123456789","notes":"Manual match confirmed by admin"}' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/payments/%7Bid%7D/transaction/match', headers: { 'content-type': 'application/json', Authorization: 'Bearer sk_live_...' }, body: {remote_transaction_id: 'RT123456789', notes: 'Manual match confirmed by admin'}, json: true }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/payments/%7Bid%7D/transaction/match'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'content-type' => 'application/json', 'Authorization' => 'Bearer sk_live_...' ]); $request->setBody('{"remote_transaction_id":"RT123456789","notes":"Manual match confirmed by admin"}'); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/payments/%7Bid%7D/transaction/match" payload = { "remote_transaction_id": "RT123456789", "notes": "Manual match confirmed by admin" } headers = { "content-type": "application/json", "Authorization": "Bearer sk_live_..." } response = requests.request("POST", url, json=payload, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/payments/%7Bid%7D/transaction/match") .header("content-type", "application/json") .header("Authorization", "Bearer sk_live_...") .body("{\"remote_transaction_id\":\"RT123456789\",\"notes\":\"Manual match confirmed by admin\"}") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/payments/%7Bid%7D/transaction/match") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'application/json' request["Authorization"] = 'Bearer sk_live_...' request.body = "{\"remote_transaction_id\":\"RT123456789\",\"notes\":\"Manual match confirmed by admin\"}" response = http.request(request) puts response.read_body /v1/payments/search: get: operationId: PaymentsSearch summary: Buscar pagos description: Buscar pagos. parameters: - name: q in: query description: > Puede usar [la sintáxis de búsqueda](https://debi.pro/docs/docs/producto/Sistema%20de%20B%C3%BAsquedas/). required: true schema: type: string example: john doe - name: limit in: query description: >- 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. required: false schema: type: integer example: 20 - name: page in: query description: > 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 `next_page` devuelto en una respuesta anterior para solicitar resultados posteriores. required: true schema: type: string example: john doe responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Payment description: Este objeto representa un pago de su organización. type: object properties: id: description: Identificador único del Pago. type: string example: PYljikas9Fa8 readOnly: true object: type: string enum: - payment amount: description: Monto del pago type: number example: 12.5 amount_refunded: description: Payment amount refunded. type: number example: 0 currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD description: description: Descripción del pago type: string example: Ajuste por deuda pasada status: description: Estado del pago type: string example: rejected enum: - pending_submission - cancelled - submitted - failed - will_retry - approved - rejected - chargeback - refunded - partially_refunded - requires_action - incomplete response_message: description: Respuesta detallada de la institución financiera type: string example: Falta de fondos rejection_code: description: Código de rechazo interno type: - 'null' - string example: null provider_rejection_code: description: Código de rechazo específico del proveedor type: - 'null' - string example: null paid: description: El pago se ha cobrado con éxito. type: boolean example: false readOnly: true retryable: description: Se puede volver a intentar el pago. type: boolean example: true readOnly: true refundable: description: El pago puede ser reembolsado. type: boolean example: false readOnly: true amount_refundable: description: El monto del pago que se puede reembolsar. type: number example: 0 livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' charge_date: description: >- Una fecha futura en la que se debe cobrar el pago. Si no se especifica, el pago se cobrará lo antes posible. type: string example: '2022-08-04' submissions_count: description: >- El número de veces que el pago ha sido enviado a la institución financiera. type: number example: 1 can_auto_retry_until: description: >- La última fecha en que se enviará el pago a la institución financiera. Nulo significa sin límite type: - 'null' - string example: '2022-08-31' auto_retries_max_attempts: description: >- El número máximo de veces que se puede volver a intentar el pago automáticamente. type: - 'null' - number example: null effective_charged_date: description: La fecha en que se cobrará el pago. type: - 'null' - string example: null estimated_accreditation_date: description: >- La fecha estimada en la que la entidad financiera enviará el monto a cobrar a tu cuenta. type: - 'null' - string example: null updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_status: description: La última fecha en que se cambió el estado del pago. type: - 'null' - string example: '2022-08-31' customer: description: >- Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente subscription: description: >- La [Suscripción](#tag/Suscripciones) asociada con el pago si existe. type: - 'null' - string example: SBmX1MrZ77Mwq3 subscription_payment_number: description: >- El número de pago de la Suscripción asociada, si existiera. type: - 'null' - string example: null gateway: description: El [Gateway](#tag/Gateways) asociada con el pago. type: string example: GW1L49J7ARW3 session: description: >- La [Sesión](#tag/Sesiones) asociada con el pago si existe. type: - 'null' - string example: SS167GrPwXyd90qQoK payment_method: description: >- Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: >- Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: >- Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: >- Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: >- Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: >- Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: >- Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: >- Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: >- Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: >- Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: >- Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: >- Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: >- Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago gateway_identifier: description: >- El número personalizado que envía al Gateway. En la mayoría de los casos este valor es nulo. type: - 'null' - string example: null binary_mode: description: > Fuerza el procesamiento instantáneo de pagos, proporcionando un estado inmediato de `approved` o `rejected` dentro de la respuesta de la solicitud. Esta configuración evita respuestas inconclusivas (como pagos con estado `submitted`) usando solo gateways que pueden procesar pagos instantáneamente, garantizando un resultado rápido y concluyente. Es particularmente útil cuando se procesan pagos en un flujo de checkout que requiere una respuesta sincrónica, permitiendo al cliente recibir instantáneamente el resultado de la transacción. También considere que este modo deshabilita los reintentos automáticos para pagos fallidos, pero este comportamiento puede ser gestionado también definiendo la cantidad máxima de veces que se puede volver a intentar el pago automáticamente estableciendo el parámetro `auto_retries_max_attempts`. type: boolean example: true next_action: description: Acciones adicionales requeridas para el pago type: - 'null' - object example: null recovery_link: description: URL para que el cliente recupere/reintente el pago type: string format: uri example: >- https://debi.test/session_recovery/payment?id=PYA8EJ1DkDnY&signature=... logs: description: Registros de procesamiento del pago type: array items: type: object properties: processed_at: type: string format: date-time action: type: string status: type: string response_message: type: string gateway: type: string refunds: description: Reembolsos asociados con este pago. type: array items: title: Devolución description: >- Este objeto representa una devolución de su organización. type: object properties: id: description: Identificador único de la Devolución. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [ID del Pago](#tag/Pagos). type: string example: PYgaZlLaPMZO amount: description: Monto devuelto. type: number example: 12.5 currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Motivo del reembolso type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Estado del reembolso type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} example: [] metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} links: description: Links de paginación type: object properties: first: type: - 'null' - string example: https://api.debi.pro/v1/customers last: type: - 'null' - string example: https://api.debi.pro/v1/customers next: type: - 'null' - string example: https://api.debi.pro/v1/customers prev: type: - 'null' - string example: https://api.debi.pro/v1/customers title: Metadata de Respuesta meta: description: Metadata de paginación type: object properties: per_page: type: number example: 25 total: type: number example: 2500 path: type: string example: https://api.debi.pro/v1/customers next_cursor: description: Cursor de Paginación. type: - 'null' - string prev_cursor: description: Cursor de Paginación. type: - 'null' - string title: Response Meta required: - data example: data: - 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: [] links: prev: https://api.debi.pro/payments/search?q=john%20doe&page=1 next: https://api.debi.pro/payments/search?q=john%20doe&page=3 meta: per_page: 25 total: 2500 '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Pagos x-codeSamples: - lang: Shell + Curl source: |- curl --request GET \ --url 'https://api.debi.pro/v1/payments/search?q=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&page=SOME_STRING_VALUE' \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/payments/search', qs: {q: 'SOME_STRING_VALUE', limit: 'SOME_INTEGER_VALUE', page: 'SOME_STRING_VALUE'}, headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/payments/search'); $request->setMethod(HTTP_METH_GET); $request->setQueryData([ 'q' => 'SOME_STRING_VALUE', 'limit' => 'SOME_INTEGER_VALUE', 'page' => 'SOME_STRING_VALUE' ]); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/payments/search" querystring = {"q":"SOME_STRING_VALUE","limit":"SOME_INTEGER_VALUE","page":"SOME_STRING_VALUE"} headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers, params=querystring) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("https://api.debi.pro/v1/payments/search?q=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&page=SOME_STRING_VALUE") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/payments/search?q=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&page=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/refunds: get: operationId: RefundsGetRefunds summary: Mostrar todas las devoluciones description: Esta lista muestras las devoluciones ordenadas por fecha de creación. parameters: - name: created_at in: query description: >- Un filtro en la lista, basado en el campo `created_at` del objeto. El valor puede ser un Unix Timestamp, o puede ser un diccionario con varias opciones de consulta diferentes. required: false schema: type: object properties: gt: description: Mínimo valor para filtrar (exclusivo) type: integer gte: description: Mínimo valor para filtrar (inclusivo) type: integer lt: description: Máximo valor para filtrar (exclusivo) type: integer lte: description: Máximo valor para filtrar (inclusivo) type: integer title: range_query_specs explode: true style: deepObject - name: ending_before in: query description: >- Un cursor para utilizar en la paginación. `ending_before` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, comenzando con `obj_ID`, la próxima llamda puede incluir `ending_before=obj_ID` para obtener la página previa. required: false schema: type: string style: form - name: limit in: query description: >- 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. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- Un cursor para utilizar en la paginación. `starting_after` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, terminando con `obj_ID`, la próxima llamda puede incluir `starting_after=obj_ID` para obtener la página siguiente. required: false schema: type: string style: form responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Devolución description: >- Este objeto representa una devolución de su organización. type: object properties: id: description: Identificador único de la Devolución. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [ID del Pago](#tag/Pagos). type: string example: PYgaZlLaPMZO amount: description: Monto devuelto. type: number example: 12.5 currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Motivo del reembolso type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Estado del reembolso type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} links: description: Links de paginación type: object properties: first: type: - 'null' - string example: https://api.debi.pro/v1/customers last: type: - 'null' - string example: https://api.debi.pro/v1/customers next: type: - 'null' - string example: https://api.debi.pro/v1/customers prev: type: - 'null' - string example: https://api.debi.pro/v1/customers title: Metadata de Respuesta meta: description: Metadata de paginación type: object properties: per_page: type: number example: 25 total: type: number example: 2500 path: type: string example: https://api.debi.pro/v1/customers next_cursor: description: Cursor de Paginación. type: - 'null' - string prev_cursor: description: Cursor de Paginación. type: - 'null' - string title: Response Meta required: - data '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Devoluciones x-codeSamples: - lang: Shell + Curl source: |- curl --request GET \ --url 'https://api.debi.pro/v1/refunds?created_at=SOME_OBJECT_VALUE&ending_before=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE' \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/refunds', qs: { created_at: 'SOME_OBJECT_VALUE', ending_before: 'SOME_STRING_VALUE', limit: 'SOME_INTEGER_VALUE', starting_after: 'SOME_STRING_VALUE' }, headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/refunds'); $request->setMethod(HTTP_METH_GET); $request->setQueryData([ 'created_at' => 'SOME_OBJECT_VALUE', 'ending_before' => 'SOME_STRING_VALUE', 'limit' => 'SOME_INTEGER_VALUE', 'starting_after' => 'SOME_STRING_VALUE' ]); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/refunds" querystring = {"created_at":"SOME_OBJECT_VALUE","ending_before":"SOME_STRING_VALUE","limit":"SOME_INTEGER_VALUE","starting_after":"SOME_STRING_VALUE"} headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers, params=querystring) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("https://api.debi.pro/v1/refunds?created_at=SOME_OBJECT_VALUE&ending_before=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/refunds?created_at=SOME_OBJECT_VALUE&ending_before=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body post: operationId: RefundsCreateRefund summary: Crear una devolución description: Crear una devolución. requestBody: content: application/json: schema: type: object properties: payment_id: description: | [ID del Pago](#tag/Pagos). type: string example: PYgaZlLaPMZO. amount: description: >- Monto a devolver. Si es nulo se devolverá la totalidad del pago. type: number example: 12.5 reason: description: > Motivo del reembolso. Uno de: `duplicate`, `error`, or `requested_by_customer`. type: string example: requested_by_customer metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} required: - payment_id - reason responses: '201': description: Devolución creada. content: application/json: schema: properties: data: description: Este objeto representa una devolución de su organización. type: object properties: id: description: Identificador único de la Devolución. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [ID del Pago](#tag/Pagos). type: string example: PYgaZlLaPMZO amount: description: Monto devuelto. type: number example: 12.5 currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Motivo del reembolso type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Estado del reembolso type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} title: Devolución '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '422': description: Unprocessable Entity content: application/json: example: errors: payment_id: - payment_id is required. message: The given data was invalid. tags: - Devoluciones x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/refunds \ --header 'Authorization: Bearer sk_live_...' \ --header 'content-type: application/json' \ --data '{"payment_id":"PYgaZlLaPMZO.","amount":12.5,"reason":"requested_by_customer","metadata":{"some":"metadata"}}' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/refunds', headers: { 'content-type': 'application/json', Authorization: 'Bearer sk_live_...' }, body: { payment_id: 'PYgaZlLaPMZO.', amount: 12.5, reason: 'requested_by_customer', metadata: {some: 'metadata'} }, json: true }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/refunds'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'content-type' => 'application/json', 'Authorization' => 'Bearer sk_live_...' ]); $request->setBody('{"payment_id":"PYgaZlLaPMZO.","amount":12.5,"reason":"requested_by_customer","metadata":{"some":"metadata"}}'); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/refunds" payload = { "payment_id": "PYgaZlLaPMZO.", "amount": 12.5, "reason": "requested_by_customer", "metadata": {"some": "metadata"} } headers = { "content-type": "application/json", "Authorization": "Bearer sk_live_..." } response = requests.request("POST", url, json=payload, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/refunds") .header("content-type", "application/json") .header("Authorization", "Bearer sk_live_...") .body("{\"payment_id\":\"PYgaZlLaPMZO.\",\"amount\":12.5,\"reason\":\"requested_by_customer\",\"metadata\":{\"some\":\"metadata\"}}") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/refunds") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'application/json' request["Authorization"] = 'Bearer sk_live_...' request.body = "{\"payment_id\":\"PYgaZlLaPMZO.\",\"amount\":12.5,\"reason\":\"requested_by_customer\",\"metadata\":{\"some\":\"metadata\"}}" response = http.request(request) puts response.read_body x-codegen-request-body-name: body /v1/refunds/{id}: get: operationId: RefundsGetRefund summary: Retorna una devolución description: Retorna una devolución. parameters: - name: id in: path description: | [ID de la devolución](#tag/Devoluciones). required: true schema: type: string example: RFgaZlLaPMZO responses: '200': description: OK content: application/json: schema: properties: data: description: Este objeto representa una devolución de su organización. type: object properties: id: description: Identificador único de la Devolución. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [ID del Pago](#tag/Pagos). type: string example: PYgaZlLaPMZO amount: description: Monto devuelto. type: number example: 12.5 currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Motivo del reembolso type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Estado del reembolso type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} title: Devolución '401': description: No Autorizado content: application/json: schema: properties: data: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '404': description: Objeto no encontrado content: application/json: schema: properties: data: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found tags: - Devoluciones x-codeSamples: - lang: Shell + Curl source: |- curl --request GET \ --url https://api.debi.pro/v1/refunds/RFgaZlLaPMZO \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/refunds/RFgaZlLaPMZO', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/refunds/RFgaZlLaPMZO'); $request->setMethod(HTTP_METH_GET); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: |- import requests url = "https://api.debi.pro/v1/refunds/RFgaZlLaPMZO" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("https://api.debi.pro/v1/refunds/RFgaZlLaPMZO") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/refunds/RFgaZlLaPMZO") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/sessions: post: operationId: SessionsCreateSession summary: Crear una sesión description: Crear una sesión requestBody: required: false content: application/json: schema: type: object properties: kind: description: Uno de `payment`, `subscription` o `mandate`. type: string enum: - payment - subscription - mandate success_url: description: >- La URL al que se redirigirá a su cliente después de completar el pago. type: string amount: description: El monto del pago o suscripción. type: string description: description: La descripción del pago o suscripción. type: string customer_id: description: | [ID de cliente](#tag/Clientes). type: string example: CSgaZlLaPMZO customer_name: description: > Nombre de su cliente. Puede completarlo o pedirle al cliente que complete este campo en el proceso de pago. type: string customer_email: description: > Email de su cliente. Puede completarlo o pedirle al cliente que complete este campo en el proceso de pago. type: string customer_gateway_identifier: description: La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' editable_amount: description: >- Permita que el cliente establezca la cantidad de pagos, útil para donaciones. type: boolean installments: description: >- Solo para pagos, cantidad de pagos en los que se fraccionará el monto. type: integer max_installments: description: >- Solo para pagos, permite que el cliente elija en cuántas cuotas puede fraccionar el pago. type: integer interval_unit: description: >- Solo para suscripciones, la unidad de tiempo entre las fechas de cargo del cliente. Uno de semanal, mensual o anual. type: string enum: - weekly - monthly - yearly interval: description: >- Solo para suscripciones, el número de unidades_intervalo entre las fechas de cargo del cliente. Debe ser mayor que 1. Si la unidad_intervalo es semanal y el intervalo es 2, se cobrará al cliente cada dos semanas. El valor predeterminado es 1. type: integer day_of_month: description: >- Solo para suscripciones, el día del mes, del 1 al 28. Úselo solo si necesita que la suscripción comience en una fecha específica. En la mayoría de los casos este debe ser nulo, por lo que Debi utilizará la fecha del momento en que el usuario completa el checkout. type: integer day_of_week: description: >- Solo para suscripciones, el número del día de la semana, del 0 (domingo) al 6 (sábado). Úselo solo si necesita que la suscripción comience en una fecha específica. En la mayoría de los casos este debe ser nulo, por lo que Debi utilizará la fecha del momento en que el usuario completa el checkout. type: integer payment_gateway_identifier: description: >- El número personalizado que envía al Gateway. En la mayoría de los casos este valor es nulo. type: - 'null' - string example: null binary_mode: description: > Fuerza el procesamiento instantáneo de pagos, proporcionando un estado inmediato de `approved` o `rejected` dentro de la respuesta de la solicitud. Esta configuración evita respuestas inconclusivas (como pagos con estado `submitted`) usando solo gateways que pueden procesar pagos instantáneamente, garantizando un resultado rápido y concluyente. Es particularmente útil cuando se procesan pagos en un flujo de checkout que requiere una respuesta sincrónica, permitiendo al cliente recibir instantáneamente el resultado de la transacción. También considere que este modo deshabilita los reintentos automáticos para pagos fallidos, pero este comportamiento puede ser gestionado también definiendo la cantidad máxima de veces que se puede volver a intentar el pago automáticamente estableciendo el parámetro `auto_retries_max_attempts`. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} extra_fields: description: > Una colección de campos diseñados para almacenarse como [metadatos](#section/Metadata) del objeto que la Sesión está generando, ya sea un [Pago](#tag/Payments), [Suscripción](#tag/Subscriptions) o [Adhesión](#tag/Mandates). 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. type: - object - 'null' example: - 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: description: > Una colección de campos diseñados para almacenarse como [metadatos](#section/Metadata) del [Cliente](#tag/Customers) 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. type: - object - 'null' example: - 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 count: description: > Solo para suscripciones, el número total de pagos que deben ser tomado por esta suscripción. Si no se especifica la suscripción continuará hasta que lo cancele. type: integer editable_count: description: > Solo para suscripciones, permitir que el cliente establezca la duración de las suscripciones, útiles para donaciones. type: number payment_method_types: description: > Array de tipos de métodos de pago permitidos. Si no se especifica, se permitirán todos los métodos de pago disponibles. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Opciones de configuración para tipos específicos de métodos de pago, como no permitir ciertas redes de tarjetas o tipos de financiamiento. type: object example: card: disallow: funding: - prepaid network: - amex properties: card: type: object properties: disallow: type: object properties: funding: description: Funding types to disallow type: array items: type: string enum: - credit - debit - prepaid - unknown example: - prepaid network: description: Card networks to disallow type: array items: type: string enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa example: - amex example: kind: payment success_url: http://example.com/success amount: '200.50' description: Summer school payment_method_types: - card - cbu - cvu payment_method_options: card: disallow: funding: - prepaid network: - amex responses: '201': description: OK content: application/json: schema: properties: data: description: Este objeto representa una Sesión de su organización. type: object properties: id: description: Identificador único de la Sesión. type: string example: SSmQ6j9NWxblNv readOnly: true uuid: description: Identificador UUID del objeto. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc object: type: string enum: - session description: description: Descripción de la sesión type: string example: Ajuste por deuda pasada amount: description: Monto a cobrar. type: number example: 12.5 kind: type: string enum: - mandate - payment - subscription customer_id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true customer_name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro customer_email: description: El email del cliente. type: - 'null' - string example: mail@example.com customer_gateway_identifier: description: La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' editable_amount: description: >- Permita que el cliente establezca la cantidad de pagos, útil para donaciones. type: boolean installments: description: >- Solo para pagos, cantidad de pagos en los que se fraccionará el monto. type: integer max_installments: description: >- Solo para pagos, permite que el cliente elija en cuántas cuotas puede fraccionar el pago. type: integer interval_unit: description: > Sólo para suscripciones. La unidad de tiempo entre las fechas de pago del cliente. Uno de: `weekly`, `monthly` or `yearly`. Ejemplo `monthly`. type: string interval: description: >- Sólo para suscripciones. Número de `interval_unit` entre las fechas de pago del cliente. Debe ser mayor que 1. Si `interval_units` es semanal y el intervalo es 2, luego se le cobrará al cliente cada dos semanas. El valor predeterminado es 1. type: number day_of_month: description: >- Sólo para suscripciones. Día del mes, del 1 al 28. Este campo es requerido si `interval_unit` es `monthly`. El default es 1. type: number day_of_week: description: >- Sólo para suscripciones. Número del día de la semana, de 0 (Domingo) a 6 (Sábado). Este campo es obligatorio si `interval_unit` se establece en `weekly`. type: number count: type: number editable_count: type: boolean name_text: type: string created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' completed_at: description: > Hora en la que la sesión fue completada. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true binary_mode: description: > Fuerza el procesamiento instantáneo de pagos, proporcionando un estado inmediato de `approved` o `rejected` dentro de la respuesta de la solicitud. Esta configuración evita respuestas inconclusivas (como pagos con estado `submitted`) usando solo gateways que pueden procesar pagos instantáneamente, garantizando un resultado rápido y concluyente. Es particularmente útil cuando se procesan pagos en un flujo de checkout que requiere una respuesta sincrónica, permitiendo al cliente recibir instantáneamente el resultado de la transacción. También considere que este modo deshabilita los reintentos automáticos para pagos fallidos, pero este comportamiento puede ser gestionado también definiendo la cantidad máxima de veces que se puede volver a intentar el pago automáticamente estableciendo el parámetro `auto_retries_max_attempts`. type: boolean example: true payment_gateway_identifier: description: >- El número personalizado que envía al Gateway. En la mayoría de los casos este valor es nulo. type: - 'null' - string example: null public_uri: description: >- La URL de la sesión de Checkout. Redirige a tus usuario a esta URL para completar el checkout. type: string readOnly: true success_url: description: >- La URL al que se redirigirá a su cliente después de completar el pago. type: string link_id: description: Link ID. type: string example: LKLj0JV8xzdMoRk549 payment_method_types: description: > Array de tipos de métodos de pago permitidos. Si no se especifica, se permitirán todos los métodos de pago disponibles. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Opciones de configuración para tipos específicos de métodos de pago, como no permitir ciertas redes de tarjetas o tipos de financiamiento. type: object example: card: disallow: funding: - prepaid network: - amex properties: card: type: object properties: disallow: type: object properties: funding: description: Funding types to disallow type: array items: type: string enum: - credit - debit - prepaid - unknown example: - prepaid network: description: Card networks to disallow type: array items: type: string enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa example: - amex supported_payment_methods: description: >- Métodos de pago disponibles basados en la configuración del gateway del usuario type: array items: type: object example: [] readOnly: true title: Sesión '401': description: No autorizado content: application/json: schema: properties: data: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '422': description: Datos inválidos content: application/json: example: errors: email: - El email es inválido. message: The given data was invalid. tags: - Sesiones x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/sessions \ --header 'Authorization: Bearer sk_live_...' \ --header 'content-type: application/json' \ --data '{"kind":"payment","success_url":"http://example.com/success","amount":"200.50","description":"Summer school","payment_method_types":["card","cbu","cvu"],"payment_method_options":{"card":{"disallow":{"funding":["prepaid"],"network":["amex"]}}}}' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/sessions', headers: { 'content-type': 'application/json', Authorization: 'Bearer sk_live_...' }, body: { kind: 'payment', success_url: 'http://example.com/success', amount: '200.50', description: 'Summer school', payment_method_types: ['card', 'cbu', 'cvu'], payment_method_options: {card: {disallow: {funding: ['prepaid'], network: ['amex']}}} }, json: true }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/sessions'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'content-type' => 'application/json', 'Authorization' => 'Bearer sk_live_...' ]); $request->setBody('{"kind":"payment","success_url":"http://example.com/success","amount":"200.50","description":"Summer school","payment_method_types":["card","cbu","cvu"],"payment_method_options":{"card":{"disallow":{"funding":["prepaid"],"network":["amex"]}}}}'); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/sessions" payload = { "kind": "payment", "success_url": "http://example.com/success", "amount": "200.50", "description": "Summer school", "payment_method_types": ["card", "cbu", "cvu"], "payment_method_options": {"card": {"disallow": { "funding": ["prepaid"], "network": ["amex"] }}} } headers = { "content-type": "application/json", "Authorization": "Bearer sk_live_..." } response = requests.request("POST", url, json=payload, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/sessions") .header("content-type", "application/json") .header("Authorization", "Bearer sk_live_...") .body("{\"kind\":\"payment\",\"success_url\":\"http://example.com/success\",\"amount\":\"200.50\",\"description\":\"Summer school\",\"payment_method_types\":[\"card\",\"cbu\",\"cvu\"],\"payment_method_options\":{\"card\":{\"disallow\":{\"funding\":[\"prepaid\"],\"network\":[\"amex\"]}}}}") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/sessions") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'application/json' request["Authorization"] = 'Bearer sk_live_...' request.body = "{\"kind\":\"payment\",\"success_url\":\"http://example.com/success\",\"amount\":\"200.50\",\"description\":\"Summer school\",\"payment_method_types\":[\"card\",\"cbu\",\"cvu\"],\"payment_method_options\":{\"card\":{\"disallow\":{\"funding\":[\"prepaid\"],\"network\":[\"amex\"]}}}}" response = http.request(request) puts response.read_body x-codegen-request-body-name: body /v1/sessions/{id}: get: operationId: SessionsGetSession summary: Obtener una sesión description: Obtener una sesión. parameters: - name: id in: path description: | [ID de la Sesión](#tag/Sesiones). required: true schema: type: string example: SSnO8b9w7B51VE0B5m responses: '201': description: OK content: application/json: schema: properties: data: description: Este objeto representa una Sesión de su organización. type: object properties: id: description: Identificador único de la Sesión. type: string example: SSmQ6j9NWxblNv readOnly: true uuid: description: Identificador UUID del objeto. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc object: type: string enum: - session description: description: Descripción de la sesión type: string example: Ajuste por deuda pasada amount: description: Monto a cobrar. type: number example: 12.5 kind: type: string enum: - mandate - payment - subscription customer_id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true customer_name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro customer_email: description: El email del cliente. type: - 'null' - string example: mail@example.com customer_gateway_identifier: description: La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' editable_amount: description: >- Permita que el cliente establezca la cantidad de pagos, útil para donaciones. type: boolean installments: description: >- Solo para pagos, cantidad de pagos en los que se fraccionará el monto. type: integer max_installments: description: >- Solo para pagos, permite que el cliente elija en cuántas cuotas puede fraccionar el pago. type: integer interval_unit: description: > Sólo para suscripciones. La unidad de tiempo entre las fechas de pago del cliente. Uno de: `weekly`, `monthly` or `yearly`. Ejemplo `monthly`. type: string interval: description: >- Sólo para suscripciones. Número de `interval_unit` entre las fechas de pago del cliente. Debe ser mayor que 1. Si `interval_units` es semanal y el intervalo es 2, luego se le cobrará al cliente cada dos semanas. El valor predeterminado es 1. type: number day_of_month: description: >- Sólo para suscripciones. Día del mes, del 1 al 28. Este campo es requerido si `interval_unit` es `monthly`. El default es 1. type: number day_of_week: description: >- Sólo para suscripciones. Número del día de la semana, de 0 (Domingo) a 6 (Sábado). Este campo es obligatorio si `interval_unit` se establece en `weekly`. type: number count: type: number editable_count: type: boolean name_text: type: string created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' completed_at: description: > Hora en la que la sesión fue completada. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true binary_mode: description: > Fuerza el procesamiento instantáneo de pagos, proporcionando un estado inmediato de `approved` o `rejected` dentro de la respuesta de la solicitud. Esta configuración evita respuestas inconclusivas (como pagos con estado `submitted`) usando solo gateways que pueden procesar pagos instantáneamente, garantizando un resultado rápido y concluyente. Es particularmente útil cuando se procesan pagos en un flujo de checkout que requiere una respuesta sincrónica, permitiendo al cliente recibir instantáneamente el resultado de la transacción. También considere que este modo deshabilita los reintentos automáticos para pagos fallidos, pero este comportamiento puede ser gestionado también definiendo la cantidad máxima de veces que se puede volver a intentar el pago automáticamente estableciendo el parámetro `auto_retries_max_attempts`. type: boolean example: true payment_gateway_identifier: description: >- El número personalizado que envía al Gateway. En la mayoría de los casos este valor es nulo. type: - 'null' - string example: null public_uri: description: >- La URL de la sesión de Checkout. Redirige a tus usuario a esta URL para completar el checkout. type: string readOnly: true success_url: description: >- La URL al que se redirigirá a su cliente después de completar el pago. type: string link_id: description: Link ID. type: string example: LKLj0JV8xzdMoRk549 payment_method_types: description: > Array de tipos de métodos de pago permitidos. Si no se especifica, se permitirán todos los métodos de pago disponibles. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Opciones de configuración para tipos específicos de métodos de pago, como no permitir ciertas redes de tarjetas o tipos de financiamiento. type: object example: card: disallow: funding: - prepaid network: - amex properties: card: type: object properties: disallow: type: object properties: funding: description: Funding types to disallow type: array items: type: string enum: - credit - debit - prepaid - unknown example: - prepaid network: description: Card networks to disallow type: array items: type: string enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa example: - amex supported_payment_methods: description: >- Métodos de pago disponibles basados en la configuración del gateway del usuario type: array items: type: object example: [] readOnly: true title: Sesión '401': description: No autorizado content: application/json: schema: properties: data: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '404': description: Sesión no encontrada content: application/json: example: message: Session not found tags: - Sesiones x-codeSamples: - lang: Shell + Curl source: |- curl --request GET \ --url https://api.debi.pro/v1/sessions/SSnO8b9w7B51VE0B5m \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/sessions/SSnO8b9w7B51VE0B5m', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/sessions/SSnO8b9w7B51VE0B5m'); $request->setMethod(HTTP_METH_GET); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: |- import requests url = "https://api.debi.pro/v1/sessions/SSnO8b9w7B51VE0B5m" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("https://api.debi.pro/v1/sessions/SSnO8b9w7B51VE0B5m") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/sessions/SSnO8b9w7B51VE0B5m") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/subscriptions: get: operationId: SubscriptionsGetSubscriptions summary: Obtener todas las suscripciones description: >- Por defecto, las suscripciones más nuevas serán las primeras en la lista. parameters: - name: created_at in: query description: >- Un filtro en la lista, basado en el campo `created_at` del objeto. El valor puede ser un Unix Timestamp, o puede ser un diccionario con varias opciones de consulta diferentes. required: false schema: type: object properties: gt: description: Mínimo valor para filtrar (exclusivo) type: integer gte: description: Mínimo valor para filtrar (inclusivo) type: integer lt: description: Máximo valor para filtrar (exclusivo) type: integer lte: description: Máximo valor para filtrar (inclusivo) type: integer title: range_query_specs explode: true style: deepObject - name: ending_before in: query description: >- Un cursor para utilizar en la paginación. `ending_before` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, comenzando con `obj_ID`, la próxima llamda puede incluir `ending_before=obj_ID` para obtener la página previa. required: false schema: type: string style: form - name: limit in: query description: >- 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. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- Un cursor para utilizar en la paginación. `starting_after` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, terminando con `obj_ID`, la próxima llamda puede incluir `starting_after=obj_ID` para obtener la página siguiente. required: false schema: type: string style: form responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Suscripción description: >- Este objeto representa una Suscripción de su organización. type: object properties: id: description: Identificador único de la Suscripción. type: string example: SBmQ6j9NWxblNv readOnly: true object: type: string enum: - subscription amount: description: Monto de la suscripción type: number example: 12.5 description: description: Descripción de la suscripción type: string example: Ajuste por deuda pasada currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD status: description: Estado de la suscripción type: string example: active enum: - active - paused - cancelled - finished - incomplete - incomplete_expired count: description: > El número total de pagos que debe realizar esta suscripción. type: - 'null' - number example: 12 start_date: description: >- Una fecha futura en la que el primer pago de la suscripción debe ser recogido. type: string example: '2022-08-04' interval_unit: description: >- La unidad de tiempo entre las fechas de pago del cliente. type: string example: monthly enum: - weekly - monthly - yearly interval: description: >- Número de `interval_unit` entre las fechas de pago del cliente. Debe ser mayor que 1. Si `interval_units` es semanal y el intervalo es 2, luego se le cobrará al cliente cada dos semanas. El valor predeterminado es 1. type: number example: 1 day_of_month: description: >- Día del mes, del 1 al 28. Este campo es obligatorio si `interval_unit` se establece en mensual. El valor predeterminado es 1. type: number day_of_week: description: >- Número del día de la semana, de 0 (Domingo) a 6 (Sábado). Este campo es obligatorio si `interval_unit` se establece en `weekly`. type: - 'null' - number livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' auto_retries_max_attempts: description: >- La cantidad máxima de veces que se pueden volver a intentar automáticamente los pagos de esta suscripción. type: - 'null' - number example: null first_date: description: >- La fecha en la que debe realizarse el primer pago. Cuando se deja en blanco y se proporciona el mes o el día del mes, se establecerá como fecha del primer pago. Si se crea sin este dato, se cobrará lo antes posible. type: string example: '2022-08-04' upcoming_dates: description: Próximas 5 fechas de pago. type: array items: type: string properties: {} example: - '2022-09-04' - '2022-10-04' - '2022-11-04' - '2022-12-04' - '2023-01-04' customer: description: >- Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente payment_method: description: >- Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: >- Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: >- Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: >- Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: >- Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: >- Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: >- Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: >- Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: >- Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: >- Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: >- Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: >- Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: >- Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} additionalProperties: false required: - id - object - amount - description - currency - status - count - start_date - interval_unit - interval - day_of_month - day_of_week - livemode - created_at - updated_at - first_date - upcoming_dates - customer - payment_method - auto_retries_max_attempts - metadata links: description: Links de paginación type: object properties: first: type: - 'null' - string example: https://api.debi.pro/v1/customers last: type: - 'null' - string example: https://api.debi.pro/v1/customers next: type: - 'null' - string example: https://api.debi.pro/v1/customers prev: type: - 'null' - string example: https://api.debi.pro/v1/customers title: Metadata de Respuesta meta: description: Metadata de paginación type: object properties: per_page: type: number example: 25 total: type: number example: 2500 path: type: string example: https://api.debi.pro/v1/customers next_cursor: description: Cursor de Paginación. type: - 'null' - string prev_cursor: description: Cursor de Paginación. type: - 'null' - string title: Response Meta required: - data '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Suscripciones x-codeSamples: - lang: Shell + Curl source: |- curl --request GET \ --url 'https://api.debi.pro/v1/subscriptions?created_at=SOME_OBJECT_VALUE&ending_before=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE' \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/subscriptions', qs: { created_at: 'SOME_OBJECT_VALUE', ending_before: 'SOME_STRING_VALUE', limit: 'SOME_INTEGER_VALUE', starting_after: 'SOME_STRING_VALUE' }, headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/subscriptions'); $request->setMethod(HTTP_METH_GET); $request->setQueryData([ 'created_at' => 'SOME_OBJECT_VALUE', 'ending_before' => 'SOME_STRING_VALUE', 'limit' => 'SOME_INTEGER_VALUE', 'starting_after' => 'SOME_STRING_VALUE' ]); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/subscriptions" querystring = {"created_at":"SOME_OBJECT_VALUE","ending_before":"SOME_STRING_VALUE","limit":"SOME_INTEGER_VALUE","starting_after":"SOME_STRING_VALUE"} headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers, params=querystring) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("https://api.debi.pro/v1/subscriptions?created_at=SOME_OBJECT_VALUE&ending_before=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/subscriptions?created_at=SOME_OBJECT_VALUE&ending_before=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body post: operationId: SubscriptionsCreateSubscription summary: Crear una suscripción description: Crear una suscripción requestBody: required: false content: application/json: encoding: metadata: explode: true style: deepObject schema: type: object properties: amount: description: El monto de cada pago de la suscripción. type: number description: description: | La descripción de cada pago de la suscripción. type: string maxLength: 255 count: description: > El número total de pagos que debe realizar esta suscripción. Si no se especifíca, la suscripción continuará hasta que la canceles. type: number customer_id: description: | [ID del Cliente](#tag/Clientes). type: string example: CSgaZlLaPMZO. payment_method_id: description: > [ID del Método de Pago](#tag/Metodos-de-Pago). Este campo es requerido si no utilizas `payment_method_number`. type: string example: PMBja4YZ2GDR. start_date: description: >- Una fecha futura en la que el primer pago de la suscripción debe ser recogido. Si no se especifica, el primer pago se realizará lo antes posible. type: string interval_unit: description: > La unidad de tiempo entre las fechas de pago del cliente. Uno de: `weekly`, `monthly` or `yearly`. Ejemplo `monthly`. type: string interval: description: >- Número de `interval_unit` entre las fechas de pago del cliente. Debe ser mayor que 1. Si `interval_units` es semanal y el intervalo es 2, luego se le cobrará al cliente cada dos semanas. El valor predeterminado es 1. type: number day_of_month: description: >- Día del mes, del 1 al 28. Este campo es obligatorio si `interval_unit` se establece en mensual. El valor predeterminado es 1. type: number day_of_week: description: >- Número del día de la semana, de 0 (Domingo) a 6 (Sábado). Este campo es obligatorio si `interval_unit` se establece en `weekly`. type: number auto_retries_max_attempts: description: >- La cantidad máxima de veces que se pueden volver a intentar automáticamente los pagos de esta suscripción. type: - 'null' - number example: null first_payment_in_binary_mode: description: > Fuerza el procesamiento instantáneo del primer pago de la suscripción, proporcionando un estado inmediato de `approved` o `rejected` dentro de la respuesta de la solicitud. Esta configuración elimina los reintentos automáticos para pagos fallidos, garantizando un resultado rápido y concluyente. Cuando se establece en `true`, el pago se procesa inmediatamente. Si falla, la suscripción quedará en estado `incomplete`` y no se realizará ningún reintento automático. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} example: amount: 100 description: Some subscription description customer_id: CS9PL8eeo8aB payment_method_id: PMBja4YZ2GDR interval_unit: monthly day_of_month: 1 metadata: some: metadata required: - amount - customer_id - description - interval_unit responses: '201': description: OK content: application/json: schema: properties: data: description: Este objeto representa una Suscripción de su organización. type: object additionalProperties: false properties: id: description: Identificador único de la Suscripción. type: string example: SBmQ6j9NWxblNv readOnly: true object: type: string enum: - subscription amount: description: Monto de la suscripción type: number example: 12.5 description: description: Descripción de la suscripción type: string example: Ajuste por deuda pasada currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD status: description: Estado de la suscripción type: string example: active enum: - active - paused - cancelled - finished - incomplete - incomplete_expired count: description: > El número total de pagos que debe realizar esta suscripción. type: - 'null' - number example: 12 start_date: description: >- Una fecha futura en la que el primer pago de la suscripción debe ser recogido. type: string example: '2022-08-04' interval_unit: description: >- La unidad de tiempo entre las fechas de pago del cliente. type: string example: monthly enum: - weekly - monthly - yearly interval: description: >- Número de `interval_unit` entre las fechas de pago del cliente. Debe ser mayor que 1. Si `interval_units` es semanal y el intervalo es 2, luego se le cobrará al cliente cada dos semanas. El valor predeterminado es 1. type: number example: 1 day_of_month: description: >- Día del mes, del 1 al 28. Este campo es obligatorio si `interval_unit` se establece en mensual. El valor predeterminado es 1. type: number day_of_week: description: >- Número del día de la semana, de 0 (Domingo) a 6 (Sábado). Este campo es obligatorio si `interval_unit` se establece en `weekly`. type: - 'null' - number livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' auto_retries_max_attempts: description: >- La cantidad máxima de veces que se pueden volver a intentar automáticamente los pagos de esta suscripción. type: - 'null' - number example: null first_date: description: >- La fecha en la que debe realizarse el primer pago. Cuando se deja en blanco y se proporciona el mes o el día del mes, se establecerá como fecha del primer pago. Si se crea sin este dato, se cobrará lo antes posible. type: string example: '2022-08-04' upcoming_dates: description: Próximas 5 fechas de pago. type: array items: type: string properties: {} example: - '2022-09-04' - '2022-10-04' - '2022-11-04' - '2022-12-04' - '2023-01-04' customer: description: >- Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente payment_method: description: Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: >- Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: >- Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: >- Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: >- Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: >- Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: >- Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} required: - id - object - amount - description - currency - status - count - start_date - interval_unit - interval - day_of_month - day_of_week - livemode - created_at - updated_at - first_date - upcoming_dates - customer - payment_method - auto_retries_max_attempts - metadata title: Suscripción example: data: amount: 100 auto_retries_max_attempts: null count: null created_at: '2023-02-27T12:11:18-03:00' currency: ARS customer: created_at: '2023-02-27T12:10:11-03:00' default_payment_method_id: null deleted_at: null email: null gateway_identifier: '290' id: CSbJrDMpVwaW identification_number: null identification_type: null livemode: false metadata: null mobile_number: null name: null object: customer updated_at: '2023-02-27T12:10:11-03:00' day_of_month: 1 day_of_week: null description: My Subscription first_date: '2023-03-01' id: SBJ843BlLBbd5Y interval: 1 interval_unit: monthly livemode: false metadata: null object: subscription payment_method: card: country: AR expiration_month: 12 expiration_year: 2030 fingerprint: spnkdn504cBwsJbN funding: debit issuer: null last_four_digits: '4905' name: Visa network: visa providers: available: - fiserv-argentina - mercado-pago - payway - wompi preferred: fiserv-argentina created_at: '2023-02-27T12:09:59-03:00' id: PMVExkx45kMK livemode: false metadata: null object: payment_method type: card updated_at: '2023-02-27T12:09:59-03:00' start_date: '2023-02-27' status: active upcoming_dates: - '2023-03-01' - '2023-04-01' - '2023-05-01' - '2023-06-01' - '2023-07-01' updated_at: '2023-02-27T12:11:18-03:00' '401': description: No Autorizado content: application/json: schema: properties: data: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '422': description: Datos Inválidos content: application/json: example: errors: email: - El email es inválido. message: The given data was invalid. tags: - Suscripciones x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/subscriptions \ --header 'Authorization: Bearer sk_live_...' \ --header 'content-type: application/json' \ --data '{"amount":100,"description":"Some subscription description","customer_id":"CS9PL8eeo8aB","payment_method_id":"PMBja4YZ2GDR","interval_unit":"monthly","day_of_month":1,"metadata":{"some":"metadata"}}' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/subscriptions', headers: { 'content-type': 'application/json', Authorization: 'Bearer sk_live_...' }, body: { amount: 100, description: 'Some subscription description', customer_id: 'CS9PL8eeo8aB', payment_method_id: 'PMBja4YZ2GDR', interval_unit: 'monthly', day_of_month: 1, metadata: {some: 'metadata'} }, json: true }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/subscriptions'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'content-type' => 'application/json', 'Authorization' => 'Bearer sk_live_...' ]); $request->setBody('{"amount":100,"description":"Some subscription description","customer_id":"CS9PL8eeo8aB","payment_method_id":"PMBja4YZ2GDR","interval_unit":"monthly","day_of_month":1,"metadata":{"some":"metadata"}}'); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/subscriptions" payload = { "amount": 100, "description": "Some subscription description", "customer_id": "CS9PL8eeo8aB", "payment_method_id": "PMBja4YZ2GDR", "interval_unit": "monthly", "day_of_month": 1, "metadata": {"some": "metadata"} } headers = { "content-type": "application/json", "Authorization": "Bearer sk_live_..." } response = requests.request("POST", url, json=payload, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/subscriptions") .header("content-type", "application/json") .header("Authorization", "Bearer sk_live_...") .body("{\"amount\":100,\"description\":\"Some subscription description\",\"customer_id\":\"CS9PL8eeo8aB\",\"payment_method_id\":\"PMBja4YZ2GDR\",\"interval_unit\":\"monthly\",\"day_of_month\":1,\"metadata\":{\"some\":\"metadata\"}}") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/subscriptions") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'application/json' request["Authorization"] = 'Bearer sk_live_...' request.body = "{\"amount\":100,\"description\":\"Some subscription description\",\"customer_id\":\"CS9PL8eeo8aB\",\"payment_method_id\":\"PMBja4YZ2GDR\",\"interval_unit\":\"monthly\",\"day_of_month\":1,\"metadata\":{\"some\":\"metadata\"}}" response = http.request(request) puts response.read_body /v1/subscriptions/{id}: get: operationId: SubscriptionsGetSubscription summary: Obtener una suscripción description: Obtener una suscripción. parameters: - name: id in: path description: | [ID de la Suscripción](#tag/Suscripciones). required: true schema: type: string example: SBmX1MrZ77Mwq3 responses: '200': description: Obtener una suscripción content: application/json: schema: properties: data: description: Este objeto representa una Suscripción de su organización. type: object additionalProperties: false properties: id: description: Identificador único de la Suscripción. type: string example: SBmQ6j9NWxblNv readOnly: true object: type: string enum: - subscription amount: description: Monto de la suscripción type: number example: 12.5 description: description: Descripción de la suscripción type: string example: Ajuste por deuda pasada currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD status: description: Estado de la suscripción type: string example: active enum: - active - paused - cancelled - finished - incomplete - incomplete_expired count: description: > El número total de pagos que debe realizar esta suscripción. type: - 'null' - number example: 12 start_date: description: >- Una fecha futura en la que el primer pago de la suscripción debe ser recogido. type: string example: '2022-08-04' interval_unit: description: >- La unidad de tiempo entre las fechas de pago del cliente. type: string example: monthly enum: - weekly - monthly - yearly interval: description: >- Número de `interval_unit` entre las fechas de pago del cliente. Debe ser mayor que 1. Si `interval_units` es semanal y el intervalo es 2, luego se le cobrará al cliente cada dos semanas. El valor predeterminado es 1. type: number example: 1 day_of_month: description: >- Día del mes, del 1 al 28. Este campo es obligatorio si `interval_unit` se establece en mensual. El valor predeterminado es 1. type: number day_of_week: description: >- Número del día de la semana, de 0 (Domingo) a 6 (Sábado). Este campo es obligatorio si `interval_unit` se establece en `weekly`. type: - 'null' - number livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' auto_retries_max_attempts: description: >- La cantidad máxima de veces que se pueden volver a intentar automáticamente los pagos de esta suscripción. type: - 'null' - number example: null first_date: description: >- La fecha en la que debe realizarse el primer pago. Cuando se deja en blanco y se proporciona el mes o el día del mes, se establecerá como fecha del primer pago. Si se crea sin este dato, se cobrará lo antes posible. type: string example: '2022-08-04' upcoming_dates: description: Próximas 5 fechas de pago. type: array items: type: string properties: {} example: - '2022-09-04' - '2022-10-04' - '2022-11-04' - '2022-12-04' - '2023-01-04' customer: description: >- Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente payment_method: description: Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: >- Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: >- Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: >- Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: >- Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: >- Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: >- Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} required: - id - object - amount - description - currency - status - count - start_date - interval_unit - interval - day_of_month - day_of_week - livemode - created_at - updated_at - first_date - upcoming_dates - customer - payment_method - auto_retries_max_attempts - metadata title: Suscripción '401': description: No Autorizado content: application/json: schema: properties: data: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '404': description: Objeto no encontrado content: application/json: schema: properties: data: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found tags: - Suscripciones x-codeSamples: - lang: Shell + Curl source: |- curl --request GET \ --url https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3 \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3'); $request->setMethod(HTTP_METH_GET); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: |- import requests url = "https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body put: operationId: SubscriptionsUpdateSubscription summary: Actualizar una suscripción description: Actualizar una suscripción. parameters: - name: id in: path description: Subscription ID. required: true schema: type: string example: SBmX1MrZ77Mwq3 requestBody: required: false content: application/json: encoding: metadata: explode: true style: deepObject schema: type: object properties: amount: description: | The amount of each payment of the subscription. type: number description: description: | The title of each payment of the subscription. type: string maxLength: 255 count: description: > El número total de pagos que debe realizar esta suscripción. Si no se especifíca, la suscripción continuará hasta que la canceles. type: number customer_id: description: | [ID de cliente](#tag/Clientes). type: string example: CSgaZlLaPMZO payment_method_id: description: > El [ID del Método de Pago](#tag/Metodos-de-Pago) para cada pago de la suscripción. Este campo es requerido si no utilizas `payment_method_number`. type: string example: PMBja4YZ2GDR. start_date: description: >- A future date on which the first payment of the subscription should be collected. If not specified, the first payment will be collected as soon as possible. type: string interval_unit: description: >- The unit of time between customer charge dates. One of weekly, monthly or yearly. Example monthly type: string interval: description: >- Number of interval_units between customer charge dates. Must be greater than to 1. If interval_unit is weekly and interval is 2, then the customer will be charged every two weeks. Defaults to 1. Example 1 type: number day_of_month: description: >- Sólo para suscripciones. Día del mes, del 1 al 28. Este campo es requerido si `interval_unit` es `monthly`. El default es 1. type: number day_of_week: description: >- Número del día de la semana, de 0 (Domingo) a 6 (Sábado). Este campo es obligatorio si `interval_unit` se establece en `weekly`. type: number auto_retries_max_attempts: description: >- La cantidad máxima de veces que se pueden volver a intentar automáticamente los pagos de esta suscripción. type: - 'null' - number example: null metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} example: amount: 100 description: Some subscription description customer_id: CS9PL8eeo8aB payment_method_id: PMBja4YZ2GDR interval_unit: monthly day_of_month: 1 metadata: some: metadata responses: '200': description: Subscription updated successfuly. content: application/json: example: data: amount: 100 auto_retries_max_attempts: null count: null created_at: '2023-02-27T12:11:18-03:00' currency: ARS customer: created_at: '2023-02-27T12:10:11-03:00' deleted_at: null email: null gateway_identifier: '290' id: CSbJrDMpVwaW identification_number: null identification_type: null livemode: false metadata: null mobile_number: null name: null object: customer updated_at: '2023-02-27T12:10:11-03:00' day_of_month: 1 day_of_week: null description: My Subscription first_date: '2023-03-01' id: SBJ843BlLBbd5Y interval: 1 interval_unit: monthly livemode: false metadata: null object: subscription payment_method: card: country: AR expiration_month: 12 expiration_year: 2030 fingerprint: spnkdn504cBwsJbN funding: debit issuer: null last_four_digits: '4905' name: Visa network: visa providers: available: - fiserv-argentina - mercado-pago - payway - wompi preferred: fiserv-argentina created_at: '2023-02-27T12:09:59-03:00' id: PMVExkx45kMK livemode: false metadata: null object: payment_method type: card updated_at: '2023-02-27T12:09:59-03:00' start_date: '2023-02-27' status: active upcoming_dates: - '2023-03-01' - '2023-04-01' - '2023-05-01' - '2023-06-01' - '2023-07-01' updated_at: '2023-02-27T12:11:18-03:00' schema: properties: data: description: Este objeto representa una Suscripción de su organización. type: object additionalProperties: false properties: id: description: Identificador único de la Suscripción. type: string example: SBmQ6j9NWxblNv readOnly: true object: type: string enum: - subscription amount: description: Monto de la suscripción type: number example: 12.5 description: description: Descripción de la suscripción type: string example: Ajuste por deuda pasada currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD status: description: Estado de la suscripción type: string example: active enum: - active - paused - cancelled - finished - incomplete - incomplete_expired count: description: > El número total de pagos que debe realizar esta suscripción. type: - 'null' - number example: 12 start_date: description: >- Una fecha futura en la que el primer pago de la suscripción debe ser recogido. type: string example: '2022-08-04' interval_unit: description: >- La unidad de tiempo entre las fechas de pago del cliente. type: string example: monthly enum: - weekly - monthly - yearly interval: description: >- Número de `interval_unit` entre las fechas de pago del cliente. Debe ser mayor que 1. Si `interval_units` es semanal y el intervalo es 2, luego se le cobrará al cliente cada dos semanas. El valor predeterminado es 1. type: number example: 1 day_of_month: description: >- Día del mes, del 1 al 28. Este campo es obligatorio si `interval_unit` se establece en mensual. El valor predeterminado es 1. type: number day_of_week: description: >- Número del día de la semana, de 0 (Domingo) a 6 (Sábado). Este campo es obligatorio si `interval_unit` se establece en `weekly`. type: - 'null' - number livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' auto_retries_max_attempts: description: >- La cantidad máxima de veces que se pueden volver a intentar automáticamente los pagos de esta suscripción. type: - 'null' - number example: null first_date: description: >- La fecha en la que debe realizarse el primer pago. Cuando se deja en blanco y se proporciona el mes o el día del mes, se establecerá como fecha del primer pago. Si se crea sin este dato, se cobrará lo antes posible. type: string example: '2022-08-04' upcoming_dates: description: Próximas 5 fechas de pago. type: array items: type: string properties: {} example: - '2022-09-04' - '2022-10-04' - '2022-11-04' - '2022-12-04' - '2023-01-04' customer: description: >- Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente payment_method: description: Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: >- Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: >- Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: >- Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: >- Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: >- Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: >- Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} required: - id - object - amount - description - currency - status - count - start_date - interval_unit - interval - day_of_month - day_of_week - livemode - created_at - updated_at - first_date - upcoming_dates - customer - payment_method - auto_retries_max_attempts - metadata title: Suscripción '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '422': description: Unprocessable Entity content: application/json: example: errors: email: - El email es inválido. message: The given data was invalid. tags: - Suscripciones x-codeSamples: - lang: Shell + Curl source: |- curl --request PUT \ --url https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3 \ --header 'Authorization: Bearer sk_live_...' \ --header 'content-type: application/json' \ --data '{"amount":100,"description":"Some subscription description","customer_id":"CS9PL8eeo8aB","payment_method_id":"PMBja4YZ2GDR","interval_unit":"monthly","day_of_month":1,"metadata":{"some":"metadata"}}' - lang: Node + Request source: | const request = require('request'); const options = { method: 'PUT', url: 'https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3', headers: { 'content-type': 'application/json', Authorization: 'Bearer sk_live_...' }, body: { amount: 100, description: 'Some subscription description', customer_id: 'CS9PL8eeo8aB', payment_method_id: 'PMBja4YZ2GDR', interval_unit: 'monthly', day_of_month: 1, metadata: {some: 'metadata'} }, json: true }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3'); $request->setMethod(HTTP_METH_PUT); $request->setHeaders([ 'content-type' => 'application/json', 'Authorization' => 'Bearer sk_live_...' ]); $request->setBody('{"amount":100,"description":"Some subscription description","customer_id":"CS9PL8eeo8aB","payment_method_id":"PMBja4YZ2GDR","interval_unit":"monthly","day_of_month":1,"metadata":{"some":"metadata"}}'); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3" payload = { "amount": 100, "description": "Some subscription description", "customer_id": "CS9PL8eeo8aB", "payment_method_id": "PMBja4YZ2GDR", "interval_unit": "monthly", "day_of_month": 1, "metadata": {"some": "metadata"} } headers = { "content-type": "application/json", "Authorization": "Bearer sk_live_..." } response = requests.request("PUT", url, json=payload, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.put("https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3") .header("content-type", "application/json") .header("Authorization", "Bearer sk_live_...") .body("{\"amount\":100,\"description\":\"Some subscription description\",\"customer_id\":\"CS9PL8eeo8aB\",\"payment_method_id\":\"PMBja4YZ2GDR\",\"interval_unit\":\"monthly\",\"day_of_month\":1,\"metadata\":{\"some\":\"metadata\"}}") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'application/json' request["Authorization"] = 'Bearer sk_live_...' request.body = "{\"amount\":100,\"description\":\"Some subscription description\",\"customer_id\":\"CS9PL8eeo8aB\",\"payment_method_id\":\"PMBja4YZ2GDR\",\"interval_unit\":\"monthly\",\"day_of_month\":1,\"metadata\":{\"some\":\"metadata\"}}" response = http.request(request) puts response.read_body /v1/subscriptions/{id}/actions/pause: post: operationId: SubscriptionsPauseSubscription summary: Pausar una suscripción description: Pausar una suscripción. parameters: - name: id in: path description: | [ID de la Suscripción](#tag/Suscripciones). required: true schema: type: string example: SBmX1MrZ77Mwq3 responses: '201': description: Suscripción pausada con éxito content: application/json: schema: properties: data: description: Este objeto representa una Suscripción de su organización. type: object additionalProperties: false properties: id: description: Identificador único de la Suscripción. type: string example: SBmQ6j9NWxblNv readOnly: true object: type: string enum: - subscription amount: description: Monto de la suscripción type: number example: 12.5 description: description: Descripción de la suscripción type: string example: Ajuste por deuda pasada currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD status: description: Estado de la suscripción type: string example: active enum: - active - paused - cancelled - finished - incomplete - incomplete_expired count: description: > El número total de pagos que debe realizar esta suscripción. type: - 'null' - number example: 12 start_date: description: >- Una fecha futura en la que el primer pago de la suscripción debe ser recogido. type: string example: '2022-08-04' interval_unit: description: >- La unidad de tiempo entre las fechas de pago del cliente. type: string example: monthly enum: - weekly - monthly - yearly interval: description: >- Número de `interval_unit` entre las fechas de pago del cliente. Debe ser mayor que 1. Si `interval_units` es semanal y el intervalo es 2, luego se le cobrará al cliente cada dos semanas. El valor predeterminado es 1. type: number example: 1 day_of_month: description: >- Día del mes, del 1 al 28. Este campo es obligatorio si `interval_unit` se establece en mensual. El valor predeterminado es 1. type: number day_of_week: description: >- Número del día de la semana, de 0 (Domingo) a 6 (Sábado). Este campo es obligatorio si `interval_unit` se establece en `weekly`. type: - 'null' - number livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' auto_retries_max_attempts: description: >- La cantidad máxima de veces que se pueden volver a intentar automáticamente los pagos de esta suscripción. type: - 'null' - number example: null first_date: description: >- La fecha en la que debe realizarse el primer pago. Cuando se deja en blanco y se proporciona el mes o el día del mes, se establecerá como fecha del primer pago. Si se crea sin este dato, se cobrará lo antes posible. type: string example: '2022-08-04' upcoming_dates: description: Próximas 5 fechas de pago. type: array items: type: string properties: {} example: - '2022-09-04' - '2022-10-04' - '2022-11-04' - '2022-12-04' - '2023-01-04' customer: description: >- Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente payment_method: description: Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: >- Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: >- Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: >- Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: >- Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: >- Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: >- Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} required: - id - object - amount - description - currency - status - count - start_date - interval_unit - interval - day_of_month - day_of_week - livemode - created_at - updated_at - first_date - upcoming_dates - customer - payment_method - auto_retries_max_attempts - metadata title: Suscripción '401': description: No autorizado content: application/json: schema: properties: data: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '422': description: Datos inválidos content: application/json: example: message: Subscription cannot be paused. tags: - Suscripciones x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3/actions/pause \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3/actions/pause', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3/actions/pause'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3/actions/pause" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("POST", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3/actions/pause") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3/actions/pause") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/subscriptions/{id}/actions/resume: post: operationId: SubscriptionsResumeSubscription summary: Reanudar una suscripción description: Reanudar una suscripción. parameters: - name: id in: path description: Subscription ID. required: true schema: type: string example: SBmX1MrZ77Mwq3 responses: '201': description: Reanudada con éxito content: application/json: schema: properties: data: description: Este objeto representa una Suscripción de su organización. type: object additionalProperties: false properties: id: description: Identificador único de la Suscripción. type: string example: SBmQ6j9NWxblNv readOnly: true object: type: string enum: - subscription amount: description: Monto de la suscripción type: number example: 12.5 description: description: Descripción de la suscripción type: string example: Ajuste por deuda pasada currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD status: description: Estado de la suscripción type: string example: active enum: - active - paused - cancelled - finished - incomplete - incomplete_expired count: description: > El número total de pagos que debe realizar esta suscripción. type: - 'null' - number example: 12 start_date: description: >- Una fecha futura en la que el primer pago de la suscripción debe ser recogido. type: string example: '2022-08-04' interval_unit: description: >- La unidad de tiempo entre las fechas de pago del cliente. type: string example: monthly enum: - weekly - monthly - yearly interval: description: >- Número de `interval_unit` entre las fechas de pago del cliente. Debe ser mayor que 1. Si `interval_units` es semanal y el intervalo es 2, luego se le cobrará al cliente cada dos semanas. El valor predeterminado es 1. type: number example: 1 day_of_month: description: >- Día del mes, del 1 al 28. Este campo es obligatorio si `interval_unit` se establece en mensual. El valor predeterminado es 1. type: number day_of_week: description: >- Número del día de la semana, de 0 (Domingo) a 6 (Sábado). Este campo es obligatorio si `interval_unit` se establece en `weekly`. type: - 'null' - number livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' auto_retries_max_attempts: description: >- La cantidad máxima de veces que se pueden volver a intentar automáticamente los pagos de esta suscripción. type: - 'null' - number example: null first_date: description: >- La fecha en la que debe realizarse el primer pago. Cuando se deja en blanco y se proporciona el mes o el día del mes, se establecerá como fecha del primer pago. Si se crea sin este dato, se cobrará lo antes posible. type: string example: '2022-08-04' upcoming_dates: description: Próximas 5 fechas de pago. type: array items: type: string properties: {} example: - '2022-09-04' - '2022-10-04' - '2022-11-04' - '2022-12-04' - '2023-01-04' customer: description: >- Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente payment_method: description: Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: >- Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: >- Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: >- Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: >- Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: >- Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: >- Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} required: - id - object - amount - description - currency - status - count - start_date - interval_unit - interval - day_of_month - day_of_week - livemode - created_at - updated_at - first_date - upcoming_dates - customer - payment_method - auto_retries_max_attempts - metadata title: Suscripción '401': description: No autorizado content: application/json: schema: properties: data: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '422': description: Datos inválidos content: application/json: example: errors: amount: - Amount cannot be changed. message: The given data was invalid. tags: - Suscripciones x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3/actions/resume \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3/actions/resume', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3/actions/resume'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3/actions/resume" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("POST", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3/actions/resume") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3/actions/resume") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/subscriptions/{id}/actions/cancel: post: operationId: SubscriptionsCancelSubscription summary: Cancelar una suscripción description: | Esta acción cancela y archiva la suscripción. También cancela los pagos relacionados con ella. parameters: - name: id in: path description: | [ID de la Suscripción](#tag/Suscripciones). required: true schema: type: string example: SBmX1MrZ77Mwq3 responses: '201': description: Suscripción cancelada con éxito content: application/json: schema: properties: data: description: Este objeto representa una Suscripción de su organización. type: object additionalProperties: false properties: id: description: Identificador único de la Suscripción. type: string example: SBmQ6j9NWxblNv readOnly: true object: type: string enum: - subscription amount: description: Monto de la suscripción type: number example: 12.5 description: description: Descripción de la suscripción type: string example: Ajuste por deuda pasada currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD status: description: Estado de la suscripción type: string example: active enum: - active - paused - cancelled - finished - incomplete - incomplete_expired count: description: > El número total de pagos que debe realizar esta suscripción. type: - 'null' - number example: 12 start_date: description: >- Una fecha futura en la que el primer pago de la suscripción debe ser recogido. type: string example: '2022-08-04' interval_unit: description: >- La unidad de tiempo entre las fechas de pago del cliente. type: string example: monthly enum: - weekly - monthly - yearly interval: description: >- Número de `interval_unit` entre las fechas de pago del cliente. Debe ser mayor que 1. Si `interval_units` es semanal y el intervalo es 2, luego se le cobrará al cliente cada dos semanas. El valor predeterminado es 1. type: number example: 1 day_of_month: description: >- Día del mes, del 1 al 28. Este campo es obligatorio si `interval_unit` se establece en mensual. El valor predeterminado es 1. type: number day_of_week: description: >- Número del día de la semana, de 0 (Domingo) a 6 (Sábado). Este campo es obligatorio si `interval_unit` se establece en `weekly`. type: - 'null' - number livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' auto_retries_max_attempts: description: >- La cantidad máxima de veces que se pueden volver a intentar automáticamente los pagos de esta suscripción. type: - 'null' - number example: null first_date: description: >- La fecha en la que debe realizarse el primer pago. Cuando se deja en blanco y se proporciona el mes o el día del mes, se establecerá como fecha del primer pago. Si se crea sin este dato, se cobrará lo antes posible. type: string example: '2022-08-04' upcoming_dates: description: Próximas 5 fechas de pago. type: array items: type: string properties: {} example: - '2022-09-04' - '2022-10-04' - '2022-11-04' - '2022-12-04' - '2023-01-04' customer: description: >- Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente payment_method: description: Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: >- Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: >- Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: >- Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: >- Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: >- Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: >- Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} required: - id - object - amount - description - currency - status - count - start_date - interval_unit - interval - day_of_month - day_of_week - livemode - created_at - updated_at - first_date - upcoming_dates - customer - payment_method - auto_retries_max_attempts - metadata title: Suscripción '401': description: No Autorizado content: application/json: schema: properties: data: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '422': description: Datos Inválidos content: application/json: schema: properties: message: type: string example: message: Subscription cannot be cancelled. tags: - Suscripciones x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3/actions/cancel \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3/actions/cancel', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3/actions/cancel'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3/actions/cancel" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("POST", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3/actions/cancel") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/subscriptions/SBmX1MrZ77Mwq3/actions/cancel") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/subscriptions/search: get: operationId: SubscriptionsSearch summary: Buscar suscripciones description: Buscar suscripciones. parameters: - name: q in: query description: > Puede usar [la sintáxis de búsqueda](https://debi.pro/docs/docs/producto/Sistema%20de%20B%C3%BAsquedas/). required: true schema: type: string example: john doe - name: limit in: query description: >- 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. required: false schema: type: integer example: 20 - name: page in: query description: > 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 `next_page` devuelto en una respuesta anterior para solicitar resultados posteriores. required: true schema: type: string example: john doe responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Suscripción description: >- Este objeto representa una Suscripción de su organización. type: object properties: id: description: Identificador único de la Suscripción. type: string example: SBmQ6j9NWxblNv readOnly: true object: type: string enum: - subscription amount: description: Monto de la suscripción type: number example: 12.5 description: description: Descripción de la suscripción type: string example: Ajuste por deuda pasada currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD status: description: Estado de la suscripción type: string example: active enum: - active - paused - cancelled - finished - incomplete - incomplete_expired count: description: > El número total de pagos que debe realizar esta suscripción. type: - 'null' - number example: 12 start_date: description: >- Una fecha futura en la que el primer pago de la suscripción debe ser recogido. type: string example: '2022-08-04' interval_unit: description: >- La unidad de tiempo entre las fechas de pago del cliente. type: string example: monthly enum: - weekly - monthly - yearly interval: description: >- Número de `interval_unit` entre las fechas de pago del cliente. Debe ser mayor que 1. Si `interval_units` es semanal y el intervalo es 2, luego se le cobrará al cliente cada dos semanas. El valor predeterminado es 1. type: number example: 1 day_of_month: description: >- Día del mes, del 1 al 28. Este campo es obligatorio si `interval_unit` se establece en mensual. El valor predeterminado es 1. type: number day_of_week: description: >- Número del día de la semana, de 0 (Domingo) a 6 (Sábado). Este campo es obligatorio si `interval_unit` se establece en `weekly`. type: - 'null' - number livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' auto_retries_max_attempts: description: >- La cantidad máxima de veces que se pueden volver a intentar automáticamente los pagos de esta suscripción. type: - 'null' - number example: null first_date: description: >- La fecha en la que debe realizarse el primer pago. Cuando se deja en blanco y se proporciona el mes o el día del mes, se establecerá como fecha del primer pago. Si se crea sin este dato, se cobrará lo antes posible. type: string example: '2022-08-04' upcoming_dates: description: Próximas 5 fechas de pago. type: array items: type: string properties: {} example: - '2022-09-04' - '2022-10-04' - '2022-11-04' - '2022-12-04' - '2023-01-04' customer: description: >- Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente payment_method: description: >- Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: >- Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: >- Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: >- Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: >- Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: >- Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: >- Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: >- Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: >- Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: >- Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: >- Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: >- Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: >- Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} additionalProperties: false required: - id - object - amount - description - currency - status - count - start_date - interval_unit - interval - day_of_month - day_of_week - livemode - created_at - updated_at - first_date - upcoming_dates - customer - payment_method - auto_retries_max_attempts - metadata links: description: Links de paginación type: object properties: first: type: - 'null' - string example: https://api.debi.pro/v1/customers last: type: - 'null' - string example: https://api.debi.pro/v1/customers next: type: - 'null' - string example: https://api.debi.pro/v1/customers prev: type: - 'null' - string example: https://api.debi.pro/v1/customers title: Metadata de Respuesta meta: description: Metadata de paginación type: object properties: per_page: type: number example: 25 total: type: number example: 2500 path: type: string example: https://api.debi.pro/v1/customers next_cursor: description: Cursor de Paginación. type: - 'null' - string prev_cursor: description: Cursor de Paginación. type: - 'null' - string title: Response Meta required: - data example: data: - id: SBmQ6j9NWxblNv object: subscription amount: 5200 description: Cuota mensual currency: ARS status: active auto_retries_max_attempts: null count: null start_date: '2021-07-01' interval_unit: monthly interval: 1 day_of_month: 1 day_of_week: null livemode: true created_at: '2021-07-01T12:24:32-03:00' updated_at: '2021-07-01T12:24:32-03:00' first_date: '2022-09-01' upcoming_dates: - '2022-09-01' - '2022-10-01' - '2022-11-01' - '2022-12-01' - '2023-01-01' 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 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' metadata: null links: prev: >- https://api.debi.pro/subscriptions/search?q=john%20doe&page=1 next: >- https://api.debi.pro/subscriptions/search?q=john%20doe&page=3 meta: per_page: 25 total: 2500 '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Suscripciones x-codeSamples: - lang: Shell + Curl source: |- curl --request GET \ --url 'https://api.debi.pro/v1/subscriptions/search?q=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&page=SOME_STRING_VALUE' \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/subscriptions/search', qs: {q: 'SOME_STRING_VALUE', limit: 'SOME_INTEGER_VALUE', page: 'SOME_STRING_VALUE'}, headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/subscriptions/search'); $request->setMethod(HTTP_METH_GET); $request->setQueryData([ 'q' => 'SOME_STRING_VALUE', 'limit' => 'SOME_INTEGER_VALUE', 'page' => 'SOME_STRING_VALUE' ]); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/subscriptions/search" querystring = {"q":"SOME_STRING_VALUE","limit":"SOME_INTEGER_VALUE","page":"SOME_STRING_VALUE"} headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers, params=querystring) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("https://api.debi.pro/v1/subscriptions/search?q=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&page=SOME_STRING_VALUE") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/subscriptions/search?q=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&page=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body /v1/webhooks: get: operationId: WebhooksGetWebhooks summary: Obtener todos los webhooks description: Obtener una lista con tus webhooks. parameters: - name: created_at in: query description: >- Un filtro en la lista, basado en el campo `created_at` del objeto. El valor puede ser un Unix Timestamp, o puede ser un diccionario con varias opciones de consulta diferentes. required: false schema: type: object properties: gt: description: Mínimo valor para filtrar (exclusivo) type: integer gte: description: Mínimo valor para filtrar (inclusivo) type: integer lt: description: Máximo valor para filtrar (exclusivo) type: integer lte: description: Máximo valor para filtrar (inclusivo) type: integer title: range_query_specs explode: true style: deepObject - name: ending_before in: query description: >- Un cursor para utilizar en la paginación. `ending_before` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, comenzando con `obj_ID`, la próxima llamda puede incluir `ending_before=obj_ID` para obtener la página previa. required: false schema: type: string style: form - name: limit in: query description: >- 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. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- Un cursor para utilizar en la paginación. `starting_after` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, terminando con `obj_ID`, la próxima llamda puede incluir `starting_after=obj_ID` para obtener la página siguiente. required: false schema: type: string style: form responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Webhook description: >- Puede configurar tus [webhooks](https://debi.pro/docs/webhooks/) a través de la API para obtener notificaciones sobre eventos que suceden en tu cuenta Debi. La mayoría de los usuarios configuran webhooks desde [el panel de control](https://dashboard.debi.pro/webhooks), que proporciona una interfaz de usuario para registrar y probar los puntos finales de su webhook. type: object properties: id: description: Identificador único del objeto. type: string example: WHA8EJ1DkDnY readOnly: true object: type: string enum: - webhook url: description: La URL del webhook. type: string example: https://debi.pro/webhook/200 maxLength: 5000 enabled: description: Declara si el webhook está habilitado. type: boolean enabled_events: description: > Uno de: `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`. type: array items: type: string properties: {} example: - customer.created - customer.updated - payment.created secret: description: >- El secreto del webhook, usado para [firmar los mensajes](https://debi.pro/docs/spa/api/#asegurando-los-webhooks). type: string example: Rrdm41mW4x54uUS2A6QnHhm7hXwpuR maxLength: 5000 failed_lately_count: type: integer format: int32 example: 0 success_lately_count: type: integer format: int32 example: 0 livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' example: created_at: '2022-02-11T23:19:22-03:00' enabled: true enabled_events: - '*' id: WHq4VzyAzDgB livemode: true object: webhook secret: DmUeH9E9yJ7ax9IYQVm9HpQ3VWvIx0 updated_at: '2022-02-11T23:19:22-03:00' url: https://site.com/webhook links: description: Links de paginación type: object properties: first: type: - 'null' - string example: https://api.debi.pro/v1/customers last: type: - 'null' - string example: https://api.debi.pro/v1/customers next: type: - 'null' - string example: https://api.debi.pro/v1/customers prev: type: - 'null' - string example: https://api.debi.pro/v1/customers title: Metadata de Respuesta meta: description: Metadata de paginación type: object properties: per_page: type: number example: 25 total: type: number example: 2500 path: type: string example: https://api.debi.pro/v1/customers next_cursor: description: Cursor de Paginación. type: - 'null' - string prev_cursor: description: Cursor de Paginación. type: - 'null' - string title: Response Meta required: - data '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Webhooks x-codeSamples: - lang: Shell + Curl source: |- curl --request GET \ --url 'https://api.debi.pro/v1/webhooks?created_at=SOME_OBJECT_VALUE&ending_before=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE' \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/webhooks', qs: { created_at: 'SOME_OBJECT_VALUE', ending_before: 'SOME_STRING_VALUE', limit: 'SOME_INTEGER_VALUE', starting_after: 'SOME_STRING_VALUE' }, headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/webhooks'); $request->setMethod(HTTP_METH_GET); $request->setQueryData([ 'created_at' => 'SOME_OBJECT_VALUE', 'ending_before' => 'SOME_STRING_VALUE', 'limit' => 'SOME_INTEGER_VALUE', 'starting_after' => 'SOME_STRING_VALUE' ]); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/webhooks" querystring = {"created_at":"SOME_OBJECT_VALUE","ending_before":"SOME_STRING_VALUE","limit":"SOME_INTEGER_VALUE","starting_after":"SOME_STRING_VALUE"} headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers, params=querystring) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("https://api.debi.pro/v1/webhooks?created_at=SOME_OBJECT_VALUE&ending_before=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/webhooks?created_at=SOME_OBJECT_VALUE&ending_before=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body post: operationId: WebhooksCreateWebhook summary: Crear un webhook description: Crear un webhook. requestBody: required: true content: application/json: encoding: enabled_events: explode: true style: deepObject metadata: explode: true style: deepObject example: url: https://my_domain/my_webhook_endpoint schema: type: object properties: enabled_events: description: >- La lista de eventos para habilitar para este webhook. Puede especificar `['*']` para habilitar todos los eventos, excepto aquellos que requieren selección explícita. type: array items: 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 type: string metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} url: description: La URL del webhook. type: string additionalProperties: false required: - url responses: '201': description: OK content: application/json: schema: properties: data: description: >- Puede configurar tus [webhooks](https://debi.pro/docs/webhooks/) a través de la API para obtener notificaciones sobre eventos que suceden en tu cuenta Debi. La mayoría de los usuarios configuran webhooks desde [el panel de control](https://dashboard.debi.pro/webhooks), que proporciona una interfaz de usuario para registrar y probar los puntos finales de su webhook. type: object example: created_at: '2022-02-11T23:19:22-03:00' enabled: true enabled_events: - '*' id: WHq4VzyAzDgB livemode: true object: webhook secret: DmUeH9E9yJ7ax9IYQVm9HpQ3VWvIx0 updated_at: '2022-02-11T23:19:22-03:00' url: https://site.com/webhook properties: id: description: Identificador único del objeto. type: string example: WHA8EJ1DkDnY readOnly: true object: type: string enum: - webhook url: description: La URL del webhook. type: string example: https://debi.pro/webhook/200 maxLength: 5000 enabled: description: Declara si el webhook está habilitado. type: boolean enabled_events: description: > Uno de: `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`. type: array items: type: string properties: {} example: - customer.created - customer.updated - payment.created secret: description: >- El secreto del webhook, usado para [firmar los mensajes](https://debi.pro/docs/spa/api/#asegurando-los-webhooks). type: string example: Rrdm41mW4x54uUS2A6QnHhm7hXwpuR maxLength: 5000 failed_lately_count: type: integer format: int32 example: 0 success_lately_count: type: integer format: int32 example: 0 livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Webhook '401': description: No autorizado content: application/json: schema: properties: data: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '422': description: Datos inválidos content: application/json: example: errors: url: - El formato del campo es inválido. message: The given data was invalid. tags: - Webhooks x-codeSamples: - lang: Shell + Curl source: |- curl --request POST \ --url https://api.debi.pro/v1/webhooks \ --header 'Authorization: Bearer sk_live_...' \ --header 'content-type: application/json' \ --data '{"enabled_events":["*"],"metadata":{"some":"metadata"},"url":"string"}' - lang: Node + Request source: | const request = require('request'); const options = { method: 'POST', url: 'https://api.debi.pro/v1/webhooks', headers: { 'content-type': 'application/json', Authorization: 'Bearer sk_live_...' }, body: {enabled_events: ['*'], metadata: {some: 'metadata'}, url: 'string'}, json: true }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: >- setUrl('https://api.debi.pro/v1/webhooks'); $request->setMethod(HTTP_METH_POST); $request->setHeaders([ 'content-type' => 'application/json', 'Authorization' => 'Bearer sk_live_...' ]); $request->setBody('{"enabled_events":["*"],"metadata":{"some":"metadata"},"url":"string"}'); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/webhooks" payload = { "enabled_events": ["*"], "metadata": {"some": "metadata"}, "url": "string" } headers = { "content-type": "application/json", "Authorization": "Bearer sk_live_..." } response = requests.request("POST", url, json=payload, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.post("https://api.debi.pro/v1/webhooks") .header("content-type", "application/json") .header("Authorization", "Bearer sk_live_...") .body("{\"enabled_events\":[\"*\"],\"metadata\":{\"some\":\"metadata\"},\"url\":\"string\"}") .asString(); - lang: Ruby + Native source: >- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/webhooks") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["content-type"] = 'application/json' request["Authorization"] = 'Bearer sk_live_...' request.body = "{\"enabled_events\":[\"*\"],\"metadata\":{\"some\":\"metadata\"},\"url\":\"string\"}" response = http.request(request) puts response.read_body x-codegen-request-body-name: body /v1/webhooks/{id}: get: operationId: WebhooksGetWebhook summary: Obtener un webhook description: Obtener un webhook. parameters: - name: id in: path description: Webhook ID. required: true schema: type: string example: WHq4VzyAzDgB responses: '200': description: OK content: application/json: schema: properties: data: description: >- Puede configurar tus [webhooks](https://debi.pro/docs/webhooks/) a través de la API para obtener notificaciones sobre eventos que suceden en tu cuenta Debi. La mayoría de los usuarios configuran webhooks desde [el panel de control](https://dashboard.debi.pro/webhooks), que proporciona una interfaz de usuario para registrar y probar los puntos finales de su webhook. type: object example: created_at: '2022-02-11T23:19:22-03:00' enabled: true enabled_events: - '*' id: WHq4VzyAzDgB livemode: true object: webhook secret: DmUeH9E9yJ7ax9IYQVm9HpQ3VWvIx0 updated_at: '2022-02-11T23:19:22-03:00' url: https://site.com/webhook properties: id: description: Identificador único del objeto. type: string example: WHA8EJ1DkDnY readOnly: true object: type: string enum: - webhook url: description: La URL del webhook. type: string example: https://debi.pro/webhook/200 maxLength: 5000 enabled: description: Declara si el webhook está habilitado. type: boolean enabled_events: description: > Uno de: `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`. type: array items: type: string properties: {} example: - customer.created - customer.updated - payment.created secret: description: >- El secreto del webhook, usado para [firmar los mensajes](https://debi.pro/docs/spa/api/#asegurando-los-webhooks). type: string example: Rrdm41mW4x54uUS2A6QnHhm7hXwpuR maxLength: 5000 failed_lately_count: type: integer format: int32 example: 0 success_lately_count: type: integer format: int32 example: 0 livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Webhook '404': description: Recurso no encontrado content: application/json: schema: description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found tags: - Webhooks x-codeSamples: - lang: Shell + Curl source: |- curl --request GET \ --url https://api.debi.pro/v1/webhooks/WHq4VzyAzDgB \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'GET', url: 'https://api.debi.pro/v1/webhooks/WHq4VzyAzDgB', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/webhooks/WHq4VzyAzDgB'); $request->setMethod(HTTP_METH_GET); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: |- import requests url = "https://api.debi.pro/v1/webhooks/WHq4VzyAzDgB" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("GET", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.get("https://api.debi.pro/v1/webhooks/WHq4VzyAzDgB") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/webhooks/WHq4VzyAzDgB") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body put: operationId: WebhooksUpdateWebhook summary: Actualizar un webhook description: Actualizar un webhook. parameters: - name: id in: path description: Webhook ID. required: true schema: type: string example: WHq4VzyAzDgB requestBody: required: false content: application/json: schema: type: object properties: url: type: string example: url: http://somesite.com responses: '200': description: OK content: application/json: schema: properties: data: description: >- Puede configurar tus [webhooks](https://debi.pro/docs/webhooks/) a través de la API para obtener notificaciones sobre eventos que suceden en tu cuenta Debi. La mayoría de los usuarios configuran webhooks desde [el panel de control](https://dashboard.debi.pro/webhooks), que proporciona una interfaz de usuario para registrar y probar los puntos finales de su webhook. type: object example: created_at: '2022-02-11T23:19:22-03:00' enabled: true enabled_events: - '*' id: WHq4VzyAzDgB livemode: true object: webhook secret: DmUeH9E9yJ7ax9IYQVm9HpQ3VWvIx0 updated_at: '2022-02-11T23:19:22-03:00' url: https://site.com/webhook properties: id: description: Identificador único del objeto. type: string example: WHA8EJ1DkDnY readOnly: true object: type: string enum: - webhook url: description: La URL del webhook. type: string example: https://debi.pro/webhook/200 maxLength: 5000 enabled: description: Declara si el webhook está habilitado. type: boolean enabled_events: description: > Uno de: `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`. type: array items: type: string properties: {} example: - customer.created - customer.updated - payment.created secret: description: >- El secreto del webhook, usado para [firmar los mensajes](https://debi.pro/docs/spa/api/#asegurando-los-webhooks). type: string example: Rrdm41mW4x54uUS2A6QnHhm7hXwpuR maxLength: 5000 failed_lately_count: type: integer format: int32 example: 0 success_lately_count: type: integer format: int32 example: 0 livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Webhook '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '422': description: Datos inválidos content: application/json: example: errors: url: - El campo es obligatorio. message: The given data was invalid. tags: - Webhooks x-codeSamples: - lang: Shell + Curl source: |- curl --request PUT \ --url https://api.debi.pro/v1/webhooks/WHq4VzyAzDgB \ --header 'Authorization: Bearer sk_live_...' \ --header 'content-type: application/json' \ --data '{"url":"http://somesite.com"}' - lang: Node + Request source: | const request = require('request'); const options = { method: 'PUT', url: 'https://api.debi.pro/v1/webhooks/WHq4VzyAzDgB', headers: { 'content-type': 'application/json', Authorization: 'Bearer sk_live_...' }, body: {url: 'http://somesite.com'}, json: true }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/webhooks/WHq4VzyAzDgB'); $request->setMethod(HTTP_METH_PUT); $request->setHeaders([ 'content-type' => 'application/json', 'Authorization' => 'Bearer sk_live_...' ]); $request->setBody('{"url":"http://somesite.com"}'); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: >- import requests url = "https://api.debi.pro/v1/webhooks/WHq4VzyAzDgB" payload = {"url": "http://somesite.com"} headers = { "content-type": "application/json", "Authorization": "Bearer sk_live_..." } response = requests.request("PUT", url, json=payload, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.put("https://api.debi.pro/v1/webhooks/WHq4VzyAzDgB") .header("content-type", "application/json") .header("Authorization", "Bearer sk_live_...") .body("{\"url\":\"http://somesite.com\"}") .asString(); - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/webhooks/WHq4VzyAzDgB") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Put.new(url) request["content-type"] = 'application/json' request["Authorization"] = 'Bearer sk_live_...' request.body = "{\"url\":\"http://somesite.com\"}" response = http.request(request) puts response.read_body x-codegen-request-body-name: body delete: operationId: WebhooksDeleteWebhook summary: Borrar un webhook description: Borrar un webhook. parameters: - name: id in: path description: Webhook ID. required: true schema: type: string example: WHq4VzyAzDgB responses: '201': description: OK '401': description: No authorizado content: application/json: schema: description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado tags: - Webhooks x-codeSamples: - lang: Shell + Curl source: |- curl --request DELETE \ --url https://api.debi.pro/v1/webhooks/WHq4VzyAzDgB \ --header 'Authorization: Bearer sk_live_...' - lang: Node + Request source: | const request = require('request'); const options = { method: 'DELETE', url: 'https://api.debi.pro/v1/webhooks/WHq4VzyAzDgB', headers: {Authorization: 'Bearer sk_live_...'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); }); - lang: Php + Http1 source: |- setUrl('https://api.debi.pro/v1/webhooks/WHq4VzyAzDgB'); $request->setMethod(HTTP_METH_DELETE); $request->setHeaders([ 'Authorization' => 'Bearer sk_live_...' ]); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; } - lang: Python + Requests source: |- import requests url = "https://api.debi.pro/v1/webhooks/WHq4VzyAzDgB" headers = {"Authorization": "Bearer sk_live_..."} response = requests.request("DELETE", url, headers=headers) print(response.text) - lang: Java + Unirest source: >- HttpResponse response = Unirest.delete("https://api.debi.pro/v1/webhooks/WHq4VzyAzDgB") .header("Authorization", "Bearer sk_live_...") .asString(); - lang: Ruby + Native source: |- require 'uri' require 'net/http' require 'openssl' url = URI("https://api.debi.pro/v1/webhooks/WHq4VzyAzDgB") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Delete.new(url) request["Authorization"] = 'Bearer sk_live_...' response = http.request(request) puts response.read_body components: parameters: created_at: description: >- Un filtro en la lista, basado en el campo `created_at` del objeto. El valor puede ser un Unix Timestamp, o puede ser un diccionario con varias opciones de consulta diferentes. explode: true in: query name: created_at required: false schema: type: object properties: gt: description: Mínimo valor para filtrar (exclusivo) type: integer gte: description: Mínimo valor para filtrar (inclusivo) type: integer lt: description: Máximo valor para filtrar (exclusivo) type: integer lte: description: Máximo valor para filtrar (inclusivo) type: integer title: range_query_specs style: deepObject ending_before: name: ending_before description: >- Un cursor para utilizar en la paginación. `ending_before` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, comenzando con `obj_ID`, la próxima llamda puede incluir `ending_before=obj_ID` para obtener la página previa. in: query required: false schema: type: string style: form limit: name: limit in: query description: >- 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. required: false schema: type: integer example: 20 starting_after: name: starting_after description: >- Un cursor para utilizar en la paginación. `starting_after` es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, terminando con `obj_ID`, la próxima llamda puede incluir `starting_after=obj_ID` para obtener la página siguiente. in: query required: false schema: type: string style: form schemas: '401': description: No autorizado type: object properties: message: type: string example: Unauthorized title: No autorizado '404': description: Recurso no encontrado type: object properties: message: type: string example: Record not found title: Not Found name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' properties: {} example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' Customer: description: Este objeto representa a un cliente de su organización. type: object properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' additionalProperties: false required: - id - object - livemode - created_at - updated_at title: Cliente Links: description: Links de paginación type: object properties: first: type: - 'null' - string example: https://api.debi.pro/v1/customers last: type: - 'null' - string example: https://api.debi.pro/v1/customers next: type: - 'null' - string example: https://api.debi.pro/v1/customers prev: type: - 'null' - string example: https://api.debi.pro/v1/customers title: Metadata de Respuesta Meta: description: Metadata de paginación type: object properties: per_page: type: number example: 25 total: type: number example: 2500 path: type: string example: https://api.debi.pro/v1/customers next_cursor: description: Cursor de Paginación. type: - 'null' - string prev_cursor: description: Cursor de Paginación. type: - 'null' - string title: Response Meta id: description: Identificador único del objeto. type: string readOnly: true Card: description: Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito Sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU CBU: description: Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU CVU: description: Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb Transfer: description: Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null PaymentMethod: description: Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago delivered_at: description: > Hora en que se entregó el evento. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' Event: description: Este objeto representa un evento en tu cuenta. type: object properties: id: description: Identificador único del Evento. type: string example: EVm3RnKn3knw readOnly: true object: type: string enum: - event created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' data: type: object properties: object: description: Event object. type: object additionalProperties: true properties: {} required: - object delivered_at: description: > Hora en que se entregó el evento. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true resource: description: Recurso relacionado con el evento. type: string example: customer enum: - customer - gateway - import - mandate - payment - payment_method - subscription resource_id: description: ID del recurso relacionado con el evento. type: string example: CS12312d1d1dl type: description: Tipo de evento. type: string example: customer.created 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 title: Evento approved_at: description: > Hora en la que el gateway se marcó como aprobado. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' supported_payment_methods: description: | Medios de pago soportados por este Gateway. type: object properties: card: type: object properties: networks: type: array items: type: string enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa required_fields: type: array items: type: string enum: - expiration - security_code cbu: type: array example: card: networks: - diners - jcb - mastercard - visa required_fields: - expiration - security_code cbu: [] Gateway: description: Este objeto representa un gateway de su cuenta. type: object properties: approved_at: description: > Hora en la que el gateway se marcó como aprobado. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' code_length: description: Longitud del código type: - 'null' - number example: 8 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' disabled: description: Declara si el gateway está deshabilitado. type: boolean id: description: Identificador único del Gateway. type: string example: GWBZqKYEK7Y2 readOnly: true livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true number: description: Identificador para el procesador. type: string example: '123144' number_bank_retries: description: Número de reintentos bancarios. type: - 'null' - number example: 0 object: type: string enum: - gateway provider: description: Proveedor. type: 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 supported_payment_methods: description: | Medios de pago soportados por este Gateway. type: object example: card: networks: - diners - jcb - mastercard - visa required_fields: - expiration - security_code cbu: [] properties: card: type: object properties: networks: type: array items: type: string enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa required_fields: type: array items: type: string enum: - expiration - security_code cbu: type: array updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' username: description: Nombre de usuario actual del Gateway. type: string example: foo@bar.com title: Gateway validation-error: description: Error de Validación type: object properties: message: type: string errors: type: array items: type: string example: errors: email: - El email es inválido. message: The given data was invalid. title: Error de Validación Export: description: Objeto de exportación type: object properties: id: description: Identificador único del objeto. type: string readOnly: true object: description: Cadena que representa el tipo de objeto. type: string enum: - export type: description: El tipo de exportación type: string enum: - payments_monthly - accreditations_monthly - rejected_report - settlement_report - aggregated_rejections_report - new_customers format: description: El formato del archivo de exportación type: string enum: - csv - xlsx status: description: El estado actual de la exportación type: string enum: - pending - processing - completed - failed download_url: description: >- URL para descargar el archivo de exportación (disponible cuando el estado es completado) type: - 'null' - string format: uri file_size: description: Tamaño del archivo de exportación en bytes type: - 'null' - integer rows_count: description: Número de filas en la exportación type: - 'null' - integer error_message: description: Mensaje de error si la exportación falló type: - 'null' - string filters: description: Filtros aplicados a la exportación type: - 'null' - object livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' completed_at: description: Cuándo se completó la exportación type: - 'null' - string format: date-time required: - id - object - type - format - status - livemode - created_at - updated_at cancelled_at: description: > Hora en la que se canceló la importación. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' invalid_at: description: > Hora en la que la importación se marcó como inválida. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' processed_at: description: > Hora en la que la importación se marcó como procesada. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' ready_at: description: > Hora en la que la importación se marcó como lista. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`.type: string type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' Import: description: Este objeto representa una importación de su cuenta. type: object properties: id: description: Identificador único de la Importación. type: string example: IM129038120h readOnly: true batch_job: type: object additionalProperties: true properties: {} cancelled_at: description: > Hora en la que se canceló la importación. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' invalid_at: description: > Hora en la que la importación se marcó como inválida. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' processed_at: description: > Hora en la que la importación se marcó como procesada. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' ready_at: description: > Hora en la que la importación se marcó como lista. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`.type: string type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' invalid_rows_count: description: Cantidad de filas no válido type: number example: 0 valid_rows_count: description: Cantidad de filas válidas type: number example: 0 rows_count: description: Cantidad de filas type: number example: 0 livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true original_filename: type: string example: subscriptions-import-template.csv type: description: Tipo de importación type: string example: subscriptions status: description: Estado de importación type: string example: processed created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Importación ImportRow: description: Este objeto representa una fila de una importación de su cuenta. type: object properties: id: description: Identificador único de la Fila de Importación. type: string example: IR129038120h readOnly: true valid: description: Declara si la fila de importación es válida. type: boolean example: true data: description: Contenido de la fila de importación. type: object additionalProperties: true properties: {} livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true resource: description: Recurso relacionado con el evento. type: string example: customer enum: - customer - gateway - import - mandate - payment - payment_method - subscription resource_id: description: ID del recurso relacionado con el evento. type: string example: CS12312d1d1dl created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Fila de Importación uuid: description: Identificador UUID del objeto. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc extra_fields: description: > Una colección de campos diseñados para almacenarse como [metadatos](#section/Metadata) del objeto que la Sesión está generando, ya sea un [Pago](#tag/Payments), [Suscripción](#tag/Subscriptions) o [Adhesión](#tag/Mandates). 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. type: - object - 'null' example: - 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: description: > Una colección de campos diseñados para almacenarse como [metadatos](#section/Metadata) del [Cliente](#tag/Customers) 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. type: - object - 'null' example: - 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 binary_mode: description: > Fuerza el procesamiento instantáneo de pagos, proporcionando un estado inmediato de `approved` o `rejected` dentro de la respuesta de la solicitud. Esta configuración evita respuestas inconclusivas (como pagos con estado `submitted`) usando solo gateways que pueden procesar pagos instantáneamente, garantizando un resultado rápido y concluyente. Es particularmente útil cuando se procesan pagos en un flujo de checkout que requiere una respuesta sincrónica, permitiendo al cliente recibir instantáneamente el resultado de la transacción. También considere que este modo deshabilita los reintentos automáticos para pagos fallidos, pero este comportamiento puede ser gestionado también definiendo la cantidad máxima de veces que se puede volver a intentar el pago automáticamente estableciendo el parámetro `auto_retries_max_attempts`. type: boolean example: true payment_method_types: description: > Array de tipos de métodos de pago permitidos. Si no se especifica, se permitirán todos los métodos de pago disponibles. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Opciones de configuración para tipos específicos de métodos de pago, como no permitir ciertas redes de tarjetas o tipos de financiamiento. type: object properties: card: type: object properties: disallow: type: object properties: funding: description: Funding types to disallow type: array items: type: string enum: - credit - debit - prepaid - unknown example: - prepaid network: description: Card networks to disallow type: array items: type: string enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa example: - amex example: card: disallow: funding: - prepaid network: - amex Link: description: Este objeto representa un Link de su organización. type: object properties: id: description: Identificador único del objeto. type: string readOnly: true uuid: description: Identificador UUID del objeto. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} extra_fields: description: > Una colección de campos diseñados para almacenarse como [metadatos](#section/Metadata) del objeto que la Sesión está generando, ya sea un [Pago](#tag/Payments), [Suscripción](#tag/Subscriptions) o [Adhesión](#tag/Mandates). 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. type: - object - 'null' example: - 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: description: > Una colección de campos diseñados para almacenarse como [metadatos](#section/Metadata) del [Cliente](#tag/Customers) 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. type: - object - 'null' example: - 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: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' object: type: string enum: - link title: description: Título del enlace de pago type: string example: Monthly Subscription body: description: Descripción del enlace de pago type: string example: Subscribe to our premium service button_text: description: Texto para el botón de pago type: string example: Pay Now name_text: description: Texto para el campo de nombre type: string example: Full Name success_url: description: URL para redirigir después del pago exitoso type: string format: uri example: https://example.com/success kind: description: Tipo de enlace de pago type: string example: payment enum: - payment - subscription - mandate enabled: description: Si el enlace está habilitado type: boolean example: true smart_merge: description: Habilitar funcionalidad de fusión inteligente type: boolean example: false binary_mode: description: > Fuerza el procesamiento instantáneo de pagos, proporcionando un estado inmediato de `approved` o `rejected` dentro de la respuesta de la solicitud. Esta configuración evita respuestas inconclusivas (como pagos con estado `submitted`) usando solo gateways que pueden procesar pagos instantáneamente, garantizando un resultado rápido y concluyente. Es particularmente útil cuando se procesan pagos en un flujo de checkout que requiere una respuesta sincrónica, permitiendo al cliente recibir instantáneamente el resultado de la transacción. También considere que este modo deshabilita los reintentos automáticos para pagos fallidos, pero este comportamiento puede ser gestionado también definiendo la cantidad máxima de veces que se puede volver a intentar el pago automáticamente estableciendo el parámetro `auto_retries_max_attempts`. type: boolean example: true payment_method_types: description: > Array de tipos de métodos de pago permitidos. Si no se especifica, se permitirán todos los métodos de pago disponibles. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Opciones de configuración para tipos específicos de métodos de pago, como no permitir ciertas redes de tarjetas o tipos de financiamiento. type: object example: card: disallow: funding: - prepaid network: - amex properties: card: type: object properties: disallow: type: object properties: funding: description: Funding types to disallow type: array items: type: string enum: - credit - debit - prepaid - unknown example: - prepaid network: description: Card networks to disallow type: array items: type: string enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa example: - amex supported_payment_methods: description: >- Métodos de pago disponibles basados en la configuración del gateway del usuario type: array items: type: object example: [] readOnly: true options: description: Opciones de pago para el enlace type: array items: type: object properties: description: description: Description of this payment option type: string example: Standard Payment amount: description: Amount for this option type: number example: 100 editable_amount: description: Allow customer to set the amount type: boolean example: false example: - description: Premium Plan amount: 29.99 editable_amount: false public_uri: description: La URL pública para este enlace de pago type: string example: https://debi.pro/link/LKnJZX0DMv2Mzd4Qp6 readOnly: true title: Link Mandate: description: Este objeto representa una adhesión de su organización. type: object properties: id: description: Identificador único de la Adhesión. type: string example: MAmQ6j9NWxblNv readOnly: true status: description: Estado. type: string enum: - active - revoked uuid: description: Identificador UUID del objeto. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc object: type: string enum: - mandate livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true customer: description: Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente payment_method: description: Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' title: Adhesión amount: description: Monto. type: number example: 12.5 currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD Refund: description: Este objeto representa una devolución de su organización. type: object properties: id: description: Identificador único de la Devolución. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [ID del Pago](#tag/Pagos). type: string example: PYgaZlLaPMZO amount: description: Monto devuelto. type: number example: 12.5 currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Motivo del reembolso type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Estado del reembolso type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} title: Devolución Payment: description: Este objeto representa un pago de su organización. type: object properties: id: description: Identificador único del Pago. type: string example: PYljikas9Fa8 readOnly: true object: type: string enum: - payment amount: description: Monto del pago type: number example: 12.5 amount_refunded: description: Payment amount refunded. type: number example: 0 currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD description: description: Descripción del pago type: string example: Ajuste por deuda pasada status: description: Estado del pago type: string example: rejected enum: - pending_submission - cancelled - submitted - failed - will_retry - approved - rejected - chargeback - refunded - partially_refunded - requires_action - incomplete response_message: description: Respuesta detallada de la institución financiera type: string example: Falta de fondos rejection_code: description: Código de rechazo interno type: - 'null' - string example: null provider_rejection_code: description: Código de rechazo específico del proveedor type: - 'null' - string example: null paid: description: El pago se ha cobrado con éxito. type: boolean example: false readOnly: true retryable: description: Se puede volver a intentar el pago. type: boolean example: true readOnly: true refundable: description: El pago puede ser reembolsado. type: boolean example: false readOnly: true amount_refundable: description: El monto del pago que se puede reembolsar. type: number example: 0 livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' charge_date: description: >- Una fecha futura en la que se debe cobrar el pago. Si no se especifica, el pago se cobrará lo antes posible. type: string example: '2022-08-04' submissions_count: description: >- El número de veces que el pago ha sido enviado a la institución financiera. type: number example: 1 can_auto_retry_until: description: >- La última fecha en que se enviará el pago a la institución financiera. Nulo significa sin límite type: - 'null' - string example: '2022-08-31' auto_retries_max_attempts: description: >- El número máximo de veces que se puede volver a intentar el pago automáticamente. type: - 'null' - number example: null effective_charged_date: description: La fecha en que se cobrará el pago. type: - 'null' - string example: null estimated_accreditation_date: description: >- La fecha estimada en la que la entidad financiera enviará el monto a cobrar a tu cuenta. type: - 'null' - string example: null updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_status: description: La última fecha en que se cambió el estado del pago. type: - 'null' - string example: '2022-08-31' customer: description: Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente subscription: description: La [Suscripción](#tag/Suscripciones) asociada con el pago si existe. type: - 'null' - string example: SBmX1MrZ77Mwq3 subscription_payment_number: description: El número de pago de la Suscripción asociada, si existiera. type: - 'null' - string example: null gateway: description: El [Gateway](#tag/Gateways) asociada con el pago. type: string example: GW1L49J7ARW3 session: description: La [Sesión](#tag/Sesiones) asociada con el pago si existe. type: - 'null' - string example: SS167GrPwXyd90qQoK payment_method: description: Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago gateway_identifier: description: >- El número personalizado que envía al Gateway. En la mayoría de los casos este valor es nulo. type: - 'null' - string example: null binary_mode: description: > Fuerza el procesamiento instantáneo de pagos, proporcionando un estado inmediato de `approved` o `rejected` dentro de la respuesta de la solicitud. Esta configuración evita respuestas inconclusivas (como pagos con estado `submitted`) usando solo gateways que pueden procesar pagos instantáneamente, garantizando un resultado rápido y concluyente. Es particularmente útil cuando se procesan pagos en un flujo de checkout que requiere una respuesta sincrónica, permitiendo al cliente recibir instantáneamente el resultado de la transacción. También considere que este modo deshabilita los reintentos automáticos para pagos fallidos, pero este comportamiento puede ser gestionado también definiendo la cantidad máxima de veces que se puede volver a intentar el pago automáticamente estableciendo el parámetro `auto_retries_max_attempts`. type: boolean example: true next_action: description: Acciones adicionales requeridas para el pago type: - 'null' - object example: null recovery_link: description: URL para que el cliente recupere/reintente el pago type: string format: uri example: >- https://debi.test/session_recovery/payment?id=PYA8EJ1DkDnY&signature=... logs: description: Registros de procesamiento del pago type: array items: type: object properties: processed_at: type: string format: date-time action: type: string status: type: string response_message: type: string gateway: type: string refunds: description: Reembolsos asociados con este pago. type: array items: title: Devolución description: Este objeto representa una devolución de su organización. type: object properties: id: description: Identificador único de la Devolución. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [ID del Pago](#tag/Pagos). type: string example: PYgaZlLaPMZO amount: description: Monto devuelto. type: number example: 12.5 currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Motivo del reembolso type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Estado del reembolso type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} example: [] metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} title: Payment completed_at: description: > Hora en la que la sesión fue completada. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' Session: description: Este objeto representa una Sesión de su organización. type: object properties: id: description: Identificador único de la Sesión. type: string example: SSmQ6j9NWxblNv readOnly: true uuid: description: Identificador UUID del objeto. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc object: type: string enum: - session description: description: Descripción de la sesión type: string example: Ajuste por deuda pasada amount: description: Monto a cobrar. type: number example: 12.5 kind: type: string enum: - mandate - payment - subscription customer_id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true customer_name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro customer_email: description: El email del cliente. type: - 'null' - string example: mail@example.com customer_gateway_identifier: description: La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' editable_amount: description: >- Permita que el cliente establezca la cantidad de pagos, útil para donaciones. type: boolean installments: description: >- Solo para pagos, cantidad de pagos en los que se fraccionará el monto. type: integer max_installments: description: >- Solo para pagos, permite que el cliente elija en cuántas cuotas puede fraccionar el pago. type: integer interval_unit: description: > Sólo para suscripciones. La unidad de tiempo entre las fechas de pago del cliente. Uno de: `weekly`, `monthly` or `yearly`. Ejemplo `monthly`. type: string interval: description: >- Sólo para suscripciones. Número de `interval_unit` entre las fechas de pago del cliente. Debe ser mayor que 1. Si `interval_units` es semanal y el intervalo es 2, luego se le cobrará al cliente cada dos semanas. El valor predeterminado es 1. type: number day_of_month: description: >- Sólo para suscripciones. Día del mes, del 1 al 28. Este campo es requerido si `interval_unit` es `monthly`. El default es 1. type: number day_of_week: description: >- Sólo para suscripciones. Número del día de la semana, de 0 (Domingo) a 6 (Sábado). Este campo es obligatorio si `interval_unit` se establece en `weekly`. type: number count: type: number editable_count: type: boolean name_text: type: string created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' completed_at: description: > Hora en la que la sesión fue completada. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true binary_mode: description: > Fuerza el procesamiento instantáneo de pagos, proporcionando un estado inmediato de `approved` o `rejected` dentro de la respuesta de la solicitud. Esta configuración evita respuestas inconclusivas (como pagos con estado `submitted`) usando solo gateways que pueden procesar pagos instantáneamente, garantizando un resultado rápido y concluyente. Es particularmente útil cuando se procesan pagos en un flujo de checkout que requiere una respuesta sincrónica, permitiendo al cliente recibir instantáneamente el resultado de la transacción. También considere que este modo deshabilita los reintentos automáticos para pagos fallidos, pero este comportamiento puede ser gestionado también definiendo la cantidad máxima de veces que se puede volver a intentar el pago automáticamente estableciendo el parámetro `auto_retries_max_attempts`. type: boolean example: true payment_gateway_identifier: description: >- El número personalizado que envía al Gateway. En la mayoría de los casos este valor es nulo. type: - 'null' - string example: null public_uri: description: >- La URL de la sesión de Checkout. Redirige a tus usuario a esta URL para completar el checkout. type: string readOnly: true success_url: description: >- La URL al que se redirigirá a su cliente después de completar el pago. type: string link_id: description: Link ID. type: string example: LKLj0JV8xzdMoRk549 payment_method_types: description: > Array de tipos de métodos de pago permitidos. Si no se especifica, se permitirán todos los métodos de pago disponibles. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Opciones de configuración para tipos específicos de métodos de pago, como no permitir ciertas redes de tarjetas o tipos de financiamiento. type: object example: card: disallow: funding: - prepaid network: - amex properties: card: type: object properties: disallow: type: object properties: funding: description: Funding types to disallow type: array items: type: string enum: - credit - debit - prepaid - unknown example: - prepaid network: description: Card networks to disallow type: array items: type: string enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa example: - amex supported_payment_methods: description: >- Métodos de pago disponibles basados en la configuración del gateway del usuario type: array items: type: object example: [] readOnly: true title: Sesión Subscription: description: Este objeto representa una Suscripción de su organización. type: object properties: id: description: Identificador único de la Suscripción. type: string example: SBmQ6j9NWxblNv readOnly: true object: type: string enum: - subscription amount: description: Monto de la suscripción type: number example: 12.5 description: description: Descripción de la suscripción type: string example: Ajuste por deuda pasada currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD status: description: Estado de la suscripción type: string example: active enum: - active - paused - cancelled - finished - incomplete - incomplete_expired count: description: | El número total de pagos que debe realizar esta suscripción. type: - 'null' - number example: 12 start_date: description: >- Una fecha futura en la que el primer pago de la suscripción debe ser recogido. type: string example: '2022-08-04' interval_unit: description: La unidad de tiempo entre las fechas de pago del cliente. type: string example: monthly enum: - weekly - monthly - yearly interval: description: >- Número de `interval_unit` entre las fechas de pago del cliente. Debe ser mayor que 1. Si `interval_units` es semanal y el intervalo es 2, luego se le cobrará al cliente cada dos semanas. El valor predeterminado es 1. type: number example: 1 day_of_month: description: >- Día del mes, del 1 al 28. Este campo es obligatorio si `interval_unit` se establece en mensual. El valor predeterminado es 1. type: number day_of_week: description: >- Número del día de la semana, de 0 (Domingo) a 6 (Sábado). Este campo es obligatorio si `interval_unit` se establece en `weekly`. type: - 'null' - number livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' auto_retries_max_attempts: description: >- La cantidad máxima de veces que se pueden volver a intentar automáticamente los pagos de esta suscripción. type: - 'null' - number example: null first_date: description: >- La fecha en la que debe realizarse el primer pago. Cuando se deja en blanco y se proporciona el mes o el día del mes, se establecerá como fecha del primer pago. Si se crea sin este dato, se cobrará lo antes posible. type: string example: '2022-08-04' upcoming_dates: description: Próximas 5 fechas de pago. type: array items: type: string properties: {} example: - '2022-09-04' - '2022-10-04' - '2022-11-04' - '2022-12-04' - '2023-01-04' customer: description: Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente payment_method: description: Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} additionalProperties: false required: - id - object - amount - description - currency - status - count - start_date - interval_unit - interval - day_of_month - day_of_week - livemode - created_at - updated_at - first_date - upcoming_dates - customer - payment_method - auto_retries_max_attempts - metadata title: Suscripción first_payment_in_binary_mode: description: > Fuerza el procesamiento instantáneo del primer pago de la suscripción, proporcionando un estado inmediato de `approved` o `rejected` dentro de la respuesta de la solicitud. Esta configuración elimina los reintentos automáticos para pagos fallidos, garantizando un resultado rápido y concluyente. Cuando se establece en `true`, el pago se procesa inmediatamente. Si falla, la suscripción quedará en estado `incomplete`` y no se realizará ningún reintento automático. type: boolean example: true Webhook: description: >- Puede configurar tus [webhooks](https://debi.pro/docs/webhooks/) a través de la API para obtener notificaciones sobre eventos que suceden en tu cuenta Debi. La mayoría de los usuarios configuran webhooks desde [el panel de control](https://dashboard.debi.pro/webhooks), que proporciona una interfaz de usuario para registrar y probar los puntos finales de su webhook. type: object properties: id: description: Identificador único del objeto. type: string example: WHA8EJ1DkDnY readOnly: true object: type: string enum: - webhook url: description: La URL del webhook. type: string example: https://debi.pro/webhook/200 maxLength: 5000 enabled: description: Declara si el webhook está habilitado. type: boolean enabled_events: description: > Uno de: `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`. type: array items: type: string properties: {} example: - customer.created - customer.updated - payment.created secret: description: >- El secreto del webhook, usado para [firmar los mensajes](https://debi.pro/docs/spa/api/#asegurando-los-webhooks). type: string example: Rrdm41mW4x54uUS2A6QnHhm7hXwpuR maxLength: 5000 failed_lately_count: type: integer format: int32 example: 0 success_lately_count: type: integer format: int32 example: 0 livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' example: created_at: '2022-02-11T23:19:22-03:00' enabled: true enabled_events: - '*' id: WHq4VzyAzDgB livemode: true object: webhook secret: DmUeH9E9yJ7ax9IYQVm9HpQ3VWvIx0 updated_at: '2022-02-11T23:19:22-03:00' url: https://site.com/webhook title: Webhook api-response: description: A better exclusion of the two groups of properties, using oneOf. type: object oneOf: - properties: data: description: The matching data type: array meta: description: Any relevant metadata type: object - properties: errors: description: '' type: array customer: description: Este objeto representa a un cliente de su organización. type: object properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' additionalProperties: false required: - id - object - livemode - created_at - updated_at title: Cliente cvu: description: Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb event: description: Este objeto representa un evento en tu cuenta. type: object properties: id: description: Identificador único del Evento. type: string example: EVm3RnKn3knw readOnly: true object: type: string enum: - event created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' data: type: object properties: object: description: Event object. type: object additionalProperties: true properties: {} required: - object delivered_at: description: > Hora en que se entregó el evento. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true resource: description: Recurso relacionado con el evento. type: string example: customer enum: - customer - gateway - import - mandate - payment - payment_method - subscription resource_id: description: ID del recurso relacionado con el evento. type: string example: CS12312d1d1dl type: description: Tipo de evento. type: string example: customer.created 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 title: Evento export: description: Objeto de exportación type: object properties: id: description: Identificador único del objeto. type: string readOnly: true object: description: Cadena que representa el tipo de objeto. type: string enum: - export type: description: El tipo de exportación type: string enum: - payments_monthly - accreditations_monthly - rejected_report - settlement_report - aggregated_rejections_report - new_customers format: description: El formato del archivo de exportación type: string enum: - csv - xlsx status: description: El estado actual de la exportación type: string enum: - pending - processing - completed - failed download_url: description: >- URL para descargar el archivo de exportación (disponible cuando el estado es completado) type: - 'null' - string format: uri file_size: description: Tamaño del archivo de exportación en bytes type: - 'null' - integer rows_count: description: Número de filas en la exportación type: - 'null' - integer error_message: description: Mensaje de error si la exportación falló type: - 'null' - string filters: description: Filtros aplicados a la exportación type: - 'null' - object livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' completed_at: description: Cuándo se completó la exportación type: - 'null' - string format: date-time required: - id - object - type - format - status - livemode - created_at - updated_at gateway: description: Este objeto representa un gateway de su cuenta. type: object properties: approved_at: description: > Hora en la que el gateway se marcó como aprobado. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' code_length: description: Longitud del código type: - 'null' - number example: 8 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' disabled: description: Declara si el gateway está deshabilitado. type: boolean id: description: Identificador único del Gateway. type: string example: GWBZqKYEK7Y2 readOnly: true livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true number: description: Identificador para el procesador. type: string example: '123144' number_bank_retries: description: Número de reintentos bancarios. type: - 'null' - number example: 0 object: type: string enum: - gateway provider: description: Proveedor. type: 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 supported_payment_methods: description: | Medios de pago soportados por este Gateway. type: object example: card: networks: - diners - jcb - mastercard - visa required_fields: - expiration - security_code cbu: [] properties: card: type: object properties: networks: type: array items: type: string enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa required_fields: type: array items: type: string enum: - expiration - security_code cbu: type: array updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' username: description: Nombre de usuario actual del Gateway. type: string example: foo@bar.com title: Gateway import: description: Este objeto representa una importación de su cuenta. type: object properties: id: description: Identificador único de la Importación. type: string example: IM129038120h readOnly: true batch_job: type: object additionalProperties: true properties: {} cancelled_at: description: > Hora en la que se canceló la importación. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' invalid_at: description: > Hora en la que la importación se marcó como inválida. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' processed_at: description: > Hora en la que la importación se marcó como procesada. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' ready_at: description: > Hora en la que la importación se marcó como lista. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`.type: string type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' invalid_rows_count: description: Cantidad de filas no válido type: number example: 0 valid_rows_count: description: Cantidad de filas válidas type: number example: 0 rows_count: description: Cantidad de filas type: number example: 0 livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true original_filename: type: string example: subscriptions-import-template.csv type: description: Tipo de importación type: string example: subscriptions status: description: Estado de importación type: string example: processed created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Importación link: description: Este objeto representa un Link de su organización. type: object properties: id: description: Identificador único del objeto. type: string readOnly: true uuid: description: Identificador UUID del objeto. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} extra_fields: description: > Una colección de campos diseñados para almacenarse como [metadatos](#section/Metadata) del objeto que la Sesión está generando, ya sea un [Pago](#tag/Payments), [Suscripción](#tag/Subscriptions) o [Adhesión](#tag/Mandates). 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. type: - object - 'null' example: - 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: description: > Una colección de campos diseñados para almacenarse como [metadatos](#section/Metadata) del [Cliente](#tag/Customers) 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. type: - object - 'null' example: - 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: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' object: type: string enum: - link title: description: Título del enlace de pago type: string example: Monthly Subscription body: description: Descripción del enlace de pago type: string example: Subscribe to our premium service button_text: description: Texto para el botón de pago type: string example: Pay Now name_text: description: Texto para el campo de nombre type: string example: Full Name success_url: description: URL para redirigir después del pago exitoso type: string format: uri example: https://example.com/success kind: description: Tipo de enlace de pago type: string example: payment enum: - payment - subscription - mandate enabled: description: Si el enlace está habilitado type: boolean example: true smart_merge: description: Habilitar funcionalidad de fusión inteligente type: boolean example: false binary_mode: description: > Fuerza el procesamiento instantáneo de pagos, proporcionando un estado inmediato de `approved` o `rejected` dentro de la respuesta de la solicitud. Esta configuración evita respuestas inconclusivas (como pagos con estado `submitted`) usando solo gateways que pueden procesar pagos instantáneamente, garantizando un resultado rápido y concluyente. Es particularmente útil cuando se procesan pagos en un flujo de checkout que requiere una respuesta sincrónica, permitiendo al cliente recibir instantáneamente el resultado de la transacción. También considere que este modo deshabilita los reintentos automáticos para pagos fallidos, pero este comportamiento puede ser gestionado también definiendo la cantidad máxima de veces que se puede volver a intentar el pago automáticamente estableciendo el parámetro `auto_retries_max_attempts`. type: boolean example: true payment_method_types: description: > Array de tipos de métodos de pago permitidos. Si no se especifica, se permitirán todos los métodos de pago disponibles. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Opciones de configuración para tipos específicos de métodos de pago, como no permitir ciertas redes de tarjetas o tipos de financiamiento. type: object example: card: disallow: funding: - prepaid network: - amex properties: card: type: object properties: disallow: type: object properties: funding: description: Funding types to disallow type: array items: type: string enum: - credit - debit - prepaid - unknown example: - prepaid network: description: Card networks to disallow type: array items: type: string enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa example: - amex supported_payment_methods: description: >- Métodos de pago disponibles basados en la configuración del gateway del usuario type: array items: type: object example: [] readOnly: true options: description: Opciones de pago para el enlace type: array items: type: object properties: description: description: Description of this payment option type: string example: Standard Payment amount: description: Amount for this option type: number example: 100 editable_amount: description: Allow customer to set the amount type: boolean example: false example: - description: Premium Plan amount: 29.99 editable_amount: false public_uri: description: La URL pública para este enlace de pago type: string example: https://debi.pro/link/LKnJZX0DMv2Mzd4Qp6 readOnly: true title: Link mandate: description: Este objeto representa una adhesión de su organización. type: object properties: id: description: Identificador único de la Adhesión. type: string example: MAmQ6j9NWxblNv readOnly: true status: description: Estado. type: string enum: - active - revoked uuid: description: Identificador UUID del objeto. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc object: type: string enum: - mandate livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true customer: description: Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente payment_method: description: Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' title: Adhesión payment: description: Este objeto representa un pago de su organización. type: object properties: id: description: Identificador único del Pago. type: string example: PYljikas9Fa8 readOnly: true object: type: string enum: - payment amount: description: Monto del pago type: number example: 12.5 amount_refunded: description: Payment amount refunded. type: number example: 0 currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD description: description: Descripción del pago type: string example: Ajuste por deuda pasada status: description: Estado del pago type: string example: rejected enum: - pending_submission - cancelled - submitted - failed - will_retry - approved - rejected - chargeback - refunded - partially_refunded - requires_action - incomplete response_message: description: Respuesta detallada de la institución financiera type: string example: Falta de fondos rejection_code: description: Código de rechazo interno type: - 'null' - string example: null provider_rejection_code: description: Código de rechazo específico del proveedor type: - 'null' - string example: null paid: description: El pago se ha cobrado con éxito. type: boolean example: false readOnly: true retryable: description: Se puede volver a intentar el pago. type: boolean example: true readOnly: true refundable: description: El pago puede ser reembolsado. type: boolean example: false readOnly: true amount_refundable: description: El monto del pago que se puede reembolsar. type: number example: 0 livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' charge_date: description: >- Una fecha futura en la que se debe cobrar el pago. Si no se especifica, el pago se cobrará lo antes posible. type: string example: '2022-08-04' submissions_count: description: >- El número de veces que el pago ha sido enviado a la institución financiera. type: number example: 1 can_auto_retry_until: description: >- La última fecha en que se enviará el pago a la institución financiera. Nulo significa sin límite type: - 'null' - string example: '2022-08-31' auto_retries_max_attempts: description: >- El número máximo de veces que se puede volver a intentar el pago automáticamente. type: - 'null' - number example: null effective_charged_date: description: La fecha en que se cobrará el pago. type: - 'null' - string example: null estimated_accreditation_date: description: >- La fecha estimada en la que la entidad financiera enviará el monto a cobrar a tu cuenta. type: - 'null' - string example: null updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_status: description: La última fecha en que se cambió el estado del pago. type: - 'null' - string example: '2022-08-31' customer: description: Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente subscription: description: La [Suscripción](#tag/Suscripciones) asociada con el pago si existe. type: - 'null' - string example: SBmX1MrZ77Mwq3 subscription_payment_number: description: El número de pago de la Suscripción asociada, si existiera. type: - 'null' - string example: null gateway: description: El [Gateway](#tag/Gateways) asociada con el pago. type: string example: GW1L49J7ARW3 session: description: La [Sesión](#tag/Sesiones) asociada con el pago si existe. type: - 'null' - string example: SS167GrPwXyd90qQoK payment_method: description: Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago gateway_identifier: description: >- El número personalizado que envía al Gateway. En la mayoría de los casos este valor es nulo. type: - 'null' - string example: null binary_mode: description: > Fuerza el procesamiento instantáneo de pagos, proporcionando un estado inmediato de `approved` o `rejected` dentro de la respuesta de la solicitud. Esta configuración evita respuestas inconclusivas (como pagos con estado `submitted`) usando solo gateways que pueden procesar pagos instantáneamente, garantizando un resultado rápido y concluyente. Es particularmente útil cuando se procesan pagos en un flujo de checkout que requiere una respuesta sincrónica, permitiendo al cliente recibir instantáneamente el resultado de la transacción. También considere que este modo deshabilita los reintentos automáticos para pagos fallidos, pero este comportamiento puede ser gestionado también definiendo la cantidad máxima de veces que se puede volver a intentar el pago automáticamente estableciendo el parámetro `auto_retries_max_attempts`. type: boolean example: true next_action: description: Acciones adicionales requeridas para el pago type: - 'null' - object example: null recovery_link: description: URL para que el cliente recupere/reintente el pago type: string format: uri example: >- https://debi.test/session_recovery/payment?id=PYA8EJ1DkDnY&signature=... logs: description: Registros de procesamiento del pago type: array items: type: object properties: processed_at: type: string format: date-time action: type: string status: type: string response_message: type: string gateway: type: string refunds: description: Reembolsos asociados con este pago. type: array items: title: Devolución description: Este objeto representa una devolución de su organización. type: object properties: id: description: Identificador único de la Devolución. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [ID del Pago](#tag/Pagos). type: string example: PYgaZlLaPMZO amount: description: Monto devuelto. type: number example: 12.5 currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Motivo del reembolso type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Estado del reembolso type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} example: [] metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} title: Payment payment_method: description: Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago refund: description: Este objeto representa una devolución de su organización. type: object properties: id: description: Identificador único de la Devolución. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [ID del Pago](#tag/Pagos). type: string example: PYgaZlLaPMZO amount: description: Monto devuelto. type: number example: 12.5 currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Motivo del reembolso type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Estado del reembolso type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} title: Devolución session: description: Este objeto representa una Sesión de su organización. type: object properties: id: description: Identificador único de la Sesión. type: string example: SSmQ6j9NWxblNv readOnly: true uuid: description: Identificador UUID del objeto. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc object: type: string enum: - session description: description: Descripción de la sesión type: string example: Ajuste por deuda pasada amount: description: Monto a cobrar. type: number example: 12.5 kind: type: string enum: - mandate - payment - subscription customer_id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true customer_name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro customer_email: description: El email del cliente. type: - 'null' - string example: mail@example.com customer_gateway_identifier: description: La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' editable_amount: description: >- Permita que el cliente establezca la cantidad de pagos, útil para donaciones. type: boolean installments: description: >- Solo para pagos, cantidad de pagos en los que se fraccionará el monto. type: integer max_installments: description: >- Solo para pagos, permite que el cliente elija en cuántas cuotas puede fraccionar el pago. type: integer interval_unit: description: > Sólo para suscripciones. La unidad de tiempo entre las fechas de pago del cliente. Uno de: `weekly`, `monthly` or `yearly`. Ejemplo `monthly`. type: string interval: description: >- Sólo para suscripciones. Número de `interval_unit` entre las fechas de pago del cliente. Debe ser mayor que 1. Si `interval_units` es semanal y el intervalo es 2, luego se le cobrará al cliente cada dos semanas. El valor predeterminado es 1. type: number day_of_month: description: >- Sólo para suscripciones. Día del mes, del 1 al 28. Este campo es requerido si `interval_unit` es `monthly`. El default es 1. type: number day_of_week: description: >- Sólo para suscripciones. Número del día de la semana, de 0 (Domingo) a 6 (Sábado). Este campo es obligatorio si `interval_unit` se establece en `weekly`. type: number count: type: number editable_count: type: boolean name_text: type: string created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' completed_at: description: > Hora en la que la sesión fue completada. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true binary_mode: description: > Fuerza el procesamiento instantáneo de pagos, proporcionando un estado inmediato de `approved` o `rejected` dentro de la respuesta de la solicitud. Esta configuración evita respuestas inconclusivas (como pagos con estado `submitted`) usando solo gateways que pueden procesar pagos instantáneamente, garantizando un resultado rápido y concluyente. Es particularmente útil cuando se procesan pagos en un flujo de checkout que requiere una respuesta sincrónica, permitiendo al cliente recibir instantáneamente el resultado de la transacción. También considere que este modo deshabilita los reintentos automáticos para pagos fallidos, pero este comportamiento puede ser gestionado también definiendo la cantidad máxima de veces que se puede volver a intentar el pago automáticamente estableciendo el parámetro `auto_retries_max_attempts`. type: boolean example: true payment_gateway_identifier: description: >- El número personalizado que envía al Gateway. En la mayoría de los casos este valor es nulo. type: - 'null' - string example: null public_uri: description: >- La URL de la sesión de Checkout. Redirige a tus usuario a esta URL para completar el checkout. type: string readOnly: true success_url: description: >- La URL al que se redirigirá a su cliente después de completar el pago. type: string link_id: description: Link ID. type: string example: LKLj0JV8xzdMoRk549 payment_method_types: description: > Array de tipos de métodos de pago permitidos. Si no se especifica, se permitirán todos los métodos de pago disponibles. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Opciones de configuración para tipos específicos de métodos de pago, como no permitir ciertas redes de tarjetas o tipos de financiamiento. type: object example: card: disallow: funding: - prepaid network: - amex properties: card: type: object properties: disallow: type: object properties: funding: description: Funding types to disallow type: array items: type: string enum: - credit - debit - prepaid - unknown example: - prepaid network: description: Card networks to disallow type: array items: type: string enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa example: - amex supported_payment_methods: description: >- Métodos de pago disponibles basados en la configuración del gateway del usuario type: array items: type: object example: [] readOnly: true title: Sesión subscription: description: Este objeto representa una Suscripción de su organización. type: object properties: id: description: Identificador único de la Suscripción. type: string example: SBmQ6j9NWxblNv readOnly: true object: type: string enum: - subscription amount: description: Monto de la suscripción type: number example: 12.5 description: description: Descripción de la suscripción type: string example: Ajuste por deuda pasada currency: description: >- Moneda de la transacción usando códigos [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217). Los valores predeterminados son los predeterminados de la cuenta. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD status: description: Estado de la suscripción type: string example: active enum: - active - paused - cancelled - finished - incomplete - incomplete_expired count: description: | El número total de pagos que debe realizar esta suscripción. type: - 'null' - number example: 12 start_date: description: >- Una fecha futura en la que el primer pago de la suscripción debe ser recogido. type: string example: '2022-08-04' interval_unit: description: La unidad de tiempo entre las fechas de pago del cliente. type: string example: monthly enum: - weekly - monthly - yearly interval: description: >- Número de `interval_unit` entre las fechas de pago del cliente. Debe ser mayor que 1. Si `interval_units` es semanal y el intervalo es 2, luego se le cobrará al cliente cada dos semanas. El valor predeterminado es 1. type: number example: 1 day_of_month: description: >- Día del mes, del 1 al 28. Este campo es obligatorio si `interval_unit` se establece en mensual. El valor predeterminado es 1. type: number day_of_week: description: >- Número del día de la semana, de 0 (Domingo) a 6 (Sábado). Este campo es obligatorio si `interval_unit` se establece en `weekly`. type: - 'null' - number livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' auto_retries_max_attempts: description: >- La cantidad máxima de veces que se pueden volver a intentar automáticamente los pagos de esta suscripción. type: - 'null' - number example: null first_date: description: >- La fecha en la que debe realizarse el primer pago. Cuando se deja en blanco y se proporciona el mes o el día del mes, se establecerá como fecha del primer pago. Si se crea sin este dato, se cobrará lo antes posible. type: string example: '2022-08-04' upcoming_dates: description: Próximas 5 fechas de pago. type: array items: type: string properties: {} example: - '2022-09-04' - '2022-10-04' - '2022-11-04' - '2022-12-04' - '2023-01-04' customer: description: Este objeto representa a un cliente de su organización. type: object additionalProperties: false properties: id: description: Identificador único del Cliente. type: string example: CSljikas98 readOnly: true name: description: El nombre completo del cliente. type: - 'null' - string example: Jorgelina Castro email: description: El email del cliente. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: El número de teléfono móvil del cliente. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- El ID del método de pago predeterminado para adjuntar a este cliente al crearlo. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: La referencia del cliente en los extractos bancarios. type: - 'null' - string example: '383473' identification_number: description: Número del Documento del cliente. type: - 'null' - string example: 15.555.324 identification_type: description: Tipo de Documento del cliente. type: - 'null' - string example: DNI created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: > Hora en la que se eliminó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' required: - id - object - livemode - created_at - updated_at title: Cliente payment_method: description: Este objeto representa un Método de Pago de su cuenta. type: object properties: id: description: Identificador único del objeto. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Tipo de medio de pago. Uno de: `card`, `sepa_debit`, `cbu`, `cvu`, o `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: Este objeto representa una tarjeta de crédito de su cuenta. type: object properties: country: description: >- Tarjeta de crédito [código de país ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Mes de expiración. type: - 'null' - number example: 11 expiration_year: description: Año de expiración. type: - 'null' - number example: 2030 fingerprint: description: >- Huella digital única para este número de tarjeta de crédito de su cuenta. type: string example: 8712yh2uihiu1123sxas funding: description: Define si la tarjeta es de débito, crédito o prepaga. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Banco o entidad financiera de la tarjeta. type: - 'null' - string example: argencard last_four_digits: description: Últimos cuatro dígitos de la tarjeta. type: string example: '9876' name: description: Nombre de la tarjeta. type: string example: Visa network: description: Red de la tarjeta. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: fiserv-argentina, mercadopago, etc. type: object properties: available: description: Procesadores disponibles para esta tarjeta. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Procesador preferido para esta tarjeta. type: string example: fiserv-argentina title: Tarjeta de Crédito sepa_debit: description: >- 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). type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - NL - ES fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: Identificación extendida de la cuenta bancaria. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - santander-es preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: santander-es title: CBU cbu: description: Este objeto representa una cuenta bancaria (CBU) de su cuenta. type: object properties: bank: description: Banco. type: string country: description: País de la cuenta bancaria. type: string enum: - AR fingerprint: description: >- Huella digital única para este número de cuenta bancaria de su cuenta. type: string example: 8712yh2uihiu1123sxas identification: description: >- Identificación extendida de la cuenta bancaria. Contiene los propietarios o co propietarios de la cuenta. Para activar esta funcionalidad, contacte a Soporte. type: object last_four_digits: description: Últimos cuatro dígitos de la cuenta bancaria. type: string example: '9876' providers: description: >- Proveedores disponibles en tu cuenta que pueden ser usados para procesar este método de pago. Por ejemplo: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Procesadores disponibles para esta cuenta. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Procesador preferido para esta cuenta. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: Detalles del método de pago CVU (Clave Virtual Uniforme) type: object properties: account_number: description: El número de cuenta CVU type: string example: '0001371211179340101691' last_four_digits: description: Últimos cuatro dígitos del número de cuenta CVU type: string example: '1691' providers: description: Proveedores de pago disponibles y preferidos para este CVU type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: - bind-transfers preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: bind-transfers fingerprint: description: Identificador único para esta cuenta CVU type: string example: R1YRXJAn7SVSH8Jb transfer: description: Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- El ID del cliente al que pertenece este método de pago, si existe type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Método de pago metadata: description: > Conjunto de [pares clave/valor](#section/Metadata) 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 `nulo` en `metadatos`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} additionalProperties: false required: - id - object - amount - description - currency - status - count - start_date - interval_unit - interval - day_of_month - day_of_week - livemode - created_at - updated_at - first_date - upcoming_dates - customer - payment_method - auto_retries_max_attempts - metadata title: Suscripción transfer: description: Detalles del método de pago por transferencia bancaria type: object properties: sender_id: description: ID del remitente para la transferencia type: - 'null' - string example: null sender_name: description: Nombre del remitente para la transferencia type: - 'null' - string example: null providers: description: >- Proveedores de pago disponibles y preferidos para este método de transferencia type: object properties: available: description: Lista de proveedores disponibles type: array items: type: string example: [] preferred: description: Proveedor preferido para el procesamiento type: - 'null' - string example: null webhook: description: >- Puede configurar tus [webhooks](https://debi.pro/docs/webhooks/) a través de la API para obtener notificaciones sobre eventos que suceden en tu cuenta Debi. La mayoría de los usuarios configuran webhooks desde [el panel de control](https://dashboard.debi.pro/webhooks), que proporciona una interfaz de usuario para registrar y probar los puntos finales de su webhook. type: object properties: id: description: Identificador único del objeto. type: string example: WHA8EJ1DkDnY readOnly: true object: type: string enum: - webhook url: description: La URL del webhook. type: string example: https://debi.pro/webhook/200 maxLength: 5000 enabled: description: Declara si el webhook está habilitado. type: boolean enabled_events: description: > Uno de: `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`. type: array items: type: string properties: {} example: - customer.created - customer.updated - payment.created secret: description: >- El secreto del webhook, usado para [firmar los mensajes](https://debi.pro/docs/spa/api/#asegurando-los-webhooks). type: string example: Rrdm41mW4x54uUS2A6QnHhm7hXwpuR maxLength: 5000 failed_lately_count: type: integer format: int32 example: 0 success_lately_count: type: integer format: int32 example: 0 livemode: description: >- Tiene el valor `true` si el objeto existe en mode de producción o el valor `false` si el objeto existe en modo de prueba. type: boolean example: true created_at: description: > Hora en la que se creó el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: > Hora en la que se actualizó por última vez el objeto. Formato: [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Ejemplo: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' example: created_at: '2022-02-11T23:19:22-03:00' enabled: true enabled_events: - '*' id: WHq4VzyAzDgB livemode: true object: webhook secret: DmUeH9E9yJ7ax9IYQVm9HpQ3VWvIx0 updated_at: '2022-02-11T23:19:22-03:00' url: https://site.com/webhook title: Webhook meta: description: Metadata de paginación type: object properties: per_page: type: number example: 25 total: type: number example: 2500 path: type: string example: https://api.debi.pro/v1/customers next_cursor: description: Cursor de Paginación. type: - 'null' - string prev_cursor: description: Cursor de Paginación. type: - 'null' - string title: Response Meta links: description: Links de paginación type: object properties: first: type: - 'null' - string example: https://api.debi.pro/v1/customers last: type: - 'null' - string example: https://api.debi.pro/v1/customers next: type: - 'null' - string example: https://api.debi.pro/v1/customers prev: type: - 'null' - string example: https://api.debi.pro/v1/customers title: Metadata de Respuesta examples: customer: summary: Ejemplo de Cliente value: 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 event: summary: Ejemplo de Evento value: 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 export: summary: Export description: A sample export object value: id: EXP1234567890 object: export type: payments_monthly format: csv status: completed download_url: https://api.debi.pro/v1/exports/EXP1234567890/download file_size: 1024000 rows_count: 1500 error_message: null filters: begin_date: '2025-01-01' end_date: '2025-01-31' status: - approved - rejected livemode: false created_at: '2025-01-15T10:30:00-03:00' updated_at: '2025-01-15T10:35:00-03:00' completed_at: '2025-01-15T10:35:00-03:00' gateway: summary: Ejemplo de Gateway value: 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 import: summary: Ejemplo de Import value: 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 link: summary: Ejemplo de Link value: 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 public_uri: https://debi.pro/link/b7fba990-83cc-11ec-8c7b-5b2fd150abb2 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' preference_logo: >- https://debi-user-uploads.s3.amazonaws.com/production/e8d7c19b93dec70b352b68e16fcb066e.png mandate: summary: Ejemplo de Adhesión value: 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' payment: summary: Ejemplo de Pago value: 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: [] payment_method: summary: Ejemplo de Método de Pago value: 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' refund: summary: Ejemplo de Devolución value: id: RFOBXM90YZp4AD object: refund payment_id: PYpzMDDy4mJ3 amount: 100 currency: ARS reason: error status: approved created_at: '2022-02-05T12:24:33-03:00' updated_at: '2022-02-05T12:24:33-03:00' metadata: null session: summary: Ejemplo de Sesión value: amount: '100.00' brands: [] completed_at: null count: null created_at: '2022-02-11T23:17:54.00-03:00' customer_email: null customer_id: null customer_name: null day_of_month: null day_of_week: null deleted_at: null description: mucho editable_amount: false editable_count: false extra_fields: [] extra_fields_customer: [] id: SSnO8b9w7B51VE0B5m uuid: d6fe7bf0-8b90-11ec-9bb7-ad20fd301d81 installments: 1 interval: 1 interval_unit: monthly kind: payment link_id: b7fba990-83cc-11ec-8c7b-5b2fd150abb2 livemode: true max_installments: null name_text: null object: session public_uri: https://debi.pro/checkout/d6fe7bf0-8b90-11ec-9bb7-ad20fd301d81 updated_at: '2022-02-11T23:17:55.00-03:00' user: country: AR currency: ARS email: pedrolombardo@email.com organization_name: Debi preference_color1: '#ffffff' preference_color2: '#d10000' preference_logo: >- https://debi-user-uploads.s3.amazonaws.com/production/e8d7c19b93dec70b352b68e16fcb066e.png subscription: summary: Ejemplo de Suscripción value: id: SBmQ6j9NWxblNv object: subscription amount: 5200 description: Cuota mensual currency: ARS status: active count: null start_date: '2021-07-01' interval_unit: monthly interval: 1 day_of_month: 1 day_of_week: 1 livemode: true created_at: '2021-07-01T12:24:32-03:00' updated_at: '2021-07-01T12:24:32-03:00' first_date: '2022-09-01' upcoming_dates: - '2022-09-01' - '2022-10-01' - '2022-11-01' - '2022-12-01' - '2023-01-01' 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 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' metadata: null webhook: summary: Ejemplo de Webhook value: created_at: '2022-02-11T23:19:22-03:00' enabled: true enabled_events: - '*' id: WHq4VzyAzDgB livemode: true object: webhook secret: DmUeH9E9yJ7ax9IYQVm9HpQ3VWvIx0 updated_at: '2022-02-11T23:19:22-03:00' url: https://site.com/debi_webhook securitySchemes: PublishableKeyAuthentication: type: apiKey in: query name: key description: > Autenticación usando la [clave pública](#section/Autenticacion). Debes enviar [la clave pública](#section/Autenticacion) en el campo `key`. Para utilizar en el Browser. SecretKeyAuthentication: bearerFormat: auth-scheme scheme: bearer type: http description: > Autenticación usando la [clave secreta](#section/Autenticacion). Debes enviar [la clave secreta](#section/Autenticacion) en el header `Authorization` (usando el esquema [Bearer](https://tools.ietf.org/html/rfc6750#section-2.1)). tags: - name: Clientes description: > 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. - name: Eventos description: > 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. - name: Informes description: > Los informes te permiten generar reportes en varios formatos (CSV, Excel) para tus datos. Puedes exportar pagos, clientes y otras entidades con filtros personalizables y rangos de fechas. - name: Gateways description: > 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. - name: Importaciones description: > 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. - name: Links description: > 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. - name: Adhesiones description: > Una Adhesión es un registro del permiso que un cliente te ha dado para debitar su método de pago. - name: Métodos de Pago description: > Estos objetos representan los Métodos de Pago de su cliente. Puede usarlos para crear pagos o suscripciones a un cliente. También puede crearlos para tokenizar, validar, clasificar, identificar o futuro uso en pagos. - name: Pagos description: > 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 | | `requires_action` | El pago requiere una acción adicional del cliente | | `incomplete` | El pago está incompleto y esperando información adicional (Método de Pago) | - name: Devoluciones description: > Los objetos de devoluciones le permiten reembolsar un pago que se ha creado anteriormente pero que aún no se ha reembolsado por completo. Los fondos se reembolsarán a la tarjeta de crédito, débito o cuenta bancaria que se cargó originalmente. | Estado | Razón | | -------------------- | ---------------------------------------------------------------------------------------------- | | `pending_submission` | Se ha emitido la devolución, pero aún no se ha presentado a la entidad financiera | | `submitted` | La devolución se ha presentado correctamente y está siendo tramitada por la entidad financiera | | `failed` | Enviado OK pero rechazado por la entidad financiera | | `approved` | Enviado OK y aprobado | - name: Sesiones description: > Las sesiones te permiten utilizar las páginas de pago alojadas de Debi para configurar adhesiones, suscripciones o pagos con tus clientes. Primero, crea una sesión para su cliente y los redirige a la URL de redirección devuelta. Su adhiriente proporciona su nombre, correo electrónico, dirección y detalles de la cuenta bancaria o de la tarjeta, y envía el formulario. Esto almacena de forma segura sus detalles y los redirige a su `back_url` con `session_id=THE_SESSION_ID` en la cadena de consulta. Completada la sesión, se crea un cliente, un método de pago y un pago, una adhesión o una suscripción, y devuelve el ID de la sesión. Con estos datos es posible que desee crear una suscripción o pago en este momento. Una vez que haya completado la sesión a través de la API, debe mostrar una página de confirmación a su cliente, confirmando que se han completado todos los datos. Puede crear su propia página o redirigir a la que proporcionamos en el atributo `confirm_url` de la sesión. La sesión expira después de completarse. No puede completar una sesión vencida o ya completada. - name: Suscripciones description: > Las suscripciones permiten cobrar a un cliente de forma recurrente de acuerdo con un cronograma. | Estado | Razón | | ------------ | ---------------------------------------------------------------------------------- | | `active` | La suscripción está activa y generando pagos. | | `paused` | La suscripción se ha pausado manualmente y no generará pagos hasta que se reanude. | | `cancelled` | La suscripción se ha cancelado manualmente. | | `finished` | La suscripción está completa: todos los pagos se crearon con éxito. | | `incomplete` | La suscripción está incompleta y esperando información adicional. | - name: Webhooks description: > 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 los puntos finales de su webhook. externalDocs: description: Debi Docs. url: https://debi.pro/docs security: - SecretKeyAuthentication: []