openapi: 3.1.0 info: license: name: Proprietary url: https://debi.pro/terms title: Debi API description: > # Introduction Debi (formerly TuCuota) serves a REST API. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The base URLs for the Debi API are: - Live: https://api.debi.pro/ - Sandbox: https://api.debi-test.pro/ ### Content types Debi API supports only `JSON` content types. Make sure to include the following header on your requests. #### Content-Type Header ``` Content-Type: "application/json" ``` # Authentication The API is only available over HTTPS. Attempting to access the API over an unsecured HTTP connection will return a tls_required error. ### Get an API key To create new API keys, please visit the [developers section](https://debi.pro/dashboard/developers) of our site. For each environment (live and test) yo'll find two types of API Keys: - Publishable (`pk_...`): can be publicly-accessible in your web client-side code to tokenize payment information. - Secret (`sk_...`): To be used on the server-side. Must be secret and stored securely in your application's code to call Debi APIs. To authenticate you must provide the API key in an Authorization request header (using the Bearer authentication scheme) when making API requests. ### Example Authentication Header ``` Authorization: Bearer sk_live_... ``` All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. # Errors 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. #### Error response This API returns both, machine-readable error codes and human-readable error messages when there's an error. ##### Example ###### Validation Error ```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."] } } ``` ###### Generic Error ```json { "message": "Unauthenticated." } ``` # Idempotent Requests The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response. For example, if a request to create a payment does not respond due to a network connection error, you can retry the request with the same idempotency key to guarantee that no more than one charge is created. To perform an idempotent request, provide an additional `Idempotency-Key: ` header to the request. Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using V4 UUIDs, or another random string with enough entropy to avoid collisions. Keys are eligible to be removed from the system after they're at least 24 hours old, and a new request is generated if a key is reused after the original has been pruned. The idempotency layer compares incoming parameters to those of the original request and errors unless they're the same to prevent accidental misuse. Results are only saved if an API endpoint started executing. If incoming parameters failed validation, or the request conflicted with another that was executing concurrently, no idempotent result is saved because no API endpoint began execution. It is safe to retry these requests. All `POST` requests accept idempotency keys. Sending idempotency keys in `GET` and `DELETE` requests has no effect and should be avoided, as these requests are idempotent by definition. # Metadata The following objects have a metadata parameter that you can use this parameter to attach key-value data: - [Customer](#tag/Customers) - [Mandate](#tag/Mandates) - [Payment](#tag/Payments) - [Refund](#tag/Refunds) - [Payment Method](#tag/Payment-Methods) - [Subscription](#tag/Subscriptions) Metadata is useful for storing additional, structured information on an object. Do not store any sensitive information (bank account numbers, card details, etc.) as metadata. # Pagination All top-level API resources have support for bulk fetches via "list" API methods. For instance, you can [list payments](#tag/Payments/operation/PaymentsGetPayments), [list customers](#tag/Customers/operation/CustomersGetCustomers), and [list subscriptions](#tag/Subscriptions/operation/SubscriptionsGetSubscriptions). These list API methods share a common structure, taking at least these three parameters: `limit`, `starting_after`, and `ending_before`. The response of a list API method represents a single page in a reverse chronological stream of objects. If you do not specify `starting_after` or `ending_before`, you will receive the first page of this stream, containing the newest objects. You can specify `starting_after` equal to the object ID value of an item to retrieve the page of older objects occurring immediately after the named object in the reverse chronological stream. Similarly, you can specify `ending_before` to receive a page of newer objects occurring immediately before the named object in the stream. Objects in a page always appear in reverse chronological order. Only one of `starting_after` or `ending_before` may be used. # Request IDs Each API request has an associated request identifier. You can find this value in the response headers, under `Request-Id`. You can also find request identifiers in the URLs of individual request logs in your [Dashboard](https://debi.pro/dashboard/logs). # Conventions ### 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` # Testing payment methods and account numbers In sandbox mode the following test cards and bank accounts can be used to create payments that produce specific responses useful for testing different scenarios. | 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 | | | If you create a payment method using number `4000000320000021`, a `payment_method.automatically_updated` event will be dispatched mimicking a credit card renewal. # Webhook Notifications Webhooks are endpoints you can configure to be notified about events that happen in your Debi account. Most users configure Webhooks from the dashboard, which provides a user interface for registering and testing your webhook endpoints.
Example webhook:
```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" } ``` When an event occurs in your account, we’ll send it to every enabled webhook endpoint as a POST request. ### Webhooks types - `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` ### Testing the webhooks in local environments 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/). ### Webhooks security 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: API server - url: https://api.debi-test.pro description: Sandbox API server paths: /v1/customers: get: operationId: CustomersGetCustomers summary: List all customers description: By default newest customers will be first on the list. parameters: - name: all in: query description: Include archived records. required: false schema: type: boolean - name: created_at in: query description: >- A filter on the list, based on the object `created_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. required: false schema: type: object properties: gt: description: Minimum value to filter by (exclusive) type: integer gte: description: Minimum value to filter by (inclusive) type: integer lt: description: Maximum value to filter by (exclusive) type: integer lte: description: Maximum value to filter by (inclusive) type: integer title: range_query_specs explode: true style: deepObject - name: ending_before in: query description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. required: false schema: type: string style: form - name: limit in: query description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 25. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. required: false schema: type: string style: form responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Customer description: This object represents a customer of your organization. type: object properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Pagination links 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: Response Meta meta: description: Pagination metadata 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: Pagination Cursor. type: - 'null' - string prev_cursor: description: Pagination Cursor. 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: Unauthorized content: application/json: schema: properties: data: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized tags: - Customers 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: Create a customer description: Create a customer. 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: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com gateway_identifier: description: The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_type: description: Customer's Document type. type: - 'null' - string example: DNI identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. 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: This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer 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: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '422': description: Unprocessable Entity content: application/json: example: errors: email: - El email es inválido. message: The given data was invalid. tags: - Customers 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: Retrieve a customer description: Retrieve a customer. parameters: - name: id in: path description: | [Customer ID](#tag/Customers). required: true schema: type: string example: CS9PL8eeo8aB responses: '200': description: OK content: application/json: schema: properties: data: description: This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '404': description: Resource not found content: application/json: schema: description: Not Found response type: object properties: message: type: string example: Record not found title: Not Found tags: - Customers 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: Update a customer description: Update a customer. parameters: - name: id in: path description: | [Customer ID](#tag/Customers). 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: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com gateway_identifier: description: The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_type: description: Customer's Document type. type: - 'null' - string example: DNI identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. 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: This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '404': description: Resource not found content: application/json: schema: description: Not Found response 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: - Customers 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: Archive a customer description: Archive the customer and cancel subscriptions and payments in process. parameters: - name: id in: path description: | [Customer ID](#tag/Customers). required: true schema: type: string example: CS9PL8eeo8aB responses: '200': description: OK content: application/json: example: message: Archived successfully '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '404': description: Resource not found content: application/json: schema: description: Not Found response type: object properties: message: type: string example: Record not found title: Not Found tags: - Customers 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: Restore a customer description: Immediately restore the customer. parameters: - name: id in: path description: | [Customer ID](#tag/Customers). required: true schema: type: string example: CS9PL8eeo8aB responses: '200': description: OK content: application/json: example: message: Restored successfully '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '404': description: Resource not found content: application/json: schema: description: Not Found response type: object properties: message: type: string example: Record not found title: Not Found tags: - Customers 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: Search customers description: Search customers. parameters: - name: q in: query description: > The search query string. See [search query language](https://debi.pro/docs/docs/producto/Sistema%20de%20B%C3%BAsquedas/) and the list of supported query fields for charges. required: true schema: type: string example: john doe - name: limit in: query description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 25. required: false schema: type: integer example: 20 - name: page in: query description: > A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. required: true schema: type: string example: john doe responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Customer description: This object represents a customer of your organization. type: object properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Pagination links 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: Response Meta meta: description: Pagination metadata 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: Pagination Cursor. type: - 'null' - string prev_cursor: description: Pagination Cursor. 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: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized tags: - Customers 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: List customer's payment methods description: | Returns a list of payment methods that belong to a specific customer. parameters: - name: id in: path description: The customer ID required: true schema: type: string example: CSbJrDMEDaW9 - name: limit in: query description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 25. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. required: false schema: type: string style: form - name: ending_before in: query description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. required: false schema: type: string style: form responses: '200': description: A list of payment methods for the customer content: application/json: schema: type: object properties: object: type: string enum: - list data: type: array items: title: Payment Method description: This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: >- This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: >- Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' has_more: description: Whether there are more payment methods available 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: Customer not found content: application/json: schema: description: Not Found response type: object properties: message: type: string example: Record not found title: Not Found tags: - Customers 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: List events description: Returns a cursor-paginated list of your events. parameters: - name: delivery_success in: query description: >- Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned. required: false schema: type: boolean - name: related_object in: query description: Filters events for a single object. Can receive any ID. required: false schema: type: string maxLength: 255 example: CS9PL8eeo8aB - name: type in: query description: >- A string containing a specific event name, or group of events using `*` as a wildcard. The list will be filtered to include only events with a matching event property. required: false schema: type: string maxLength: 255 - name: created_at in: query description: >- A filter on the list, based on the object `created_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. required: false schema: type: object properties: gt: description: Minimum value to filter by (exclusive) type: integer gte: description: Minimum value to filter by (inclusive) type: integer lt: description: Maximum value to filter by (exclusive) type: integer lte: description: Maximum value to filter by (inclusive) type: integer title: range_query_specs explode: true style: deepObject - name: ending_before in: query description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. required: false schema: type: string style: form - name: limit in: query description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 25. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. 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: Event description: This object represents an event of your account. type: object properties: id: description: Unique identifier for the Event. type: string example: EVm3RnKn3knw readOnly: true object: type: string enum: - event created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: >- Time at which the event was delivered. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true resource: description: Resource attached to the event. type: string example: customer enum: - customer - gateway - import - mandate - payment - payment_method - subscription resource_id: description: ID for the resource attached to the event. type: string example: CS12312d1d1dl type: description: Event type. 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: Pagination links 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: Response Meta meta: description: Pagination metadata 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: Pagination Cursor. type: - 'null' - string prev_cursor: description: Pagination Cursor. type: - 'null' - string title: Response Meta '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized tags: - Events 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: Retrieve an event description: Retrieve an event. parameters: - name: id in: path description: | [Event ID](#tag/Events). required: true schema: type: string example: EVaX3JagwR6x responses: '200': description: OK content: application/json: schema: properties: data: description: This object represents an event of your account. type: object properties: id: description: Unique identifier for the Event. type: string example: EVm3RnKn3knw readOnly: true object: type: string enum: - event created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: >- Time at which the event was delivered. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true resource: description: Resource attached to the event. type: string example: customer enum: - customer - gateway - import - mandate - payment - payment_method - subscription resource_id: description: ID for the resource attached to the event. type: string example: CS12312d1d1dl type: description: Event type. 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: Event '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '404': description: Resource not found content: application/json: schema: description: Not Found response type: object properties: message: type: string example: Record not found title: Not Found tags: - Events 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: List Gateways description: Returns a list of all your gateways. parameters: - name: ending_before in: query description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. required: false schema: type: string style: form - name: limit in: query description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 25. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. 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: This object represents a gateway of your account. type: object properties: approved_at: description: >- Time at which the gateway was marked as approved. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' code_length: description: Code length type: - 'null' - number example: 8 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' disabled: description: Whether the gateway is disabled. type: boolean id: description: Unique identifier for the Gateway. type: string example: GWBZqKYEK7Y2 readOnly: true livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true number: description: Merchant identifier. type: string example: '123144' number_bank_retries: description: Number Bank Retries. type: - 'null' - number example: 0 object: type: string enum: - gateway provider: description: Provider. 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: Supported payment methods for this 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: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' username: description: Gateway current username. type: string example: foo@bar.com links: description: Pagination links 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: Response Meta meta: description: Pagination metadata 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: Pagination Cursor. type: - 'null' - string prev_cursor: description: Pagination Cursor. 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: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized 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: Disable a gateway description: > Disable a gateway to prevent it from processing new payments. Existing payments will continue to be processed. parameters: - name: id in: path description: The gateway ID required: true schema: type: string example: GWVwjAlbK4Z6 responses: '200': description: Gateway disabled successfully content: application/json: schema: type: object properties: message: type: string example: Enabled successfully example: message: Enabled successfully '404': description: Gateway not found content: application/json: schema: description: Not Found response 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: Validation Error 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: Enable a gateway description: > Enable a previously disabled gateway to allow it to process payments again. parameters: - name: id in: path description: The gateway ID required: true schema: type: string example: GWVwjAlbK4Z6 responses: '200': description: Gateway enabled successfully content: application/json: schema: type: object properties: message: type: string example: Disabled successfully example: message: Disabled successfully '404': description: Gateway not found content: application/json: schema: description: Not Found response 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: Validation Error 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: List all exports description: > Returns a list of exports that have been created. The exports are returned in reverse chronological order. parameters: - name: limit in: query description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 25. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. required: false schema: type: string style: form - name: ending_before in: query description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. required: false schema: type: string style: form - name: created_at in: query description: >- A filter on the list, based on the object `created_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. required: false schema: type: object properties: gt: description: Minimum value to filter by (exclusive) type: integer gte: description: Minimum value to filter by (inclusive) type: integer lt: description: Maximum value to filter by (exclusive) type: integer lte: description: Maximum value to filter by (inclusive) 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: Export object properties: id: description: Unique identifier for the object. type: string readOnly: true object: description: String representing the object's type. type: string enum: - export type: description: The type of export type: string enum: - payments_monthly - accreditations_monthly - rejected_report - settlement_report - aggregated_rejections_report - new_customers format: description: The format of the export file type: string enum: - csv - xlsx status: description: The current status of the export type: string enum: - pending - processing - completed - failed download_url: description: >- URL to download the export file (available when status is completed) type: - 'null' - string format: uri file_size: description: Size of the export file in bytes type: - 'null' - integer rows_count: description: Number of rows in the export type: - 'null' - integer error_message: description: Error message if the export failed type: - 'null' - string filters: description: Filters applied to the export type: - 'null' - object livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' completed_at: description: When the export was completed type: - 'null' - string format: date-time required: - id - object - type - format - status - livemode - created_at - updated_at links: description: Pagination links 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: Response Meta meta: description: Pagination metadata 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: Pagination Cursor. type: - 'null' - string prev_cursor: description: Pagination Cursor. type: - 'null' - string title: Response Meta required: - data '401': description: Unauthorized content: application/json: schema: properties: data: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized tags: - Exports 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: Create an export description: > Create a new export to generate reports in various formats (CSV, Excel, etc.). requestBody: required: true content: application/json: schema: type: object properties: type: description: The type of export to create type: string example: payments_monthly enum: - payments_monthly - accreditations_monthly - rejected_report - settlement_report - aggregated_rejections_report - new_customers format: description: Export format type: string default: csv enum: - csv - xlsx csv_delimiter: description: CSV delimiter (only used for CSV format) type: string default: ',' enum: - ',' - ; - '|' columns: description: Specific columns to include in the export type: array items: type: object properties: key: description: Column key type: string label: description: Column label type: string display_timezone: description: Timezone for date formatting type: string example: America/Argentina/Buenos_Aires headings: description: Whether to include column headings type: boolean default: true begin_date: description: Start date for the export (required for some export types) type: string format: date example: '2025-01-01' end_date: description: End date for the export (required for some export types) type: string format: date example: '2025-01-31' required: - type responses: '201': description: OK content: application/json: schema: properties: data: description: Export object type: object properties: id: description: Unique identifier for the object. type: string readOnly: true object: description: String representing the object's type. type: string enum: - export type: description: The type of export type: string enum: - payments_monthly - accreditations_monthly - rejected_report - settlement_report - aggregated_rejections_report - new_customers format: description: The format of the export file type: string enum: - csv - xlsx status: description: The current status of the export type: string enum: - pending - processing - completed - failed download_url: description: >- URL to download the export file (available when status is completed) type: - 'null' - string format: uri file_size: description: Size of the export file in bytes type: - 'null' - integer rows_count: description: Number of rows in the export type: - 'null' - integer error_message: description: Error message if the export failed type: - 'null' - string filters: description: Filters applied to the export type: - 'null' - object livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' completed_at: description: When the export was completed type: - 'null' - string format: date-time required: - id - object - type - format - status - livemode - created_at - updated_at '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: Validation Error tags: - Exports 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: Retrieve an export description: | Retrieves the details of an export that has been previously created. parameters: - name: id in: path description: The export ID required: true schema: type: string example: EXP123456789 responses: '200': description: Export details content: application/json: schema: properties: data: description: Export object type: object properties: id: description: Unique identifier for the object. type: string readOnly: true object: description: String representing the object's type. type: string enum: - export type: description: The type of export type: string enum: - payments_monthly - accreditations_monthly - rejected_report - settlement_report - aggregated_rejections_report - new_customers format: description: The format of the export file type: string enum: - csv - xlsx status: description: The current status of the export type: string enum: - pending - processing - completed - failed download_url: description: >- URL to download the export file (available when status is completed) type: - 'null' - string format: uri file_size: description: Size of the export file in bytes type: - 'null' - integer rows_count: description: Number of rows in the export type: - 'null' - integer error_message: description: Error message if the export failed type: - 'null' - string filters: description: Filters applied to the export type: - 'null' - object livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' completed_at: description: When the export was completed type: - 'null' - string format: date-time required: - id - object - type - format - status - livemode - created_at - updated_at '404': description: Not found content: application/json: schema: description: Not Found response type: object properties: message: type: string example: Record not found title: Not Found tags: - Exports 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: List Imports description: Returns a list of all your imports. parameters: - name: search in: query description: Search. required: false schema: type: string example: foo@bar.com - name: status in: query description: | Allowed values: `pending`, `ready`, `invalid`, `cancelled`, `processing`, `processed`. required: false schema: type: string example: ready - name: created_at in: query description: >- A filter on the list, based on the object `created_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. required: false schema: type: object properties: gt: description: Minimum value to filter by (exclusive) type: integer gte: description: Minimum value to filter by (inclusive) type: integer lt: description: Maximum value to filter by (exclusive) type: integer lte: description: Maximum value to filter by (inclusive) type: integer title: range_query_specs explode: true style: deepObject - name: ending_before in: query description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. required: false schema: type: string style: form - name: limit in: query description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 25. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. required: false schema: type: string style: form responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Import description: This object represents an import of your account. type: object properties: id: description: Unique identifier for the Import. type: string example: IM129038120h readOnly: true batch_job: type: object additionalProperties: true properties: {} cancelled_at: description: >- Time at which the import was marked as cancelled. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' invalid_at: description: >- Time at which the import was marked as invalid. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' processed_at: description: >- Time at which the import was marked as processed. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' ready_at: description: >- Time at which the import was marked as ready. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' invalid_rows_count: description: Invalid Rows Count type: number example: 0 valid_rows_count: description: Valid Rows Count type: number example: 0 rows_count: description: Rows Count type: number example: 0 livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true original_filename: type: string example: subscriptions-import-template.csv type: description: Import Type type: string example: subscriptions status: description: Import Status type: string example: processed created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' links: description: Pagination links 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: Response Meta meta: description: Pagination metadata 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: Pagination Cursor. type: - 'null' - string prev_cursor: description: Pagination Cursor. 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: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized tags: - Imports 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: Create a import description: Create a import. 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: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. 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: This object represents an import of your account. type: object properties: id: description: Unique identifier for the Import. type: string example: IM129038120h readOnly: true batch_job: type: object additionalProperties: true properties: {} cancelled_at: description: >- Time at which the import was marked as cancelled. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' invalid_at: description: >- Time at which the import was marked as invalid. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' processed_at: description: >- Time at which the import was marked as processed. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' ready_at: description: >- Time at which the import was marked as ready. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' invalid_rows_count: description: Invalid Rows Count type: number example: 0 valid_rows_count: description: Valid Rows Count type: number example: 0 rows_count: description: Rows Count type: number example: 0 livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true original_filename: type: string example: subscriptions-import-template.csv type: description: Import Type type: string example: subscriptions status: description: Import Status type: string example: processed created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Import '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '422': description: Unprocessable Entity content: application/json: example: errors: email: - El email es inválido. message: The given data was invalid. tags: - Imports 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: Retrieve a import description: Retrieve a import. 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: This object represents an import of your account. type: object properties: id: description: Unique identifier for the Import. type: string example: IM129038120h readOnly: true batch_job: type: object additionalProperties: true properties: {} cancelled_at: description: >- Time at which the import was marked as cancelled. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' invalid_at: description: >- Time at which the import was marked as invalid. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' processed_at: description: >- Time at which the import was marked as processed. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' ready_at: description: >- Time at which the import was marked as ready. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' invalid_rows_count: description: Invalid Rows Count type: number example: 0 valid_rows_count: description: Valid Rows Count type: number example: 0 rows_count: description: Rows Count type: number example: 0 livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true original_filename: type: string example: subscriptions-import-template.csv type: description: Import Type type: string example: subscriptions status: description: Import Status type: string example: processed created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Import '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '404': description: Resource not found content: application/json: schema: description: Not Found response type: object properties: message: type: string example: Record not found title: Not Found tags: - Imports 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: List Import Rows description: List Import Rows. 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: >- A filter on the list, based on the object `created_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. required: false schema: type: object properties: gt: description: Minimum value to filter by (exclusive) type: integer gte: description: Minimum value to filter by (inclusive) type: integer lt: description: Maximum value to filter by (exclusive) type: integer lte: description: Maximum value to filter by (inclusive) type: integer title: range_query_specs explode: true style: deepObject - name: ending_before in: query description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. required: false schema: type: string style: form - name: limit in: query description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 25. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. required: false schema: type: string style: form responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Import Row description: >- This object represents a row of an Import on your account. type: object properties: id: description: Unique identifier for the Import Row. type: string example: IR129038120h readOnly: true valid: description: Whether the import row is valid. type: boolean example: true data: description: Import Row content. type: object additionalProperties: true properties: {} livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true resource: description: Resource attached to the event. type: string example: customer enum: - customer - gateway - import - mandate - payment - payment_method - subscription resource_id: description: ID for the resource attached to the event. type: string example: CS12312d1d1dl created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' links: description: Pagination links 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: Response Meta meta: description: Pagination metadata 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: Pagination Cursor. type: - 'null' - string prev_cursor: description: Pagination Cursor. 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: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized tags: - Imports 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: List links description: Returns a list of all your links. parameters: - name: search in: query description: Search. required: false schema: type: string example: foo@bar.com - name: created_at in: query description: >- A filter on the list, based on the object `created_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. required: false schema: type: object properties: gt: description: Minimum value to filter by (exclusive) type: integer gte: description: Minimum value to filter by (inclusive) type: integer lt: description: Maximum value to filter by (exclusive) type: integer lte: description: Maximum value to filter by (inclusive) type: integer title: range_query_specs explode: true style: deepObject - name: ending_before in: query description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. required: false schema: type: string style: form - name: limit in: query description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 25. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. 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: >- This object represents a public link of your organization. type: object properties: id: description: Unique identifier for the object. type: string readOnly: true uuid: description: UUID identifier for the object. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} extra_fields: description: > A collection of fields designed to be stored as [the metadata](#section/Metadata) of the object that the Session is generating whether it's a [Payment](#tag/Payments), [Subscription](#tag/Subscriptions), or [Mandate](#tag/Mandates). This functionality enables you to request extra information from the user during the checkout process, providing a means to store supplementary details about the object in a well-organized format. 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: > A collection of fields designed to be stored as [the metadata](#section/Metadata) of the [Customer](#tag/Customers) that the Session is generating. This functionality enables you to request extra information from the user during the checkout process, providing a means to store supplementary details about the object in a well-organized format. 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: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Title of the payment link type: string example: Monthly Subscription body: description: Description body of the payment link type: string example: Subscribe to our premium service button_text: description: Text for the payment button type: string example: Pay Now name_text: description: Text for the name field type: string example: Full Name success_url: description: URL to redirect after successful payment type: string format: uri example: https://example.com/success kind: description: Type of payment link type: string example: payment enum: - payment - subscription - mandate enabled: description: Whether the link is enabled type: boolean example: true smart_merge: description: Enable smart merge functionality type: boolean example: false binary_mode: description: > Binary mode forces instantaneous payment processing, returning an immediate and definitive status — either approved or rejected — within the same request response. This mode prevents inconclusive responses (such as payments with status `submitted`) by using only gateways that can process payments instantly, ensuring a fast and conclusive outcome. It is particularly useful when processing payments in a checkout flow that requires a synchronous response, allowing the customer to receive instant feedback on the transaction result. Also consider that this mode disables automatic retries for rejected payments, but this behavior can be managed also defining the maximum amount of times the payment could be retried automatically by setting the `auto_retries_max_attempts` parameter. type: boolean example: true payment_method_types: description: > Array of payment method types to allow. If not specified, all available payment methods will be allowed. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Configuration options for specific payment method types, such as disallowing certain card networks or funding types. 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: >- Available payment methods based on user's gateway configuration type: array items: type: object example: [] readOnly: true options: description: Payment options for the link 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: The public URL for this payment link type: string example: https://debi.pro/link/LKnJZX0DMv2Mzd4Qp6 readOnly: true links: description: Pagination links 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: Response Meta meta: description: Pagination metadata 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: Pagination Cursor. type: - 'null' - string prev_cursor: description: Pagination Cursor. type: - 'null' - string title: Response Meta required: - data '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized 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: Create a link description: Create a link. requestBody: required: true content: application/json: schema: type: object properties: title: description: Title of the payment link type: string example: Monthly Subscription body: description: Description body of the payment link type: string example: Subscribe to our monthly service button_text: description: Text for the payment button type: string example: Pay Now name_text: description: Text for the name field type: string example: Full Name success_url: description: URL to redirect after successful payment type: string format: uri example: https://example.com/success kind: description: Type of payment link type: string example: payment enum: - payment - subscription - mandate enabled: description: Whether the link is enabled type: boolean example: true smart_merge: description: Enable smart merge functionality type: boolean example: false binary_mode: description: > Binary mode forces instantaneous payment processing, returning an immediate and definitive status — either approved or rejected — within the same request response. This mode prevents inconclusive responses (such as payments with status `submitted`) by using only gateways that can process payments instantly, ensuring a fast and conclusive outcome. It is particularly useful when processing payments in a checkout flow that requires a synchronous response, allowing the customer to receive instant feedback on the transaction result. Also consider that this mode disables automatic retries for rejected payments, but this behavior can be managed also defining the maximum amount of times the payment could be retried automatically by setting the `auto_retries_max_attempts` parameter. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} extra_fields: description: > A collection of fields designed to be stored as [the metadata](#section/Metadata) of the object that the Session is generating whether it's a [Payment](#tag/Payments), [Subscription](#tag/Subscriptions), or [Mandate](#tag/Mandates). This functionality enables you to request extra information from the user during the checkout process, providing a means to store supplementary details about the object in a well-organized format. 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: > A collection of fields designed to be stored as [the metadata](#section/Metadata) of the [Customer](#tag/Customers) that the Session is generating. This functionality enables you to request extra information from the user during the checkout process, providing a means to store supplementary details about the object in a well-organized format. 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 of payment method types to allow. If not specified, all available payment methods will be allowed. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Configuration options for specific payment method types, such as disallowing certain card networks or funding types. 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: >- Payment options for the link (required for payment and subscription kinds) 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: This object represents a public link of your organization. type: object properties: id: description: Unique identifier for the object. type: string readOnly: true uuid: description: UUID identifier for the object. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} extra_fields: description: > A collection of fields designed to be stored as [the metadata](#section/Metadata) of the object that the Session is generating whether it's a [Payment](#tag/Payments), [Subscription](#tag/Subscriptions), or [Mandate](#tag/Mandates). This functionality enables you to request extra information from the user during the checkout process, providing a means to store supplementary details about the object in a well-organized format. 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: > A collection of fields designed to be stored as [the metadata](#section/Metadata) of the [Customer](#tag/Customers) that the Session is generating. This functionality enables you to request extra information from the user during the checkout process, providing a means to store supplementary details about the object in a well-organized format. 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: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Title of the payment link type: string example: Monthly Subscription body: description: Description body of the payment link type: string example: Subscribe to our premium service button_text: description: Text for the payment button type: string example: Pay Now name_text: description: Text for the name field type: string example: Full Name success_url: description: URL to redirect after successful payment type: string format: uri example: https://example.com/success kind: description: Type of payment link type: string example: payment enum: - payment - subscription - mandate enabled: description: Whether the link is enabled type: boolean example: true smart_merge: description: Enable smart merge functionality type: boolean example: false binary_mode: description: > Binary mode forces instantaneous payment processing, returning an immediate and definitive status — either approved or rejected — within the same request response. This mode prevents inconclusive responses (such as payments with status `submitted`) by using only gateways that can process payments instantly, ensuring a fast and conclusive outcome. It is particularly useful when processing payments in a checkout flow that requires a synchronous response, allowing the customer to receive instant feedback on the transaction result. Also consider that this mode disables automatic retries for rejected payments, but this behavior can be managed also defining the maximum amount of times the payment could be retried automatically by setting the `auto_retries_max_attempts` parameter. type: boolean example: true payment_method_types: description: > Array of payment method types to allow. If not specified, all available payment methods will be allowed. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Configuration options for specific payment method types, such as disallowing certain card networks or funding types. 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: >- Available payment methods based on user's gateway configuration type: array items: type: object example: [] readOnly: true options: description: Payment options for the link 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: The public URL for this payment link type: string example: https://debi.pro/link/LKnJZX0DMv2Mzd4Qp6 readOnly: true title: Link '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized 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: Get a link description: Retrieve details of a specific payment link. parameters: - name: id in: path description: The link ID required: true schema: type: string example: LKnJZX0DMv2Mzd4Qp6 responses: '200': description: Link details content: application/json: schema: properties: data: description: This object represents a public link of your organization. type: object properties: id: description: Unique identifier for the object. type: string readOnly: true uuid: description: UUID identifier for the object. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} extra_fields: description: > A collection of fields designed to be stored as [the metadata](#section/Metadata) of the object that the Session is generating whether it's a [Payment](#tag/Payments), [Subscription](#tag/Subscriptions), or [Mandate](#tag/Mandates). This functionality enables you to request extra information from the user during the checkout process, providing a means to store supplementary details about the object in a well-organized format. 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: > A collection of fields designed to be stored as [the metadata](#section/Metadata) of the [Customer](#tag/Customers) that the Session is generating. This functionality enables you to request extra information from the user during the checkout process, providing a means to store supplementary details about the object in a well-organized format. 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: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Title of the payment link type: string example: Monthly Subscription body: description: Description body of the payment link type: string example: Subscribe to our premium service button_text: description: Text for the payment button type: string example: Pay Now name_text: description: Text for the name field type: string example: Full Name success_url: description: URL to redirect after successful payment type: string format: uri example: https://example.com/success kind: description: Type of payment link type: string example: payment enum: - payment - subscription - mandate enabled: description: Whether the link is enabled type: boolean example: true smart_merge: description: Enable smart merge functionality type: boolean example: false binary_mode: description: > Binary mode forces instantaneous payment processing, returning an immediate and definitive status — either approved or rejected — within the same request response. This mode prevents inconclusive responses (such as payments with status `submitted`) by using only gateways that can process payments instantly, ensuring a fast and conclusive outcome. It is particularly useful when processing payments in a checkout flow that requires a synchronous response, allowing the customer to receive instant feedback on the transaction result. Also consider that this mode disables automatic retries for rejected payments, but this behavior can be managed also defining the maximum amount of times the payment could be retried automatically by setting the `auto_retries_max_attempts` parameter. type: boolean example: true payment_method_types: description: > Array of payment method types to allow. If not specified, all available payment methods will be allowed. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Configuration options for specific payment method types, such as disallowing certain card networks or funding types. 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: >- Available payment methods based on user's gateway configuration type: array items: type: object example: [] readOnly: true options: description: Payment options for the link 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: The public URL for this payment link type: string example: https://debi.pro/link/LKnJZX0DMv2Mzd4Qp6 readOnly: true title: Link '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '404': description: Resource not found content: application/json: schema: description: Not Found response 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: Update a link description: >- Update an existing payment link. All fields are optional - only provide the fields you want to update. 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: Title of the payment link type: string example: Updated Monthly Subscription body: description: Description body of the payment link type: string example: Updated subscribe to our premium service button_text: description: Text for the payment button type: string example: Subscribe Now name_text: description: Text for the name field type: string example: Your Full Name success_url: description: URL to redirect after successful payment type: string format: uri example: https://example.com/updated-success kind: description: Type of payment link type: string example: subscription enum: - payment - subscription - mandate enabled: description: Whether the link is enabled type: boolean example: false smart_merge: description: Enable smart merge functionality type: boolean example: true binary_mode: description: > Binary mode forces instantaneous payment processing, returning an immediate and definitive status — either approved or rejected — within the same request response. This mode prevents inconclusive responses (such as payments with status `submitted`) by using only gateways that can process payments instantly, ensuring a fast and conclusive outcome. It is particularly useful when processing payments in a checkout flow that requires a synchronous response, allowing the customer to receive instant feedback on the transaction result. Also consider that this mode disables automatic retries for rejected payments, but this behavior can be managed also defining the maximum amount of times the payment could be retried automatically by setting the `auto_retries_max_attempts` parameter. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} extra_fields: description: > A collection of fields designed to be stored as [the metadata](#section/Metadata) of the object that the Session is generating whether it's a [Payment](#tag/Payments), [Subscription](#tag/Subscriptions), or [Mandate](#tag/Mandates). This functionality enables you to request extra information from the user during the checkout process, providing a means to store supplementary details about the object in a well-organized format. 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: > A collection of fields designed to be stored as [the metadata](#section/Metadata) of the [Customer](#tag/Customers) that the Session is generating. This functionality enables you to request extra information from the user during the checkout process, providing a means to store supplementary details about the object in a well-organized format. 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 of payment method types to allow. If not specified, all available payment methods will be allowed. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Configuration options for specific payment method types, such as disallowing certain card networks or funding types. 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: >- Payment options for the link (required for payment and subscription kinds) 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: Link updated successfully content: application/json: schema: properties: data: description: This object represents a public link of your organization. type: object properties: id: description: Unique identifier for the object. type: string readOnly: true uuid: description: UUID identifier for the object. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} extra_fields: description: > A collection of fields designed to be stored as [the metadata](#section/Metadata) of the object that the Session is generating whether it's a [Payment](#tag/Payments), [Subscription](#tag/Subscriptions), or [Mandate](#tag/Mandates). This functionality enables you to request extra information from the user during the checkout process, providing a means to store supplementary details about the object in a well-organized format. 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: > A collection of fields designed to be stored as [the metadata](#section/Metadata) of the [Customer](#tag/Customers) that the Session is generating. This functionality enables you to request extra information from the user during the checkout process, providing a means to store supplementary details about the object in a well-organized format. 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: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Title of the payment link type: string example: Monthly Subscription body: description: Description body of the payment link type: string example: Subscribe to our premium service button_text: description: Text for the payment button type: string example: Pay Now name_text: description: Text for the name field type: string example: Full Name success_url: description: URL to redirect after successful payment type: string format: uri example: https://example.com/success kind: description: Type of payment link type: string example: payment enum: - payment - subscription - mandate enabled: description: Whether the link is enabled type: boolean example: true smart_merge: description: Enable smart merge functionality type: boolean example: false binary_mode: description: > Binary mode forces instantaneous payment processing, returning an immediate and definitive status — either approved or rejected — within the same request response. This mode prevents inconclusive responses (such as payments with status `submitted`) by using only gateways that can process payments instantly, ensuring a fast and conclusive outcome. It is particularly useful when processing payments in a checkout flow that requires a synchronous response, allowing the customer to receive instant feedback on the transaction result. Also consider that this mode disables automatic retries for rejected payments, but this behavior can be managed also defining the maximum amount of times the payment could be retried automatically by setting the `auto_retries_max_attempts` parameter. type: boolean example: true payment_method_types: description: > Array of payment method types to allow. If not specified, all available payment methods will be allowed. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Configuration options for specific payment method types, such as disallowing certain card networks or funding types. 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: >- Available payment methods based on user's gateway configuration type: array items: type: object example: [] readOnly: true options: description: Payment options for the link 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: The public URL for this payment link type: string example: https://debi.pro/link/LKnJZX0DMv2Mzd4Qp6 readOnly: true title: Link '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '404': description: Resource not found content: application/json: schema: description: Not Found response 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: Validation Error 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: Delete a link description: Delete a payment link. This action cannot be undone. parameters: - name: id in: path description: The link ID required: true schema: type: string example: LKnJZX0DMv2Mzd4Qp6 responses: '202': description: Link deleted successfully '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '404': description: Resource not found content: application/json: schema: description: Not Found response 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: Send link to customers description: Send payment link notifications to specific customers via email. 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 of customer IDs to send the link to type: array items: type: string example: - CSgaZlLaPMZO - CSljikas98 - CSabcd1234 minItems: 1 required: - customers example: customers: - CSgaZlLaPMZO - CSljikas98 responses: '200': description: Link sent successfully content: application/json: schema: type: object properties: message: description: Success message with count of emails sent type: string example: Se enviarán 2 mails '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '404': description: Link or customer not found content: application/json: schema: description: Not Found response 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: Validation Error 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: List all mandates description: By default newest mandates will be first on the list. parameters: - name: all in: query description: Include archived mandates. required: false schema: type: boolean - name: customer_id in: query description: | [Customer ID](#tag/Customers). schema: type: string example: CS9PL8eeo8aB - name: created_at in: query description: >- A filter on the list, based on the object `created_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. required: false schema: type: object properties: gt: description: Minimum value to filter by (exclusive) type: integer gte: description: Minimum value to filter by (inclusive) type: integer lt: description: Maximum value to filter by (exclusive) type: integer lte: description: Maximum value to filter by (inclusive) type: integer title: range_query_specs explode: true style: deepObject - name: ending_before in: query description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. required: false schema: type: string style: form - name: limit in: query description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 25. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. required: false schema: type: string style: form responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Mandate description: This object represents a mandate of your organization. type: object properties: id: description: Unique identifier for the Mandate. type: string example: MAmQ6j9NWxblNv readOnly: true status: description: Status. type: string enum: - active - revoked uuid: description: UUID identifier for the object. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc object: type: string enum: - mandate livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true customer: description: >- This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer payment_method: description: >- This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: >- This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: >- Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' links: description: Pagination links 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: Response Meta meta: description: Pagination metadata 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: Pagination Cursor. type: - 'null' - string prev_cursor: description: Pagination Cursor. type: - 'null' - string title: Response Meta required: - data '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized tags: - Mandates 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: Create a mandate description: Create a mandate. requestBody: required: false content: application/json: schema: type: object properties: customer_id: description: | [Customer ID](#tag/Customers). type: string example: CSgaZlLaPMZO. payment_method_id: description: | [Payment Method ID](#tag/Payment-Methods). 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: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized tags: - Mandates 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: Retrieve a mandate description: Retrieve a mandate. parameters: - name: id in: path description: | [Mandate ID](#tag/Mandates). required: true schema: type: string example: MA9aQOWen2kZe6qypB responses: '200': description: OK content: application/json: schema: properties: data: description: This object represents a mandate of your organization. type: object properties: id: description: Unique identifier for the Mandate. type: string example: MAmQ6j9NWxblNv readOnly: true status: description: Status. type: string enum: - active - revoked uuid: description: UUID identifier for the object. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc object: type: string enum: - mandate livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true customer: description: >- This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer payment_method: description: >- This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: >- This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: >- Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' title: Mandate '401': description: Unauthorized content: application/json: schema: properties: data: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '404': description: Resource not found content: application/json: schema: description: Not Found response type: object properties: message: type: string example: Record not found title: Not Found tags: - Mandates 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: Revoke a mandate description: >- This action will revoke the mandate and also cancel all the cancellable subscriptions attached to the same `customer` and `payment method`. parameters: - name: id in: path description: | [Mandate ID](#tag/Mandates). required: true schema: type: string example: MA9aQOWen2kZe6qypB responses: '202': description: Mandate revoked '401': description: Unauthorized content: application/json: schema: properties: data: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized tags: - Mandates 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: Restore mandate description: This action will restore the revoked mandate. parameters: - name: id in: path description: | [Mandate ID](#tag/Mandates). required: true schema: type: string example: MA9aQOWen2kZe6qypB responses: '202': description: Mandate restored '401': description: Unauthorized content: application/json: schema: properties: data: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized tags: - Mandates 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: Search mandates description: Search mandates. parameters: - name: q in: query description: > The search query string. See [search query language](https://debi.pro/docs/docs/producto/Sistema%20de%20B%C3%BAsquedas/) and the list of supported query fields for charges. required: true schema: type: string example: john doe - name: limit in: query description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 25. required: false schema: type: integer example: 20 - name: page in: query description: > A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. required: true schema: type: string example: john doe responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Mandate description: This object represents a mandate of your organization. type: object properties: id: description: Unique identifier for the Mandate. type: string example: MAmQ6j9NWxblNv readOnly: true status: description: Status. type: string enum: - active - revoked uuid: description: UUID identifier for the object. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc object: type: string enum: - mandate livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true customer: description: >- This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer payment_method: description: >- This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: >- This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: >- Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' links: description: Pagination links 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: Response Meta meta: description: Pagination metadata 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: Pagination Cursor. type: - 'null' - string prev_cursor: description: Pagination Cursor. 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: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized tags: - Mandates 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: List all payment methods description: Returns a list of payment methods. parameters: - name: page in: query description: Cursor value to paginate response. required: false schema: type: number example: 1 - name: limit in: query description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 25. required: false schema: type: integer example: 20 responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Payment Method description: This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: >- This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: >- Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' links: description: Pagination links 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: Response Meta meta: description: Pagination metadata 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: Pagination Cursor. type: - 'null' - string prev_cursor: description: Pagination Cursor. 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: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized tags: - Payment Methods 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: >- Create a payment method (for validation,classification, identification or future use on payments) description: > Creating a payment method allows you to tokenize the payment method, validate that it meets validation rules, and use it in future payments. It also allows us to classify it based on its properties to make business decisions. Additionally, for payment method type `cbu`, adding the identification parameter with the value `true`, we can identify the bank account to determine its owners, or send an alias to determine its corresponding CBU and its owners. In the case of business accounts, the object created will contain an array with the corresponding co-owners. If you send an `alias` parameter in the payload, you don't need to indicate the CBU number, and as a response you will receive the CBU corresponding to that alias. requestBody: required: false content: application/json: schema: type: object properties: type: description: One of `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string enum: - card - sepa_debit - cbu - cvu - transfer card: description: This object represents a card of your account. type: object properties: number: description: Card number. type: string expiration_year: description: Card expiration year. type: number expiration_month: description: Card expiration month. type: number security_code: description: >- Card security code. It is highly recommended to always include this value. type: string title: Card cbu: description: This object represents a CBU bank account of your account. type: object properties: number: description: > Bank account number called `CBU` in Argentina (22 digits). If `identification` is `true`, requires sending the `secret key` in the header of the request, otherwise with public key is enough (useful when creating payment methods from the browser). `Required` if you don't send an `alias` in the payload. If you send the `alias` in the POST and the identification is `true`, you don't need to indicate the `cbu` number, and as a response you will receive the `cbu` number corresponding to that `alias`. type: string alias: description: >- Requires sending the `secret key` in the header of the request. Bank account `alias` that you want to identify. If you send the `alias` in the POST and the parameter `identification` is `true`, it will return the corresponding `cbu`number. Available upon request, contact Support. type: string example: juanperez identification: description: >- Requires sending the `secret key` in the header of the request. Enhanced bank account identification, when sending in the POST, it will perform the identification, returning in this parameter the owners or co-owners of the account. Also if you send an `alias` in the payload, you don't need to indicate the `cbu` number, and as a response you will receive the CBU corresponding to that alias. Available upon request, contact Support. type: boolean title: CBU sepa_debit: description: >- This object represents a direct debit to a IBAN account for the SEPA Region. type: object properties: iban: description: International Bank account code IBAN type: string title: Sepa Debit (Iban) cvu: description: >- This object represents a CVU (Clave Virtual Uniforme) account. type: object properties: {} title: CVU transfer: description: This object represents a bank transfer payment method. type: object properties: sender_name: description: Name of the person or entity making the transfer. type: string sender_id: description: >- Identification number of the person or entity making the transfer. type: string title: Transfer strict: description: >- If true, the payment_method won't be created if the account doesn't have an available gateway to process this type of payment_method. type: boolean examples: card-basic: summary: Card - Basic value: type: card card: number: '4242424242424242' card-complete: summary: Card - Complete with Expiration and Security Code value: type: card card: number: '4242424242424242' expiration_year: 2035 expiration_month: 12 security_code: '123' cbu-alias: summary: CBU - Using Alias with Identification value: type: cbu cbu: alias: juanperez identification: true cbu-number: summary: CBU - Using Account Number with Identification value: type: cbu cbu: number: '2859363672283668188432' identification: true sepa_debit: summary: SEPA Debit - IBAN Account value: type: sepa_debit sepa_debit: iban: ES9121000418450200051332 transfer: summary: Transfer - With Sender Information value: type: transfer transfer: sender_name: Juan Perez sender_id: '1234567890' cvu: summary: CVU - Basic value: type: cvu responses: '201': description: Payment Method Created content: application/json: schema: properties: data: description: This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: >- This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: >- Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method examples: card: summary: Credit Card 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: SEPA Debit Payment Method for Iban Accounts 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: CBU Bank Account 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: CBU Bank Account with Enhanced Identification 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: CVU Account 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: Transfer Payment Method 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: Unauthorized content: application/json: schema: properties: data: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '422': description: Unprocessable Entity 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: - Payment Methods 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: Retrieve a payment method description: Retrieve a payment method. parameters: - name: id in: path description: Payment method ID. required: true schema: type: string example: PMVA0W8y1aQO responses: '200': description: Retrieve a payment method content: application/json: schema: properties: data: description: This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: >- This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: >- Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method examples: card-basic: summary: Card - Basic value: type: card card: number: '4242424242424242' card-complete: summary: Card - Complete with Expiration and Security Code value: type: card card: number: '4242424242424242' expiration_year: 2035 expiration_month: 12 security_code: '123' cbu-alias: summary: CBU - Using Alias with Identification value: type: cbu cbu: alias: juanperez identification: true cbu-number: summary: CBU - Using Account Number with Identification value: type: cbu cbu: number: '2859363672283668188432' identification: true sepa_debit: summary: SEPA Debit - IBAN Account value: type: sepa_debit sepa_debit: iban: ES9121000418450200051332 transfer: summary: Transfer - With Sender Information value: type: transfer transfer: sender_name: Juan Perez sender_id: '1234567890' cvu: summary: CVU - Basic value: type: cvu '401': description: Unauthorized content: application/json: schema: properties: data: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '404': description: Payment method not found content: application/json: schema: properties: data: description: Not Found response type: object properties: message: type: string example: Record not found title: Not Found tags: - Payment Methods 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: Search payment methods description: Search payment methods. parameters: - name: q in: query description: > The search query string. See [search query language](https://debi.pro/docs/docs/producto/Sistema%20de%20B%C3%BAsquedas/) and the list of supported query fields for charges. required: true schema: type: string example: john doe - name: limit in: query description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 25. required: false schema: type: integer example: 20 - name: page in: query description: > A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. 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 Method description: This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: >- This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: >- Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' links: description: Pagination links 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: Response Meta meta: description: Pagination metadata 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: Pagination Cursor. type: - 'null' - string prev_cursor: description: Pagination Cursor. 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: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized tags: - Payment Methods 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: Attach payment method to customer description: > Attach a payment method to a customer. This allows the payment method to be used for future payments for this customer. parameters: - name: id in: path description: The payment method ID required: true schema: type: string example: PMrLnDA9D6oQ requestBody: required: true content: application/json: schema: type: object properties: customer: description: The customer ID to attach the payment method to type: string example: CSbJrDMEDaW9 required: - customer responses: '204': description: Payment method attached successfully content: {} '404': description: Payment method or customer not found content: application/json: schema: description: Not Found response 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: Validation Error tags: - Payment Methods 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: Detach payment method from customer description: > Detach a payment method from a customer. This removes the association between the payment method and the customer. parameters: - name: id in: path description: The payment method ID required: true schema: type: string example: PMrLnDA9D6oQ responses: '204': description: Payment method detached successfully content: {} '404': description: Payment method not found content: application/json: schema: description: Not Found response type: object properties: message: type: string example: Record not found title: Not Found tags: - Payment Methods 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: List payments description: Newest payments will be first on the list. parameters: - name: customer_id in: query description: Show only payment methods from a given customer. required: false schema: type: string example: CS9PL8eeo8aB - name: subscription_id in: query description: Show only payment methods from a given subscription. required: false schema: type: string example: SBmX1MrZ77Mwq3 - name: created_at in: query description: >- A filter on the list, based on the object `created_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. required: false schema: type: object properties: gt: description: Minimum value to filter by (exclusive) type: integer gte: description: Minimum value to filter by (inclusive) type: integer lt: description: Maximum value to filter by (exclusive) type: integer lte: description: Maximum value to filter by (inclusive) type: integer title: range_query_specs explode: true style: deepObject - name: ending_before in: query description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. required: false schema: type: string style: form - name: limit in: query description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 25. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. 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: This object represents a payments of your organization. type: object properties: id: description: Unique identifier for the Payment. type: string example: PYljikas9Fa8 readOnly: true object: type: string enum: - payment amount: description: Payment amount type: number example: 12.5 amount_refunded: description: Payment amount refunded. type: number example: 0 currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD description: description: Payment description type: string example: Ajuste por deuda pasada status: description: Payment Status type: string example: rejected enum: - pending_submission - cancelled - submitted - failed - will_retry - approved - rejected - chargeback - refunded - partially_refunded - requires_action - incomplete response_message: description: Financial institution detailed response type: string example: Falta de fondos rejection_code: description: Internal rejection code type: - 'null' - string example: null provider_rejection_code: description: Provider-specific rejection code type: - 'null' - string example: null paid: description: The payment has been succesfully collected. type: boolean example: false readOnly: true retryable: description: The payment can be retried. type: boolean example: true readOnly: true refundable: description: The payment can be refunded. type: boolean example: false readOnly: true amount_refundable: description: The amount of payment that can be refunded. type: number example: 0 livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' charge_date: description: >- A future date on which the payment should be collected. If not specified, the payment will be collected as soon as possible. type: string example: '2022-08-04' submissions_count: description: >- The number of time the payment has been sent to the financial institution. type: number example: 1 can_auto_retry_until: description: >- The latest date the payment will be sent to the financial institution. Null means no limit type: - 'null' - string example: '2022-08-31' auto_retries_max_attempts: description: >- The maximum number of times the payment could be automatically retried. type: - 'null' - number example: null effective_charged_date: description: The date when the payment will be collected. type: - 'null' - string example: null estimated_accreditation_date: description: >- The estimated date when the financial institution will send the amount collect to your account. type: - 'null' - string example: null updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_status: description: The latest date the payment status was changed. type: - 'null' - string example: '2022-08-31' customer: description: >- This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer subscription: description: >- The [Subscription](#tag/Subscriptions) associated with the payment if existent. type: - 'null' - string example: SBmX1MrZ77Mwq3 subscription_payment_number: description: >- The number of payment of the associated Subscription, if existent. type: - 'null' - string example: null gateway: description: >- The [Gateway](#tag/Gateways) associated with the payment. type: string example: GW1L49J7ARW3 session: description: >- The [Session](#tag/Sessions) associated with the payment if existent. type: - 'null' - string example: SS167GrPwXyd90qQoK payment_method: description: >- This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: >- This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: >- Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method gateway_identifier: description: >- The custom number you send to the gateway network. In most cases this value is null. type: - 'null' - string example: null binary_mode: description: > Binary mode forces instantaneous payment processing, returning an immediate and definitive status — either approved or rejected — within the same request response. This mode prevents inconclusive responses (such as payments with status `submitted`) by using only gateways that can process payments instantly, ensuring a fast and conclusive outcome. It is particularly useful when processing payments in a checkout flow that requires a synchronous response, allowing the customer to receive instant feedback on the transaction result. Also consider that this mode disables automatic retries for rejected payments, but this behavior can be managed also defining the maximum amount of times the payment could be retried automatically by setting the `auto_retries_max_attempts` parameter. type: boolean example: true next_action: description: Additional actions required for the payment type: - 'null' - object example: null recovery_link: description: URL for customer to recover/retry the payment type: string format: uri example: >- https://debi.test/session_recovery/payment?id=PYA8EJ1DkDnY&signature=... logs: description: Payment processing logs 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: Refunds associated with this payment. type: array items: title: Refund description: >- This object represents a refunds of your organization. type: object properties: id: description: Unique identifier for the Refund. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [Payment ID](#tag/Payments). type: string example: PYgaZlLaPMZO amount: description: Refund amount. type: number example: 12.5 currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Refund Reason type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Refund Status type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} example: [] metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} links: description: Pagination links 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: Response Meta meta: description: Pagination metadata 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: Pagination Cursor. type: - 'null' - string prev_cursor: description: Pagination Cursor. type: - 'null' - string title: Response Meta required: - data '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized tags: - Payments 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: Create a payment description: Create a payment. requestBody: required: true content: application/json: schema: type: object properties: amount: description: The amount of the payment. type: number description: description: The description of the payment. type: string customer_id: description: | [Customer ID](#tag/Customers). type: string example: CSgaZlLaPMZO. payment_method_id: description: > The [Payment Method ID](#tag/Payment-Methods) for this payment. If you don't send this parameter, the payment will be collected using the default payment method for the customer. If the customer doesn't have a default payment method, the payment will stay in status `incomplete`, until it is updated via session, billing portal, or API. type: string example: PMBja4YZ2GDR. charge_date: description: >- A future or present date on which the payment should be collected (Should be today or a future date). If not specified, the payment will be collected as soon as possible. type: string format: date can_auto_retry_until: description: >- The maximum date the payment could be retried automatically. If null, will apply the default value for the user. type: string format: date auto_retries_max_attempts: description: >- The maximum amount of times the payment could be retried automatically. If null, will apply the default value for the user. type: integer gateway_identifier: description: >- Gateway identifier for your payment. This value is used to identify the payment in the gateway. Sometimes gateways show this value as a descriptor in bank statements. If you don't send this parameter, the gateway will generate a random identifier. This value is not updatable once the payment is created. type: string binary_mode: description: > Binary mode forces instantaneous payment processing, returning an immediate and definitive status — either approved or rejected — within the same request response. This mode prevents inconclusive responses (such as payments with status `submitted`) by using only gateways that can process payments instantly, ensuring a fast and conclusive outcome. It is particularly useful when processing payments in a checkout flow that requires a synchronous response, allowing the customer to receive instant feedback on the transaction result. Also consider that this mode disables automatic retries for rejected payments, but this behavior can be managed also defining the maximum amount of times the payment could be retried automatically by setting the `auto_retries_max_attempts` parameter. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. 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: This object represents a payments of your organization. type: object properties: id: description: Unique identifier for the Payment. type: string example: PYljikas9Fa8 readOnly: true object: type: string enum: - payment amount: description: Payment amount type: number example: 12.5 amount_refunded: description: Payment amount refunded. type: number example: 0 currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD description: description: Payment description type: string example: Ajuste por deuda pasada status: description: Payment Status type: string example: rejected enum: - pending_submission - cancelled - submitted - failed - will_retry - approved - rejected - chargeback - refunded - partially_refunded - requires_action - incomplete response_message: description: Financial institution detailed response type: string example: Falta de fondos rejection_code: description: Internal rejection code type: - 'null' - string example: null provider_rejection_code: description: Provider-specific rejection code type: - 'null' - string example: null paid: description: The payment has been succesfully collected. type: boolean example: false readOnly: true retryable: description: The payment can be retried. type: boolean example: true readOnly: true refundable: description: The payment can be refunded. type: boolean example: false readOnly: true amount_refundable: description: The amount of payment that can be refunded. type: number example: 0 livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' charge_date: description: >- A future date on which the payment should be collected. If not specified, the payment will be collected as soon as possible. type: string example: '2022-08-04' submissions_count: description: >- The number of time the payment has been sent to the financial institution. type: number example: 1 can_auto_retry_until: description: >- The latest date the payment will be sent to the financial institution. Null means no limit type: - 'null' - string example: '2022-08-31' auto_retries_max_attempts: description: >- The maximum number of times the payment could be automatically retried. type: - 'null' - number example: null effective_charged_date: description: The date when the payment will be collected. type: - 'null' - string example: null estimated_accreditation_date: description: >- The estimated date when the financial institution will send the amount collect to your account. type: - 'null' - string example: null updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_status: description: The latest date the payment status was changed. type: - 'null' - string example: '2022-08-31' customer: description: >- This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer subscription: description: >- The [Subscription](#tag/Subscriptions) associated with the payment if existent. type: - 'null' - string example: SBmX1MrZ77Mwq3 subscription_payment_number: description: >- The number of payment of the associated Subscription, if existent. type: - 'null' - string example: null gateway: description: >- The [Gateway](#tag/Gateways) associated with the payment. type: string example: GW1L49J7ARW3 session: description: >- The [Session](#tag/Sessions) associated with the payment if existent. type: - 'null' - string example: SS167GrPwXyd90qQoK payment_method: description: >- This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: >- This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: >- Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method gateway_identifier: description: >- The custom number you send to the gateway network. In most cases this value is null. type: - 'null' - string example: null binary_mode: description: > Binary mode forces instantaneous payment processing, returning an immediate and definitive status — either approved or rejected — within the same request response. This mode prevents inconclusive responses (such as payments with status `submitted`) by using only gateways that can process payments instantly, ensuring a fast and conclusive outcome. It is particularly useful when processing payments in a checkout flow that requires a synchronous response, allowing the customer to receive instant feedback on the transaction result. Also consider that this mode disables automatic retries for rejected payments, but this behavior can be managed also defining the maximum amount of times the payment could be retried automatically by setting the `auto_retries_max_attempts` parameter. type: boolean example: true next_action: description: Additional actions required for the payment type: - 'null' - object example: null recovery_link: description: URL for customer to recover/retry the payment type: string format: uri example: >- https://debi.test/session_recovery/payment?id=PYA8EJ1DkDnY&signature=... logs: description: Payment processing logs 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: Refunds associated with this payment. type: array items: title: Refund description: >- This object represents a refunds of your organization. type: object properties: id: description: Unique identifier for the Refund. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [Payment ID](#tag/Payments). type: string example: PYgaZlLaPMZO amount: description: Refund amount. type: number example: 12.5 currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Refund Reason type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Refund Status type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} example: [] metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} title: Payment '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized tags: - Payments 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: Retrieve a payment description: Retrieve a payment. parameters: - name: id in: path description: | [Payment ID](#tag/Payments). required: true schema: type: string example: PYdOz9bgVReV responses: '200': description: Retrieve a payment. content: application/json: schema: properties: data: description: This object represents a payments of your organization. type: object properties: id: description: Unique identifier for the Payment. type: string example: PYljikas9Fa8 readOnly: true object: type: string enum: - payment amount: description: Payment amount type: number example: 12.5 amount_refunded: description: Payment amount refunded. type: number example: 0 currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD description: description: Payment description type: string example: Ajuste por deuda pasada status: description: Payment Status type: string example: rejected enum: - pending_submission - cancelled - submitted - failed - will_retry - approved - rejected - chargeback - refunded - partially_refunded - requires_action - incomplete response_message: description: Financial institution detailed response type: string example: Falta de fondos rejection_code: description: Internal rejection code type: - 'null' - string example: null provider_rejection_code: description: Provider-specific rejection code type: - 'null' - string example: null paid: description: The payment has been succesfully collected. type: boolean example: false readOnly: true retryable: description: The payment can be retried. type: boolean example: true readOnly: true refundable: description: The payment can be refunded. type: boolean example: false readOnly: true amount_refundable: description: The amount of payment that can be refunded. type: number example: 0 livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' charge_date: description: >- A future date on which the payment should be collected. If not specified, the payment will be collected as soon as possible. type: string example: '2022-08-04' submissions_count: description: >- The number of time the payment has been sent to the financial institution. type: number example: 1 can_auto_retry_until: description: >- The latest date the payment will be sent to the financial institution. Null means no limit type: - 'null' - string example: '2022-08-31' auto_retries_max_attempts: description: >- The maximum number of times the payment could be automatically retried. type: - 'null' - number example: null effective_charged_date: description: The date when the payment will be collected. type: - 'null' - string example: null estimated_accreditation_date: description: >- The estimated date when the financial institution will send the amount collect to your account. type: - 'null' - string example: null updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_status: description: The latest date the payment status was changed. type: - 'null' - string example: '2022-08-31' customer: description: >- This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer subscription: description: >- The [Subscription](#tag/Subscriptions) associated with the payment if existent. type: - 'null' - string example: SBmX1MrZ77Mwq3 subscription_payment_number: description: >- The number of payment of the associated Subscription, if existent. type: - 'null' - string example: null gateway: description: >- The [Gateway](#tag/Gateways) associated with the payment. type: string example: GW1L49J7ARW3 session: description: >- The [Session](#tag/Sessions) associated with the payment if existent. type: - 'null' - string example: SS167GrPwXyd90qQoK payment_method: description: >- This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: >- This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: >- Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method gateway_identifier: description: >- The custom number you send to the gateway network. In most cases this value is null. type: - 'null' - string example: null binary_mode: description: > Binary mode forces instantaneous payment processing, returning an immediate and definitive status — either approved or rejected — within the same request response. This mode prevents inconclusive responses (such as payments with status `submitted`) by using only gateways that can process payments instantly, ensuring a fast and conclusive outcome. It is particularly useful when processing payments in a checkout flow that requires a synchronous response, allowing the customer to receive instant feedback on the transaction result. Also consider that this mode disables automatic retries for rejected payments, but this behavior can be managed also defining the maximum amount of times the payment could be retried automatically by setting the `auto_retries_max_attempts` parameter. type: boolean example: true next_action: description: Additional actions required for the payment type: - 'null' - object example: null recovery_link: description: URL for customer to recover/retry the payment type: string format: uri example: >- https://debi.test/session_recovery/payment?id=PYA8EJ1DkDnY&signature=... logs: description: Payment processing logs 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: Refunds associated with this payment. type: array items: title: Refund description: >- This object represents a refunds of your organization. type: object properties: id: description: Unique identifier for the Refund. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [Payment ID](#tag/Payments). type: string example: PYgaZlLaPMZO amount: description: Refund amount. type: number example: 12.5 currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Refund Reason type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Refund Status type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} example: [] metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} title: Payment '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '404': description: Payment not found content: application/json: schema: properties: data: description: Not Found response type: object properties: message: type: string example: Record not found title: Not Found tags: - Payments 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: Update a payment description: Update a payment. parameters: - name: id in: path description: | [Payment ID](#tag/Payments). required: true schema: type: string example: PYdOz9bgVReV requestBody: required: true content: application/json: schema: type: object properties: amount: description: The new amount of the payment. type: number auto_retries_max_attempts: description: >- The maximum amount of times the payment could be retried automatically. type: integer can_auto_retry_until: description: The maximum date the payment could be retried automatically. type: string format: date charge_date: description: A future date on which the payment should be collected. type: string format: date description: description: The new description of the payment. type: string payment_method_id: description: > The [Payment Method ID](#tag/Payment-Methods) for this payment. type: string example: PMBja4YZ2GDR. metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} example: description: New payment title responses: '200': description: Payment updated content: application/json: schema: properties: data: description: This object represents a payments of your organization. type: object properties: id: description: Unique identifier for the Payment. type: string example: PYljikas9Fa8 readOnly: true object: type: string enum: - payment amount: description: Payment amount type: number example: 12.5 amount_refunded: description: Payment amount refunded. type: number example: 0 currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD description: description: Payment description type: string example: Ajuste por deuda pasada status: description: Payment Status type: string example: rejected enum: - pending_submission - cancelled - submitted - failed - will_retry - approved - rejected - chargeback - refunded - partially_refunded - requires_action - incomplete response_message: description: Financial institution detailed response type: string example: Falta de fondos rejection_code: description: Internal rejection code type: - 'null' - string example: null provider_rejection_code: description: Provider-specific rejection code type: - 'null' - string example: null paid: description: The payment has been succesfully collected. type: boolean example: false readOnly: true retryable: description: The payment can be retried. type: boolean example: true readOnly: true refundable: description: The payment can be refunded. type: boolean example: false readOnly: true amount_refundable: description: The amount of payment that can be refunded. type: number example: 0 livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' charge_date: description: >- A future date on which the payment should be collected. If not specified, the payment will be collected as soon as possible. type: string example: '2022-08-04' submissions_count: description: >- The number of time the payment has been sent to the financial institution. type: number example: 1 can_auto_retry_until: description: >- The latest date the payment will be sent to the financial institution. Null means no limit type: - 'null' - string example: '2022-08-31' auto_retries_max_attempts: description: >- The maximum number of times the payment could be automatically retried. type: - 'null' - number example: null effective_charged_date: description: The date when the payment will be collected. type: - 'null' - string example: null estimated_accreditation_date: description: >- The estimated date when the financial institution will send the amount collect to your account. type: - 'null' - string example: null updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_status: description: The latest date the payment status was changed. type: - 'null' - string example: '2022-08-31' customer: description: >- This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer subscription: description: >- The [Subscription](#tag/Subscriptions) associated with the payment if existent. type: - 'null' - string example: SBmX1MrZ77Mwq3 subscription_payment_number: description: >- The number of payment of the associated Subscription, if existent. type: - 'null' - string example: null gateway: description: >- The [Gateway](#tag/Gateways) associated with the payment. type: string example: GW1L49J7ARW3 session: description: >- The [Session](#tag/Sessions) associated with the payment if existent. type: - 'null' - string example: SS167GrPwXyd90qQoK payment_method: description: >- This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: >- This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: >- Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method gateway_identifier: description: >- The custom number you send to the gateway network. In most cases this value is null. type: - 'null' - string example: null binary_mode: description: > Binary mode forces instantaneous payment processing, returning an immediate and definitive status — either approved or rejected — within the same request response. This mode prevents inconclusive responses (such as payments with status `submitted`) by using only gateways that can process payments instantly, ensuring a fast and conclusive outcome. It is particularly useful when processing payments in a checkout flow that requires a synchronous response, allowing the customer to receive instant feedback on the transaction result. Also consider that this mode disables automatic retries for rejected payments, but this behavior can be managed also defining the maximum amount of times the payment could be retried automatically by setting the `auto_retries_max_attempts` parameter. type: boolean example: true next_action: description: Additional actions required for the payment type: - 'null' - object example: null recovery_link: description: URL for customer to recover/retry the payment type: string format: uri example: >- https://debi.test/session_recovery/payment?id=PYA8EJ1DkDnY&signature=... logs: description: Payment processing logs 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: Refunds associated with this payment. type: array items: title: Refund description: >- This object represents a refunds of your organization. type: object properties: id: description: Unique identifier for the Refund. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [Payment ID](#tag/Payments). type: string example: PYgaZlLaPMZO amount: description: Refund amount. type: number example: 12.5 currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Refund Reason type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Refund Status type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} example: [] metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} title: Payment '401': description: Unauthorized content: application/json: schema: properties: data: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized tags: - Payments 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: Cancel payment description: Cancel payment. parameters: - name: id in: path description: | [Payment ID](#tag/Payments). required: true schema: type: string example: PYdOz9bgVReV responses: '201': description: Created content: application/json: example: message: Cancelled successfully '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized tags: - Payments 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: Retry a payment description: Retry a payment. parameters: - name: id in: path description: | [Payment ID](#tag/Payments). required: true schema: type: string example: PYdOz9bgVReV responses: '201': description: Retried successfully content: application/json: example: message: Retried successfully '401': description: Unauthorized content: application/json: schema: properties: data: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized tags: - Payments 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: Stop auto retrying description: >- Stop auto retrying, avoid the payment beying retrying after a rejection. This action can be requested at any time of the payment cycle, even when the payment is sent and beying processed by the finantial institution. parameters: - name: id in: path description: | [Payment ID](#tag/Payments). required: true schema: type: string example: PYdOz9bgVReV responses: '201': description: Updated content: application/json: example: message: Stopped autoretries successfully '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized tags: - Payments 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: > **⚠️ This endpoint is in BETA** - This feature is currently in beta testing. - May change without notice - Use with caution in production - Breaking changes possible - Limited support provided Mark a payment as confirmed 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: This object represents a payments of your organization. type: object properties: id: description: Unique identifier for the Payment. type: string example: PYljikas9Fa8 readOnly: true object: type: string enum: - payment amount: description: Payment amount type: number example: 12.5 amount_refunded: description: Payment amount refunded. type: number example: 0 currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD description: description: Payment description type: string example: Ajuste por deuda pasada status: description: Payment Status type: string example: rejected enum: - pending_submission - cancelled - submitted - failed - will_retry - approved - rejected - chargeback - refunded - partially_refunded - requires_action - incomplete response_message: description: Financial institution detailed response type: string example: Falta de fondos rejection_code: description: Internal rejection code type: - 'null' - string example: null provider_rejection_code: description: Provider-specific rejection code type: - 'null' - string example: null paid: description: The payment has been succesfully collected. type: boolean example: false readOnly: true retryable: description: The payment can be retried. type: boolean example: true readOnly: true refundable: description: The payment can be refunded. type: boolean example: false readOnly: true amount_refundable: description: The amount of payment that can be refunded. type: number example: 0 livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' charge_date: description: >- A future date on which the payment should be collected. If not specified, the payment will be collected as soon as possible. type: string example: '2022-08-04' submissions_count: description: >- The number of time the payment has been sent to the financial institution. type: number example: 1 can_auto_retry_until: description: >- The latest date the payment will be sent to the financial institution. Null means no limit type: - 'null' - string example: '2022-08-31' auto_retries_max_attempts: description: >- The maximum number of times the payment could be automatically retried. type: - 'null' - number example: null effective_charged_date: description: The date when the payment will be collected. type: - 'null' - string example: null estimated_accreditation_date: description: >- The estimated date when the financial institution will send the amount collect to your account. type: - 'null' - string example: null updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_status: description: The latest date the payment status was changed. type: - 'null' - string example: '2022-08-31' customer: description: This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer subscription: description: >- The [Subscription](#tag/Subscriptions) associated with the payment if existent. type: - 'null' - string example: SBmX1MrZ77Mwq3 subscription_payment_number: description: >- The number of payment of the associated Subscription, if existent. type: - 'null' - string example: null gateway: description: The [Gateway](#tag/Gateways) associated with the payment. type: string example: GW1L49J7ARW3 session: description: >- The [Session](#tag/Sessions) associated with the payment if existent. type: - 'null' - string example: SS167GrPwXyd90qQoK payment_method: description: This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: >- This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: >- Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method gateway_identifier: description: >- The custom number you send to the gateway network. In most cases this value is null. type: - 'null' - string example: null binary_mode: description: > Binary mode forces instantaneous payment processing, returning an immediate and definitive status — either approved or rejected — within the same request response. This mode prevents inconclusive responses (such as payments with status `submitted`) by using only gateways that can process payments instantly, ensuring a fast and conclusive outcome. It is particularly useful when processing payments in a checkout flow that requires a synchronous response, allowing the customer to receive instant feedback on the transaction result. Also consider that this mode disables automatic retries for rejected payments, but this behavior can be managed also defining the maximum amount of times the payment could be retried automatically by setting the `auto_retries_max_attempts` parameter. type: boolean example: true next_action: description: Additional actions required for the payment type: - 'null' - object example: null recovery_link: description: URL for customer to recover/retry the payment type: string format: uri example: >- https://debi.test/session_recovery/payment?id=PYA8EJ1DkDnY&signature=... logs: description: Payment processing logs 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: Refunds associated with this payment. type: array items: title: Refund description: This object represents a refunds of your organization. type: object properties: id: description: Unique identifier for the Refund. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [Payment ID](#tag/Payments). type: string example: PYgaZlLaPMZO amount: description: Refund amount. type: number example: 12.5 currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Refund Reason type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Refund Status type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} example: [] metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} title: Payment examples: sample: summary: Sample Payment 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: Not Found response 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: Validation Error tags: - Payments 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: > **⚠️ This endpoint is in BETA** - This feature is currently in beta testing. - May change without notice - Use with caution in production - Breaking changes possible - Limited support provided Retrieve the bank transaction associated with a payment. This shows the actual bank transfer details. parameters: - name: id in: path description: The payment ID required: true schema: type: string example: PYA8EJ1DkDnY responses: '200': description: Bank transaction details content: application/json: schema: type: object properties: id: description: Transaction ID type: string object: type: string enum: - bank_transaction amount: description: Transaction amount type: number format: float currency: description: Currency code type: string status: description: Transaction status type: string created_at: description: Transaction creation date type: string format: date-time processed_at: description: Transaction processing date type: string format: date-time '404': description: Payment or transaction not found content: application/json: schema: description: Not Found response type: object properties: message: type: string example: Record not found title: Not Found tags: - Payments 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: > **⚠️ This endpoint is in BETA** - This feature is currently in beta testing. - May change without notice - Use with caution in production - Breaking changes possible - Limited support provided Get potential bank transactions that could be matched with this payment for manual reconciliation. parameters: - name: id in: path description: The payment ID required: true schema: type: string example: PYA8EJ1DkDnY responses: '200': description: List of potential matching transactions content: application/json: schema: type: object properties: object: type: string enum: - list data: type: array items: type: object properties: id: description: Remote transaction ID type: string amount: description: Transaction amount type: number format: float currency: description: Currency code type: string date: description: Transaction date type: string format: date description: description: Transaction description type: string confidence_score: description: Matching confidence score type: number format: float maximum: 1 minimum: 0 '404': description: Payment not found content: application/json: schema: description: Not Found response type: object properties: message: type: string example: Record not found title: Not Found tags: - Payments 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: > **⚠️ This endpoint is in BETA** - This feature is currently in beta testing. - May change without notice - Use with caution in production - Breaking changes possible - Limited support provided Manually match a payment with a specific bank transaction for reconciliation purposes. parameters: - name: id in: path description: The payment ID required: true schema: type: string example: PYA8EJ1DkDnY requestBody: required: true content: application/json: schema: type: object properties: remote_transaction_id: description: The ID of the remote bank transaction to match with type: string example: RT123456789 notes: description: Optional notes about the match type: string example: Manual match confirmed by admin required: - remote_transaction_id responses: '200': description: Transaction matched successfully 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: Payment or transaction not found content: application/json: schema: description: Not Found response 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: Validation Error tags: - Payments 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: Search payments description: Search payments. parameters: - name: q in: query description: > The search query string. See [search query language](https://debi.pro/docs/docs/producto/Sistema%20de%20B%C3%BAsquedas/) and the list of supported query fields for charges. required: true schema: type: string example: john doe - name: limit in: query description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 25. required: false schema: type: integer example: 20 - name: page in: query description: > A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. 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: This object represents a payments of your organization. type: object properties: id: description: Unique identifier for the Payment. type: string example: PYljikas9Fa8 readOnly: true object: type: string enum: - payment amount: description: Payment amount type: number example: 12.5 amount_refunded: description: Payment amount refunded. type: number example: 0 currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD description: description: Payment description type: string example: Ajuste por deuda pasada status: description: Payment Status type: string example: rejected enum: - pending_submission - cancelled - submitted - failed - will_retry - approved - rejected - chargeback - refunded - partially_refunded - requires_action - incomplete response_message: description: Financial institution detailed response type: string example: Falta de fondos rejection_code: description: Internal rejection code type: - 'null' - string example: null provider_rejection_code: description: Provider-specific rejection code type: - 'null' - string example: null paid: description: The payment has been succesfully collected. type: boolean example: false readOnly: true retryable: description: The payment can be retried. type: boolean example: true readOnly: true refundable: description: The payment can be refunded. type: boolean example: false readOnly: true amount_refundable: description: The amount of payment that can be refunded. type: number example: 0 livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' charge_date: description: >- A future date on which the payment should be collected. If not specified, the payment will be collected as soon as possible. type: string example: '2022-08-04' submissions_count: description: >- The number of time the payment has been sent to the financial institution. type: number example: 1 can_auto_retry_until: description: >- The latest date the payment will be sent to the financial institution. Null means no limit type: - 'null' - string example: '2022-08-31' auto_retries_max_attempts: description: >- The maximum number of times the payment could be automatically retried. type: - 'null' - number example: null effective_charged_date: description: The date when the payment will be collected. type: - 'null' - string example: null estimated_accreditation_date: description: >- The estimated date when the financial institution will send the amount collect to your account. type: - 'null' - string example: null updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_status: description: The latest date the payment status was changed. type: - 'null' - string example: '2022-08-31' customer: description: >- This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer subscription: description: >- The [Subscription](#tag/Subscriptions) associated with the payment if existent. type: - 'null' - string example: SBmX1MrZ77Mwq3 subscription_payment_number: description: >- The number of payment of the associated Subscription, if existent. type: - 'null' - string example: null gateway: description: >- The [Gateway](#tag/Gateways) associated with the payment. type: string example: GW1L49J7ARW3 session: description: >- The [Session](#tag/Sessions) associated with the payment if existent. type: - 'null' - string example: SS167GrPwXyd90qQoK payment_method: description: >- This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: >- This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: >- Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method gateway_identifier: description: >- The custom number you send to the gateway network. In most cases this value is null. type: - 'null' - string example: null binary_mode: description: > Binary mode forces instantaneous payment processing, returning an immediate and definitive status — either approved or rejected — within the same request response. This mode prevents inconclusive responses (such as payments with status `submitted`) by using only gateways that can process payments instantly, ensuring a fast and conclusive outcome. It is particularly useful when processing payments in a checkout flow that requires a synchronous response, allowing the customer to receive instant feedback on the transaction result. Also consider that this mode disables automatic retries for rejected payments, but this behavior can be managed also defining the maximum amount of times the payment could be retried automatically by setting the `auto_retries_max_attempts` parameter. type: boolean example: true next_action: description: Additional actions required for the payment type: - 'null' - object example: null recovery_link: description: URL for customer to recover/retry the payment type: string format: uri example: >- https://debi.test/session_recovery/payment?id=PYA8EJ1DkDnY&signature=... logs: description: Payment processing logs 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: Refunds associated with this payment. type: array items: title: Refund description: >- This object represents a refunds of your organization. type: object properties: id: description: Unique identifier for the Refund. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [Payment ID](#tag/Payments). type: string example: PYgaZlLaPMZO amount: description: Refund amount. type: number example: 12.5 currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Refund Reason type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Refund Status type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} example: [] metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} links: description: Pagination links 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: Response Meta meta: description: Pagination metadata 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: Pagination Cursor. type: - 'null' - string prev_cursor: description: Pagination Cursor. 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: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized tags: - Payments 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: List all refunds description: By default newest refunds will be first on the list. parameters: - name: created_at in: query description: >- A filter on the list, based on the object `created_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. required: false schema: type: object properties: gt: description: Minimum value to filter by (exclusive) type: integer gte: description: Minimum value to filter by (inclusive) type: integer lt: description: Maximum value to filter by (exclusive) type: integer lte: description: Maximum value to filter by (inclusive) type: integer title: range_query_specs explode: true style: deepObject - name: ending_before in: query description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. required: false schema: type: string style: form - name: limit in: query description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 25. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. required: false schema: type: string style: form responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Refund description: This object represents a refunds of your organization. type: object properties: id: description: Unique identifier for the Refund. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [Payment ID](#tag/Payments). type: string example: PYgaZlLaPMZO amount: description: Refund amount. type: number example: 12.5 currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Refund Reason type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Refund Status type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} links: description: Pagination links 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: Response Meta meta: description: Pagination metadata 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: Pagination Cursor. type: - 'null' - string prev_cursor: description: Pagination Cursor. type: - 'null' - string title: Response Meta required: - data '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized tags: - Refunds 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: Create a refund description: Create a refund. requestBody: content: application/json: schema: type: object properties: payment_id: description: | [Payment ID](#tag/Payments). type: string example: PYgaZlLaPMZO. amount: description: >- Amount to be refunded. If is null it will refund the whole payment. type: number example: 12.5 reason: description: >- Refund Reason. One of `duplicate`, `error`, or `requested_by_customer`. type: string example: requested_by_customer metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} required: - payment_id - reason responses: '201': description: Refund created. content: application/json: schema: properties: data: description: This object represents a refunds of your organization. type: object properties: id: description: Unique identifier for the Refund. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [Payment ID](#tag/Payments). type: string example: PYgaZlLaPMZO amount: description: Refund amount. type: number example: 12.5 currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Refund Reason type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Refund Status type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} title: Refund '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '422': description: Unprocessable Entity content: application/json: example: errors: payment_id: - payment_id is required. message: The given data was invalid. tags: - Refunds 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: Retrieve a refund description: Retrieve a refund. parameters: - name: id in: path description: | [Refund ID](#tag/Refunds). required: true schema: type: string example: RFgaZlLaPMZO responses: '200': description: OK content: application/json: schema: properties: data: description: This object represents a refunds of your organization. type: object properties: id: description: Unique identifier for the Refund. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [Payment ID](#tag/Payments). type: string example: PYgaZlLaPMZO amount: description: Refund amount. type: number example: 12.5 currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Refund Reason type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Refund Status type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} title: Refund '401': description: Unauthorized content: application/json: schema: properties: data: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '404': description: Object not found content: application/json: schema: properties: data: description: Not Found response type: object properties: message: type: string example: Record not found title: Not Found tags: - Refunds 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: Create a sesssion description: Create a session requestBody: required: false content: application/json: schema: type: object properties: kind: description: One of payment, subscription or mandate. type: string enum: - payment - subscription - mandate success_url: description: >- The uri on which your customer will be redirected after completing the checkout. type: string amount: description: The amount of the payment or subscription. type: string description: description: The title of the payment or subscription. type: string customer_id: description: | [Customer ID](#tag/Customers). type: string example: CSgaZlLaPMZO customer_name: description: > Name of your customer. You can fill it or ask the customer to fill this field in the checkout process. type: string customer_email: description: > Email of your customer. You can fill it or ask the customer to fill this field in the checkout process. type: string customer_gateway_identifier: description: The customer's reference for bank account statements. type: - 'null' - string example: '383473' editable_amount: description: | Allow the customer to set the amount, useful for donations. type: boolean installments: description: > Only for payments, quantity of payments on which the amount will be splitted. type: integer max_installments: description: > Only for payments, allow the customer to choose how many installments can split the payment. type: integer interval_unit: description: > Only for subscriptions, the unit of time between customer charge dates. One of weekly, monthly or yearly. type: string enum: - weekly - monthly - yearly interval: description: > Only for subscriptions, the 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. type: integer day_of_month: description: > Only for subscriptions, the day of month, from 1 to 28. Use only if you need the subscription to start in a specyfic date. In most cases this should be null, therefore Debi will use the date of the moment when the user completes the checkout. type: integer day_of_week: description: > Only for subscriptions, the day of week number, from 0 (Sunday) to 6 (Saturday). Use only if you need the subscription to start in a specyfic date. In most cases this should be null, therefore Debi will use the date of the moment when the user completes the checkout. type: integer payment_gateway_identifier: description: >- The custom number you send to the gateway network. In most cases this value is null. type: - 'null' - string example: null binary_mode: description: > Binary mode forces instantaneous payment processing, returning an immediate and definitive status — either approved or rejected — within the same request response. This mode prevents inconclusive responses (such as payments with status `submitted`) by using only gateways that can process payments instantly, ensuring a fast and conclusive outcome. It is particularly useful when processing payments in a checkout flow that requires a synchronous response, allowing the customer to receive instant feedback on the transaction result. Also consider that this mode disables automatic retries for rejected payments, but this behavior can be managed also defining the maximum amount of times the payment could be retried automatically by setting the `auto_retries_max_attempts` parameter. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} extra_fields: description: > A collection of fields designed to be stored as [the metadata](#section/Metadata) of the object that the Session is generating whether it's a [Payment](#tag/Payments), [Subscription](#tag/Subscriptions), or [Mandate](#tag/Mandates). This functionality enables you to request extra information from the user during the checkout process, providing a means to store supplementary details about the object in a well-organized format. 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: > A collection of fields designed to be stored as [the metadata](#section/Metadata) of the [Customer](#tag/Customers) that the Session is generating. This functionality enables you to request extra information from the user during the checkout process, providing a means to store supplementary details about the object in a well-organized format. 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: > Only for subscriptions, the total number of payments that should be taken by this subscription. If not specified the subscription will continue until you cancel it. type: integer editable_count: description: > Only for subscriptions, allow the customer to set the duration of the subscriptions, useful for donations. type: number payment_method_types: description: > Array of payment method types to allow. If not specified, all available payment methods will be allowed. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Configuration options for specific payment method types, such as disallowing certain card networks or funding types. 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: This object represents a Session of your organization. type: object properties: id: description: Unique identifier for the Session. type: string example: SSmQ6j9NWxblNv readOnly: true uuid: description: UUID identifier for the object. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc object: type: string enum: - session description: description: Session description type: string example: Ajuste por deuda pasada amount: description: Amount to be collected. type: number example: 12.5 kind: type: string enum: - mandate - payment - subscription customer_id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true customer_name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro customer_email: description: The customer's email address. type: - 'null' - string example: mail@example.com customer_gateway_identifier: description: The customer's reference for bank account statements. type: - 'null' - string example: '383473' editable_amount: description: > Allow the customer to set the amount, useful for donations. type: boolean installments: description: > Only for payments, quantity of payments on which the amount will be splitted. type: integer max_installments: description: > Only for payments, allow the customer to choose how many installments can split the payment. type: integer interval_unit: description: > Only for subscriptions. The unit of time between customer charge dates. One of `weekly`, `monthly` or `yearly`. Example `monthly`. type: string interval: description: >- Only for subscriptions. Number of `interval_units` between customer charge dates. Must be greater than to 1. If `interval_units` is `weekly` and interval is 2, then the customer will be charged every two weeks. Defaults to 1. type: number day_of_month: description: >- Day of month, from 1 to 28. This field is required if interval_unit is set to monthly. Defaults to 1. type: number day_of_week: description: >- Day of week number, from 0 (Sunday) to 6 (Saturday). This field is required if `interval_unit` is set to `weekly`. type: number count: type: number editable_count: type: boolean name_text: type: string created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' completed_at: description: >- Time at which the sessions was completed. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true binary_mode: description: > Binary mode forces instantaneous payment processing, returning an immediate and definitive status — either approved or rejected — within the same request response. This mode prevents inconclusive responses (such as payments with status `submitted`) by using only gateways that can process payments instantly, ensuring a fast and conclusive outcome. It is particularly useful when processing payments in a checkout flow that requires a synchronous response, allowing the customer to receive instant feedback on the transaction result. Also consider that this mode disables automatic retries for rejected payments, but this behavior can be managed also defining the maximum amount of times the payment could be retried automatically by setting the `auto_retries_max_attempts` parameter. type: boolean example: true payment_gateway_identifier: description: >- The custom number you send to the gateway network. In most cases this value is null. type: - 'null' - string example: null public_uri: description: >- The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout. type: string readOnly: true success_url: description: >- The uri on which your customer will be redirected after completing the checkout. type: string link_id: description: Link ID. type: string example: LKLj0JV8xzdMoRk549 payment_method_types: description: > Array of payment method types to allow. If not specified, all available payment methods will be allowed. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Configuration options for specific payment method types, such as disallowing certain card networks or funding types. 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: >- Available payment methods based on user's gateway configuration type: array items: type: object example: [] readOnly: true title: Session '401': description: Unauthorized content: application/json: schema: properties: data: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '422': description: Unprocessable Entity content: application/json: example: errors: email: - El email es inválido. message: The given data was invalid. tags: - Sessions 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: Retrieve a session description: Retrieve a session. parameters: - name: id in: path description: | [Session ID](#tag/Sessions). required: true schema: type: string example: SSnO8b9w7B51VE0B5m responses: '201': description: OK content: application/json: schema: properties: data: description: This object represents a Session of your organization. type: object properties: id: description: Unique identifier for the Session. type: string example: SSmQ6j9NWxblNv readOnly: true uuid: description: UUID identifier for the object. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc object: type: string enum: - session description: description: Session description type: string example: Ajuste por deuda pasada amount: description: Amount to be collected. type: number example: 12.5 kind: type: string enum: - mandate - payment - subscription customer_id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true customer_name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro customer_email: description: The customer's email address. type: - 'null' - string example: mail@example.com customer_gateway_identifier: description: The customer's reference for bank account statements. type: - 'null' - string example: '383473' editable_amount: description: > Allow the customer to set the amount, useful for donations. type: boolean installments: description: > Only for payments, quantity of payments on which the amount will be splitted. type: integer max_installments: description: > Only for payments, allow the customer to choose how many installments can split the payment. type: integer interval_unit: description: > Only for subscriptions. The unit of time between customer charge dates. One of `weekly`, `monthly` or `yearly`. Example `monthly`. type: string interval: description: >- Only for subscriptions. Number of `interval_units` between customer charge dates. Must be greater than to 1. If `interval_units` is `weekly` and interval is 2, then the customer will be charged every two weeks. Defaults to 1. type: number day_of_month: description: >- Day of month, from 1 to 28. This field is required if interval_unit is set to monthly. Defaults to 1. type: number day_of_week: description: >- Day of week number, from 0 (Sunday) to 6 (Saturday). This field is required if `interval_unit` is set to `weekly`. type: number count: type: number editable_count: type: boolean name_text: type: string created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' completed_at: description: >- Time at which the sessions was completed. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true binary_mode: description: > Binary mode forces instantaneous payment processing, returning an immediate and definitive status — either approved or rejected — within the same request response. This mode prevents inconclusive responses (such as payments with status `submitted`) by using only gateways that can process payments instantly, ensuring a fast and conclusive outcome. It is particularly useful when processing payments in a checkout flow that requires a synchronous response, allowing the customer to receive instant feedback on the transaction result. Also consider that this mode disables automatic retries for rejected payments, but this behavior can be managed also defining the maximum amount of times the payment could be retried automatically by setting the `auto_retries_max_attempts` parameter. type: boolean example: true payment_gateway_identifier: description: >- The custom number you send to the gateway network. In most cases this value is null. type: - 'null' - string example: null public_uri: description: >- The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout. type: string readOnly: true success_url: description: >- The uri on which your customer will be redirected after completing the checkout. type: string link_id: description: Link ID. type: string example: LKLj0JV8xzdMoRk549 payment_method_types: description: > Array of payment method types to allow. If not specified, all available payment methods will be allowed. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Configuration options for specific payment method types, such as disallowing certain card networks or funding types. 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: >- Available payment methods based on user's gateway configuration type: array items: type: object example: [] readOnly: true title: Session '401': description: Unauthorized content: application/json: schema: properties: data: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '404': description: Session not found content: application/json: example: message: Session not found tags: - Sessions 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: List all subscriptions description: By default newest subscriptions will be first on the list. parameters: - name: created_at in: query description: >- A filter on the list, based on the object `created_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. required: false schema: type: object properties: gt: description: Minimum value to filter by (exclusive) type: integer gte: description: Minimum value to filter by (inclusive) type: integer lt: description: Maximum value to filter by (exclusive) type: integer lte: description: Maximum value to filter by (inclusive) type: integer title: range_query_specs explode: true style: deepObject - name: ending_before in: query description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. required: false schema: type: string style: form - name: limit in: query description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 25. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. required: false schema: type: string style: form responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Subscription description: >- This object represents a subscription of your organization. type: object properties: id: description: Unique identifier for the Subscription. type: string example: SBmQ6j9NWxblNv readOnly: true object: type: string enum: - subscription amount: description: Subscription amount type: number example: 12.5 description: description: Subscription description type: string example: Ajuste por deuda pasada currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD status: description: Subscription Status type: string example: active enum: - active - paused - cancelled - finished - incomplete - incomplete_expired count: description: > The total number of payments that should be taken by this subscription. type: - 'null' - number example: 12 start_date: description: >- A future date on which the first payment of the subscription should be collected. type: string example: '2022-08-04' interval_unit: description: The unit of time between customer charge dates. type: string example: monthly enum: - weekly - monthly - yearly interval: description: >- Number of `interval_units` between customer charge dates. Must be greater than to 1. If `interval_units` is `weekly` and interval is 2, then the customer will be charged every two weeks. Defaults to 1. type: number example: 1 day_of_month: description: >- Day of month, from 1 to 28. This field is required if `interval_unit` is set to monthly. Defaults to 1. type: number day_of_week: description: >- Day of week number, from 0 (Sunday) to 6 (Saturday). This field is required if `interval_unit` is set to `weekly`. type: - 'null' - number livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: >- The maximum number of times the payments from this subscription could be automatically retried. type: - 'null' - number example: null first_date: description: >- The date on which the first payment should be charged. When left blank and month or day_of_month are provided, this will be set to the date of the first payment. If created without month or day_of_month this will be set as soon as possible. type: string example: '2022-08-04' upcoming_dates: description: Up to 5 upcoming payments charge dates. type: array items: type: string properties: {} example: - '2022-09-04' - '2022-10-04' - '2022-11-04' - '2022-12-04' - '2023-01-04' customer: description: >- This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer payment_method: description: >- This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: >- This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: >- Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. 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: Pagination links 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: Response Meta meta: description: Pagination metadata 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: Pagination Cursor. type: - 'null' - string prev_cursor: description: Pagination Cursor. type: - 'null' - string title: Response Meta required: - data '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized tags: - Subscriptions 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: Create a subscription description: Create a subscription 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 description of each payment of the subscription. type: string maxLength: 255 count: description: > The total number of payments that should be taken by this subscription. If not specified the subscription will continue until you cancel it. type: number customer_id: description: | [Customer ID](#tag/Customers). type: string example: CSgaZlLaPMZO. payment_method_id: description: > [Payment Method ID](#tag/Payment-Methods). This field is required if `payment_method_number` is not given. 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_units` is `weekly` and interval is 2, then the customer will be charged every two weeks. Defaults to 1. type: number day_of_month: description: >- Day of month, from 1 to 28. This field is required if `interval_unit` is set to monthly. Defaults to 1. type: number day_of_week: description: >- Day of week number, from 0 (Sunday) to 6 (Saturday). This field is required if `interval_unit` is set to `weekly`. type: number auto_retries_max_attempts: description: >- The maximum number of times the payments from this subscription could be automatically retried. type: - 'null' - number example: null first_payment_in_binary_mode: description: > Forces instantaneous payment processing for the first payment of the subscription. This provides an immediate status of either `approved` or `rejected` within the request response. This setting eliminates automatic retries for failed payments, ensuring a swift and conclusive outcome. When set to `true`, the payment is processed immediately. If it fails, the subscription will remain in state `incomplete` and no automatic retries will be attempted. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. 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: >- This object represents a subscription of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Subscription. type: string example: SBmQ6j9NWxblNv readOnly: true object: type: string enum: - subscription amount: description: Subscription amount type: number example: 12.5 description: description: Subscription description type: string example: Ajuste por deuda pasada currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD status: description: Subscription Status type: string example: active enum: - active - paused - cancelled - finished - incomplete - incomplete_expired count: description: > The total number of payments that should be taken by this subscription. type: - 'null' - number example: 12 start_date: description: >- A future date on which the first payment of the subscription should be collected. type: string example: '2022-08-04' interval_unit: description: The unit of time between customer charge dates. type: string example: monthly enum: - weekly - monthly - yearly interval: description: >- Number of `interval_units` between customer charge dates. Must be greater than to 1. If `interval_units` is `weekly` and interval is 2, then the customer will be charged every two weeks. Defaults to 1. type: number example: 1 day_of_month: description: >- Day of month, from 1 to 28. This field is required if `interval_unit` is set to monthly. Defaults to 1. type: number day_of_week: description: >- Day of week number, from 0 (Sunday) to 6 (Saturday). This field is required if `interval_unit` is set to `weekly`. type: - 'null' - number livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: >- The maximum number of times the payments from this subscription could be automatically retried. type: - 'null' - number example: null first_date: description: >- The date on which the first payment should be charged. When left blank and month or day_of_month are provided, this will be set to the date of the first payment. If created without month or day_of_month this will be set as soon as possible. type: string example: '2022-08-04' upcoming_dates: description: Up to 5 upcoming payments charge dates. type: array items: type: string properties: {} example: - '2022-09-04' - '2022-10-04' - '2022-11-04' - '2022-12-04' - '2023-01-04' customer: description: >- This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer payment_method: description: >- This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: >- This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: >- Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. 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: Subscription 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: Unauthorized content: application/json: schema: properties: data: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '422': description: Unprocessable Entity content: application/json: example: errors: email: - El email es inválido. message: The given data was invalid. tags: - Subscriptions 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: Retrieve a subscription description: Retrieve a subscription. parameters: - name: id in: path description: | [Subscription ID](#tag/Subscriptions). required: true schema: type: string example: SBmX1MrZ77Mwq3 responses: '200': description: Retrieve a subscription content: application/json: schema: properties: data: description: >- This object represents a subscription of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Subscription. type: string example: SBmQ6j9NWxblNv readOnly: true object: type: string enum: - subscription amount: description: Subscription amount type: number example: 12.5 description: description: Subscription description type: string example: Ajuste por deuda pasada currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD status: description: Subscription Status type: string example: active enum: - active - paused - cancelled - finished - incomplete - incomplete_expired count: description: > The total number of payments that should be taken by this subscription. type: - 'null' - number example: 12 start_date: description: >- A future date on which the first payment of the subscription should be collected. type: string example: '2022-08-04' interval_unit: description: The unit of time between customer charge dates. type: string example: monthly enum: - weekly - monthly - yearly interval: description: >- Number of `interval_units` between customer charge dates. Must be greater than to 1. If `interval_units` is `weekly` and interval is 2, then the customer will be charged every two weeks. Defaults to 1. type: number example: 1 day_of_month: description: >- Day of month, from 1 to 28. This field is required if `interval_unit` is set to monthly. Defaults to 1. type: number day_of_week: description: >- Day of week number, from 0 (Sunday) to 6 (Saturday). This field is required if `interval_unit` is set to `weekly`. type: - 'null' - number livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: >- The maximum number of times the payments from this subscription could be automatically retried. type: - 'null' - number example: null first_date: description: >- The date on which the first payment should be charged. When left blank and month or day_of_month are provided, this will be set to the date of the first payment. If created without month or day_of_month this will be set as soon as possible. type: string example: '2022-08-04' upcoming_dates: description: Up to 5 upcoming payments charge dates. type: array items: type: string properties: {} example: - '2022-09-04' - '2022-10-04' - '2022-11-04' - '2022-12-04' - '2023-01-04' customer: description: >- This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer payment_method: description: >- This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: >- This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: >- Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. 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: Subscription '401': description: Unauthorized content: application/json: schema: properties: data: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '404': description: Object not found content: application/json: schema: properties: data: description: Not Found response type: object properties: message: type: string example: Record not found title: Not Found tags: - Subscriptions 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: Update a subscription description: Update a subscription. 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: > The total number of payments that should be taken by this subscription. If not specified the subscription will continue until you cancel it. type: number customer_id: description: | [Customer ID](#tag/Customers). type: string example: CSgaZlLaPMZO payment_method_id: description: > The [Payment Method ID](#tag/Payment-Methods) for each payment of the subscription. This field is required if `payment_method_number` is not given. 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: >- Day of month, from 1 to 28. This field is required if interval_unit is set to monthly. Defaults to 1. type: number day_of_week: description: >- Day of week number, from 0 (Sunday) to 6 (Saturday). This field is required if `interval_unit` is set to `weekly`. type: number auto_retries_max_attempts: description: >- The maximum number of times the payments from this subscription could be automatically retried. type: - 'null' - number example: null metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. 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: >- This object represents a subscription of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Subscription. type: string example: SBmQ6j9NWxblNv readOnly: true object: type: string enum: - subscription amount: description: Subscription amount type: number example: 12.5 description: description: Subscription description type: string example: Ajuste por deuda pasada currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD status: description: Subscription Status type: string example: active enum: - active - paused - cancelled - finished - incomplete - incomplete_expired count: description: > The total number of payments that should be taken by this subscription. type: - 'null' - number example: 12 start_date: description: >- A future date on which the first payment of the subscription should be collected. type: string example: '2022-08-04' interval_unit: description: The unit of time between customer charge dates. type: string example: monthly enum: - weekly - monthly - yearly interval: description: >- Number of `interval_units` between customer charge dates. Must be greater than to 1. If `interval_units` is `weekly` and interval is 2, then the customer will be charged every two weeks. Defaults to 1. type: number example: 1 day_of_month: description: >- Day of month, from 1 to 28. This field is required if `interval_unit` is set to monthly. Defaults to 1. type: number day_of_week: description: >- Day of week number, from 0 (Sunday) to 6 (Saturday). This field is required if `interval_unit` is set to `weekly`. type: - 'null' - number livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: >- The maximum number of times the payments from this subscription could be automatically retried. type: - 'null' - number example: null first_date: description: >- The date on which the first payment should be charged. When left blank and month or day_of_month are provided, this will be set to the date of the first payment. If created without month or day_of_month this will be set as soon as possible. type: string example: '2022-08-04' upcoming_dates: description: Up to 5 upcoming payments charge dates. type: array items: type: string properties: {} example: - '2022-09-04' - '2022-10-04' - '2022-11-04' - '2022-12-04' - '2023-01-04' customer: description: >- This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer payment_method: description: >- This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: >- This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: >- Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. 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: Subscription '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '422': description: Unprocessable Entity content: application/json: example: errors: email: - El email es inválido. message: The given data was invalid. tags: - Subscriptions 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: Pause a subscription description: Pause a subscription. parameters: - name: id in: path description: | [Subscription ID](#tag/Subscriptions). required: true schema: type: string example: SBmX1MrZ77Mwq3 responses: '201': description: Subscription paused succesfully content: application/json: schema: properties: data: description: >- This object represents a subscription of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Subscription. type: string example: SBmQ6j9NWxblNv readOnly: true object: type: string enum: - subscription amount: description: Subscription amount type: number example: 12.5 description: description: Subscription description type: string example: Ajuste por deuda pasada currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD status: description: Subscription Status type: string example: active enum: - active - paused - cancelled - finished - incomplete - incomplete_expired count: description: > The total number of payments that should be taken by this subscription. type: - 'null' - number example: 12 start_date: description: >- A future date on which the first payment of the subscription should be collected. type: string example: '2022-08-04' interval_unit: description: The unit of time between customer charge dates. type: string example: monthly enum: - weekly - monthly - yearly interval: description: >- Number of `interval_units` between customer charge dates. Must be greater than to 1. If `interval_units` is `weekly` and interval is 2, then the customer will be charged every two weeks. Defaults to 1. type: number example: 1 day_of_month: description: >- Day of month, from 1 to 28. This field is required if `interval_unit` is set to monthly. Defaults to 1. type: number day_of_week: description: >- Day of week number, from 0 (Sunday) to 6 (Saturday). This field is required if `interval_unit` is set to `weekly`. type: - 'null' - number livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: >- The maximum number of times the payments from this subscription could be automatically retried. type: - 'null' - number example: null first_date: description: >- The date on which the first payment should be charged. When left blank and month or day_of_month are provided, this will be set to the date of the first payment. If created without month or day_of_month this will be set as soon as possible. type: string example: '2022-08-04' upcoming_dates: description: Up to 5 upcoming payments charge dates. type: array items: type: string properties: {} example: - '2022-09-04' - '2022-10-04' - '2022-11-04' - '2022-12-04' - '2023-01-04' customer: description: >- This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer payment_method: description: >- This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: >- This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: >- Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. 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: Subscription '401': description: Unauthorized content: application/json: schema: properties: data: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '422': description: Unprocessable Entity content: application/json: example: message: Subscription cannot be paused. tags: - Subscriptions 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: Resume a subscription description: Resume a subscription. parameters: - name: id in: path description: Subscription ID. required: true schema: type: string example: SBmX1MrZ77Mwq3 responses: '201': description: Resumed succesfully content: application/json: schema: properties: data: description: >- This object represents a subscription of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Subscription. type: string example: SBmQ6j9NWxblNv readOnly: true object: type: string enum: - subscription amount: description: Subscription amount type: number example: 12.5 description: description: Subscription description type: string example: Ajuste por deuda pasada currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD status: description: Subscription Status type: string example: active enum: - active - paused - cancelled - finished - incomplete - incomplete_expired count: description: > The total number of payments that should be taken by this subscription. type: - 'null' - number example: 12 start_date: description: >- A future date on which the first payment of the subscription should be collected. type: string example: '2022-08-04' interval_unit: description: The unit of time between customer charge dates. type: string example: monthly enum: - weekly - monthly - yearly interval: description: >- Number of `interval_units` between customer charge dates. Must be greater than to 1. If `interval_units` is `weekly` and interval is 2, then the customer will be charged every two weeks. Defaults to 1. type: number example: 1 day_of_month: description: >- Day of month, from 1 to 28. This field is required if `interval_unit` is set to monthly. Defaults to 1. type: number day_of_week: description: >- Day of week number, from 0 (Sunday) to 6 (Saturday). This field is required if `interval_unit` is set to `weekly`. type: - 'null' - number livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: >- The maximum number of times the payments from this subscription could be automatically retried. type: - 'null' - number example: null first_date: description: >- The date on which the first payment should be charged. When left blank and month or day_of_month are provided, this will be set to the date of the first payment. If created without month or day_of_month this will be set as soon as possible. type: string example: '2022-08-04' upcoming_dates: description: Up to 5 upcoming payments charge dates. type: array items: type: string properties: {} example: - '2022-09-04' - '2022-10-04' - '2022-11-04' - '2022-12-04' - '2023-01-04' customer: description: >- This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer payment_method: description: >- This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: >- This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: >- Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. 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: Subscription '401': description: Unauthorized content: application/json: schema: properties: data: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '422': description: Unprocessable Entity content: application/json: example: errors: amount: - Amount cannot be changed. message: The given data was invalid. tags: - Subscriptions 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: Cancel a subcription description: > This action cancels and archive the subscription. Also cancel the payments related to it. parameters: - name: id in: path description: | [Subscription ID](#tag/Subscriptions). required: true schema: type: string example: SBmX1MrZ77Mwq3 responses: '201': description: Subscription cancelled succesfully content: application/json: schema: properties: data: description: >- This object represents a subscription of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Subscription. type: string example: SBmQ6j9NWxblNv readOnly: true object: type: string enum: - subscription amount: description: Subscription amount type: number example: 12.5 description: description: Subscription description type: string example: Ajuste por deuda pasada currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD status: description: Subscription Status type: string example: active enum: - active - paused - cancelled - finished - incomplete - incomplete_expired count: description: > The total number of payments that should be taken by this subscription. type: - 'null' - number example: 12 start_date: description: >- A future date on which the first payment of the subscription should be collected. type: string example: '2022-08-04' interval_unit: description: The unit of time between customer charge dates. type: string example: monthly enum: - weekly - monthly - yearly interval: description: >- Number of `interval_units` between customer charge dates. Must be greater than to 1. If `interval_units` is `weekly` and interval is 2, then the customer will be charged every two weeks. Defaults to 1. type: number example: 1 day_of_month: description: >- Day of month, from 1 to 28. This field is required if `interval_unit` is set to monthly. Defaults to 1. type: number day_of_week: description: >- Day of week number, from 0 (Sunday) to 6 (Saturday). This field is required if `interval_unit` is set to `weekly`. type: - 'null' - number livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: >- The maximum number of times the payments from this subscription could be automatically retried. type: - 'null' - number example: null first_date: description: >- The date on which the first payment should be charged. When left blank and month or day_of_month are provided, this will be set to the date of the first payment. If created without month or day_of_month this will be set as soon as possible. type: string example: '2022-08-04' upcoming_dates: description: Up to 5 upcoming payments charge dates. type: array items: type: string properties: {} example: - '2022-09-04' - '2022-10-04' - '2022-11-04' - '2022-12-04' - '2023-01-04' customer: description: >- This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer payment_method: description: >- This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: >- This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: >- Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. 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: Subscription '401': description: Unauthorized content: application/json: schema: properties: data: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '422': description: Unprocessable Entity content: application/json: schema: properties: message: type: string example: message: Subscription cannot be cancelled. tags: - Subscriptions 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: Search subscriptions description: Search subscriptions. parameters: - name: q in: query description: > The search query string. See [search query language](https://debi.pro/docs/docs/producto/Sistema%20de%20B%C3%BAsquedas/) and the list of supported query fields for charges. required: true schema: type: string example: john doe - name: limit in: query description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 25. required: false schema: type: integer example: 20 - name: page in: query description: > A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. required: true schema: type: string example: john doe responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: title: Subscription description: >- This object represents a subscription of your organization. type: object properties: id: description: Unique identifier for the Subscription. type: string example: SBmQ6j9NWxblNv readOnly: true object: type: string enum: - subscription amount: description: Subscription amount type: number example: 12.5 description: description: Subscription description type: string example: Ajuste por deuda pasada currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD status: description: Subscription Status type: string example: active enum: - active - paused - cancelled - finished - incomplete - incomplete_expired count: description: > The total number of payments that should be taken by this subscription. type: - 'null' - number example: 12 start_date: description: >- A future date on which the first payment of the subscription should be collected. type: string example: '2022-08-04' interval_unit: description: The unit of time between customer charge dates. type: string example: monthly enum: - weekly - monthly - yearly interval: description: >- Number of `interval_units` between customer charge dates. Must be greater than to 1. If `interval_units` is `weekly` and interval is 2, then the customer will be charged every two weeks. Defaults to 1. type: number example: 1 day_of_month: description: >- Day of month, from 1 to 28. This field is required if `interval_unit` is set to monthly. Defaults to 1. type: number day_of_week: description: >- Day of week number, from 0 (Sunday) to 6 (Saturday). This field is required if `interval_unit` is set to `weekly`. type: - 'null' - number livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: >- The maximum number of times the payments from this subscription could be automatically retried. type: - 'null' - number example: null first_date: description: >- The date on which the first payment should be charged. When left blank and month or day_of_month are provided, this will be set to the date of the first payment. If created without month or day_of_month this will be set as soon as possible. type: string example: '2022-08-04' upcoming_dates: description: Up to 5 upcoming payments charge dates. type: array items: type: string properties: {} example: - '2022-09-04' - '2022-10-04' - '2022-11-04' - '2022-12-04' - '2023-01-04' customer: description: >- This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: >- The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer payment_method: description: >- This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: >- This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: >- This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: >- CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: >- Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: >- The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. 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: Pagination links 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: Response Meta meta: description: Pagination metadata 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: Pagination Cursor. type: - 'null' - string prev_cursor: description: Pagination Cursor. 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: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized tags: - Subscriptions 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: List all webhooks description: Returns a list of your webhooks. parameters: - name: created_at in: query description: >- A filter on the list, based on the object `created_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. required: false schema: type: object properties: gt: description: Minimum value to filter by (exclusive) type: integer gte: description: Minimum value to filter by (inclusive) type: integer lt: description: Maximum value to filter by (exclusive) type: integer lte: description: Maximum value to filter by (inclusive) type: integer title: range_query_specs explode: true style: deepObject - name: ending_before in: query description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. required: false schema: type: string style: form - name: limit in: query description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 25. required: false schema: type: integer example: 20 - name: starting_after in: query description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. 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: >- You can configure [webhook endpoints](https://debi.pro/docs/webhooks/) via the API to be notified about events that happen in your Debi account or connected accounts. Most users configure webhooks from [the dashboard](https://dashboard.debi.pro/webhooks), which provides a user interface for registering and testing your webhook endpoints. type: object properties: id: description: Unique identifier for the object. type: string example: WHA8EJ1DkDnY readOnly: true object: type: string enum: - webhook url: description: The URL of the webhook endpoint. type: string example: https://debi.pro/webhook/200 maxLength: 5000 enabled: description: Whether the webhook is enabled. type: boolean enabled_events: description: > One of: `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: >- The endpoint's secret, used to generate [webhook signatures](https://debi.pro/docs/api/#webhooks-security). 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: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Pagination links 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: Response Meta meta: description: Pagination metadata 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: Pagination Cursor. type: - 'null' - string prev_cursor: description: Pagination Cursor. type: - 'null' - string title: Response Meta required: - data '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized 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: Create a webhook description: Create a 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: >- The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. 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: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} url: description: The URL of the webhook endpoint. type: string additionalProperties: false required: - url responses: '201': description: OK content: application/json: schema: properties: data: description: >- You can configure [webhook endpoints](https://debi.pro/docs/webhooks/) via the API to be notified about events that happen in your Debi account or connected accounts. Most users configure webhooks from [the dashboard](https://dashboard.debi.pro/webhooks), which provides a user interface for registering and testing your webhook endpoints. 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: Unique identifier for the object. type: string example: WHA8EJ1DkDnY readOnly: true object: type: string enum: - webhook url: description: The URL of the webhook endpoint. type: string example: https://debi.pro/webhook/200 maxLength: 5000 enabled: description: Whether the webhook is enabled. type: boolean enabled_events: description: > One of: `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: >- The endpoint's secret, used to generate [webhook signatures](https://debi.pro/docs/api/#webhooks-security). 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: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Webhook '401': description: Unauthorized content: application/json: schema: properties: data: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '422': description: Unprocessable Entity 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: Retrieve a webhook description: Retrieves a 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: >- You can configure [webhook endpoints](https://debi.pro/docs/webhooks/) via the API to be notified about events that happen in your Debi account or connected accounts. Most users configure webhooks from [the dashboard](https://dashboard.debi.pro/webhooks), which provides a user interface for registering and testing your webhook endpoints. 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: Unique identifier for the object. type: string example: WHA8EJ1DkDnY readOnly: true object: type: string enum: - webhook url: description: The URL of the webhook endpoint. type: string example: https://debi.pro/webhook/200 maxLength: 5000 enabled: description: Whether the webhook is enabled. type: boolean enabled_events: description: > One of: `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: >- The endpoint's secret, used to generate [webhook signatures](https://debi.pro/docs/api/#webhooks-security). 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: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Webhook '404': description: Not Found content: application/json: schema: description: Not Found response 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: Update a webhook description: Updates a 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: >- You can configure [webhook endpoints](https://debi.pro/docs/webhooks/) via the API to be notified about events that happen in your Debi account or connected accounts. Most users configure webhooks from [the dashboard](https://dashboard.debi.pro/webhooks), which provides a user interface for registering and testing your webhook endpoints. 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: Unique identifier for the object. type: string example: WHA8EJ1DkDnY readOnly: true object: type: string enum: - webhook url: description: The URL of the webhook endpoint. type: string example: https://debi.pro/webhook/200 maxLength: 5000 enabled: description: Whether the webhook is enabled. type: boolean enabled_events: description: > One of: `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: >- The endpoint's secret, used to generate [webhook signatures](https://debi.pro/docs/api/#webhooks-security). 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: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Webhook '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '422': description: Unprocessable Entity 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: Delete a webhook description: Delete a webhook. parameters: - name: id in: path description: Webhook ID. required: true schema: type: string example: WHq4VzyAzDgB responses: '201': description: OK '401': description: Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized 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: >- A filter on the list, based on the object `created_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. explode: true in: query name: created_at required: false schema: type: object properties: gt: description: Minimum value to filter by (exclusive) type: integer gte: description: Minimum value to filter by (inclusive) type: integer lt: description: Maximum value to filter by (exclusive) type: integer lte: description: Maximum value to filter by (inclusive) type: integer title: range_query_specs style: deepObject ending_before: name: ending_before description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. in: query required: false schema: type: string style: form limit: name: limit in: query description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 25. required: false schema: type: integer example: 20 starting_after: name: starting_after description: >- A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query required: false schema: type: string style: form schemas: '401': description: Unauthorized response type: object properties: message: type: string example: Unauthorized title: Unauthorized '404': description: Not Found response type: object properties: message: type: string example: Record not found title: Not Found name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' properties: {} example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' Customer: description: This object represents a customer of your organization. type: object properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer Links: description: Pagination links 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: Response Meta Meta: description: Pagination metadata 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: Pagination Cursor. type: - 'null' - string prev_cursor: description: Pagination Cursor. type: - 'null' - string title: Response Meta id: description: Unique identifier for the object. type: string readOnly: true Card: description: This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card Sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU CBU: description: This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU CVU: description: CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb Transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null PaymentMethod: description: This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method delivered_at: description: >- Time at which the event was delivered. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' Event: description: This object represents an event of your account. type: object properties: id: description: Unique identifier for the Event. type: string example: EVm3RnKn3knw readOnly: true object: type: string enum: - event created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: >- Time at which the event was delivered. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true resource: description: Resource attached to the event. type: string example: customer enum: - customer - gateway - import - mandate - payment - payment_method - subscription resource_id: description: ID for the resource attached to the event. type: string example: CS12312d1d1dl type: description: Event type. 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: Event approved_at: description: >- Time at which the gateway was marked as approved. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' supported_payment_methods: description: Supported payment methods for this 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: This object represents a gateway of your account. type: object properties: approved_at: description: >- Time at which the gateway was marked as approved. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' code_length: description: Code length type: - 'null' - number example: 8 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' disabled: description: Whether the gateway is disabled. type: boolean id: description: Unique identifier for the Gateway. type: string example: GWBZqKYEK7Y2 readOnly: true livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true number: description: Merchant identifier. type: string example: '123144' number_bank_retries: description: Number Bank Retries. type: - 'null' - number example: 0 object: type: string enum: - gateway provider: description: Provider. 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: Supported payment methods for this 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: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' username: description: Gateway current username. 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: Validation Error Export: description: Export object type: object properties: id: description: Unique identifier for the object. type: string readOnly: true object: description: String representing the object's type. type: string enum: - export type: description: The type of export type: string enum: - payments_monthly - accreditations_monthly - rejected_report - settlement_report - aggregated_rejections_report - new_customers format: description: The format of the export file type: string enum: - csv - xlsx status: description: The current status of the export type: string enum: - pending - processing - completed - failed download_url: description: URL to download the export file (available when status is completed) type: - 'null' - string format: uri file_size: description: Size of the export file in bytes type: - 'null' - integer rows_count: description: Number of rows in the export type: - 'null' - integer error_message: description: Error message if the export failed type: - 'null' - string filters: description: Filters applied to the export type: - 'null' - object livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' completed_at: description: When the export was completed type: - 'null' - string format: date-time required: - id - object - type - format - status - livemode - created_at - updated_at cancelled_at: description: >- Time at which the import was marked as cancelled. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' invalid_at: description: >- Time at which the import was marked as invalid. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' processed_at: description: >- Time at which the import was marked as processed. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' ready_at: description: >- Time at which the import was marked as ready. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' Import: description: This object represents an import of your account. type: object properties: id: description: Unique identifier for the Import. type: string example: IM129038120h readOnly: true batch_job: type: object additionalProperties: true properties: {} cancelled_at: description: >- Time at which the import was marked as cancelled. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' invalid_at: description: >- Time at which the import was marked as invalid. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' processed_at: description: >- Time at which the import was marked as processed. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' ready_at: description: >- Time at which the import was marked as ready. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' invalid_rows_count: description: Invalid Rows Count type: number example: 0 valid_rows_count: description: Valid Rows Count type: number example: 0 rows_count: description: Rows Count type: number example: 0 livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true original_filename: type: string example: subscriptions-import-template.csv type: description: Import Type type: string example: subscriptions status: description: Import Status type: string example: processed created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Import ImportRow: description: This object represents a row of an Import on your account. type: object properties: id: description: Unique identifier for the Import Row. type: string example: IR129038120h readOnly: true valid: description: Whether the import row is valid. type: boolean example: true data: description: Import Row content. type: object additionalProperties: true properties: {} livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true resource: description: Resource attached to the event. type: string example: customer enum: - customer - gateway - import - mandate - payment - payment_method - subscription resource_id: description: ID for the resource attached to the event. type: string example: CS12312d1d1dl created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Import Row uuid: description: UUID identifier for the object. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc extra_fields: description: > A collection of fields designed to be stored as [the metadata](#section/Metadata) of the object that the Session is generating whether it's a [Payment](#tag/Payments), [Subscription](#tag/Subscriptions), or [Mandate](#tag/Mandates). This functionality enables you to request extra information from the user during the checkout process, providing a means to store supplementary details about the object in a well-organized format. 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: > A collection of fields designed to be stored as [the metadata](#section/Metadata) of the [Customer](#tag/Customers) that the Session is generating. This functionality enables you to request extra information from the user during the checkout process, providing a means to store supplementary details about the object in a well-organized format. 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: > Binary mode forces instantaneous payment processing, returning an immediate and definitive status — either approved or rejected — within the same request response. This mode prevents inconclusive responses (such as payments with status `submitted`) by using only gateways that can process payments instantly, ensuring a fast and conclusive outcome. It is particularly useful when processing payments in a checkout flow that requires a synchronous response, allowing the customer to receive instant feedback on the transaction result. Also consider that this mode disables automatic retries for rejected payments, but this behavior can be managed also defining the maximum amount of times the payment could be retried automatically by setting the `auto_retries_max_attempts` parameter. type: boolean example: true payment_method_types: description: > Array of payment method types to allow. If not specified, all available payment methods will be allowed. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Configuration options for specific payment method types, such as disallowing certain card networks or funding types. 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: This object represents a public link of your organization. type: object properties: id: description: Unique identifier for the object. type: string readOnly: true uuid: description: UUID identifier for the object. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} extra_fields: description: > A collection of fields designed to be stored as [the metadata](#section/Metadata) of the object that the Session is generating whether it's a [Payment](#tag/Payments), [Subscription](#tag/Subscriptions), or [Mandate](#tag/Mandates). This functionality enables you to request extra information from the user during the checkout process, providing a means to store supplementary details about the object in a well-organized format. 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: > A collection of fields designed to be stored as [the metadata](#section/Metadata) of the [Customer](#tag/Customers) that the Session is generating. This functionality enables you to request extra information from the user during the checkout process, providing a means to store supplementary details about the object in a well-organized format. 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: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Title of the payment link type: string example: Monthly Subscription body: description: Description body of the payment link type: string example: Subscribe to our premium service button_text: description: Text for the payment button type: string example: Pay Now name_text: description: Text for the name field type: string example: Full Name success_url: description: URL to redirect after successful payment type: string format: uri example: https://example.com/success kind: description: Type of payment link type: string example: payment enum: - payment - subscription - mandate enabled: description: Whether the link is enabled type: boolean example: true smart_merge: description: Enable smart merge functionality type: boolean example: false binary_mode: description: > Binary mode forces instantaneous payment processing, returning an immediate and definitive status — either approved or rejected — within the same request response. This mode prevents inconclusive responses (such as payments with status `submitted`) by using only gateways that can process payments instantly, ensuring a fast and conclusive outcome. It is particularly useful when processing payments in a checkout flow that requires a synchronous response, allowing the customer to receive instant feedback on the transaction result. Also consider that this mode disables automatic retries for rejected payments, but this behavior can be managed also defining the maximum amount of times the payment could be retried automatically by setting the `auto_retries_max_attempts` parameter. type: boolean example: true payment_method_types: description: > Array of payment method types to allow. If not specified, all available payment methods will be allowed. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Configuration options for specific payment method types, such as disallowing certain card networks or funding types. 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: Available payment methods based on user's gateway configuration type: array items: type: object example: [] readOnly: true options: description: Payment options for the link 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: The public URL for this payment link type: string example: https://debi.pro/link/LKnJZX0DMv2Mzd4Qp6 readOnly: true title: Link Mandate: description: This object represents a mandate of your organization. type: object properties: id: description: Unique identifier for the Mandate. type: string example: MAmQ6j9NWxblNv readOnly: true status: description: Status. type: string enum: - active - revoked uuid: description: UUID identifier for the object. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc object: type: string enum: - mandate livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true customer: description: This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer payment_method: description: This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' title: Mandate amount: description: Amount. type: number example: 12.5 currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD Refund: description: This object represents a refunds of your organization. type: object properties: id: description: Unique identifier for the Refund. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [Payment ID](#tag/Payments). type: string example: PYgaZlLaPMZO amount: description: Refund amount. type: number example: 12.5 currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Refund Reason type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Refund Status type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} title: Refund Payment: description: This object represents a payments of your organization. type: object properties: id: description: Unique identifier for the Payment. type: string example: PYljikas9Fa8 readOnly: true object: type: string enum: - payment amount: description: Payment amount type: number example: 12.5 amount_refunded: description: Payment amount refunded. type: number example: 0 currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD description: description: Payment description type: string example: Ajuste por deuda pasada status: description: Payment Status type: string example: rejected enum: - pending_submission - cancelled - submitted - failed - will_retry - approved - rejected - chargeback - refunded - partially_refunded - requires_action - incomplete response_message: description: Financial institution detailed response type: string example: Falta de fondos rejection_code: description: Internal rejection code type: - 'null' - string example: null provider_rejection_code: description: Provider-specific rejection code type: - 'null' - string example: null paid: description: The payment has been succesfully collected. type: boolean example: false readOnly: true retryable: description: The payment can be retried. type: boolean example: true readOnly: true refundable: description: The payment can be refunded. type: boolean example: false readOnly: true amount_refundable: description: The amount of payment that can be refunded. type: number example: 0 livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' charge_date: description: >- A future date on which the payment should be collected. If not specified, the payment will be collected as soon as possible. type: string example: '2022-08-04' submissions_count: description: >- The number of time the payment has been sent to the financial institution. type: number example: 1 can_auto_retry_until: description: >- The latest date the payment will be sent to the financial institution. Null means no limit type: - 'null' - string example: '2022-08-31' auto_retries_max_attempts: description: >- The maximum number of times the payment could be automatically retried. type: - 'null' - number example: null effective_charged_date: description: The date when the payment will be collected. type: - 'null' - string example: null estimated_accreditation_date: description: >- The estimated date when the financial institution will send the amount collect to your account. type: - 'null' - string example: null updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_status: description: The latest date the payment status was changed. type: - 'null' - string example: '2022-08-31' customer: description: This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer subscription: description: >- The [Subscription](#tag/Subscriptions) associated with the payment if existent. type: - 'null' - string example: SBmX1MrZ77Mwq3 subscription_payment_number: description: The number of payment of the associated Subscription, if existent. type: - 'null' - string example: null gateway: description: The [Gateway](#tag/Gateways) associated with the payment. type: string example: GW1L49J7ARW3 session: description: >- The [Session](#tag/Sessions) associated with the payment if existent. type: - 'null' - string example: SS167GrPwXyd90qQoK payment_method: description: This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method gateway_identifier: description: >- The custom number you send to the gateway network. In most cases this value is null. type: - 'null' - string example: null binary_mode: description: > Binary mode forces instantaneous payment processing, returning an immediate and definitive status — either approved or rejected — within the same request response. This mode prevents inconclusive responses (such as payments with status `submitted`) by using only gateways that can process payments instantly, ensuring a fast and conclusive outcome. It is particularly useful when processing payments in a checkout flow that requires a synchronous response, allowing the customer to receive instant feedback on the transaction result. Also consider that this mode disables automatic retries for rejected payments, but this behavior can be managed also defining the maximum amount of times the payment could be retried automatically by setting the `auto_retries_max_attempts` parameter. type: boolean example: true next_action: description: Additional actions required for the payment type: - 'null' - object example: null recovery_link: description: URL for customer to recover/retry the payment type: string format: uri example: >- https://debi.test/session_recovery/payment?id=PYA8EJ1DkDnY&signature=... logs: description: Payment processing logs 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: Refunds associated with this payment. type: array items: title: Refund description: This object represents a refunds of your organization. type: object properties: id: description: Unique identifier for the Refund. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [Payment ID](#tag/Payments). type: string example: PYgaZlLaPMZO amount: description: Refund amount. type: number example: 12.5 currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Refund Reason type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Refund Status type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} example: [] metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} title: Payment completed_at: description: >- Time at which the sessions was completed. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' Session: description: This object represents a Session of your organization. type: object properties: id: description: Unique identifier for the Session. type: string example: SSmQ6j9NWxblNv readOnly: true uuid: description: UUID identifier for the object. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc object: type: string enum: - session description: description: Session description type: string example: Ajuste por deuda pasada amount: description: Amount to be collected. type: number example: 12.5 kind: type: string enum: - mandate - payment - subscription customer_id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true customer_name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro customer_email: description: The customer's email address. type: - 'null' - string example: mail@example.com customer_gateway_identifier: description: The customer's reference for bank account statements. type: - 'null' - string example: '383473' editable_amount: description: | Allow the customer to set the amount, useful for donations. type: boolean installments: description: > Only for payments, quantity of payments on which the amount will be splitted. type: integer max_installments: description: > Only for payments, allow the customer to choose how many installments can split the payment. type: integer interval_unit: description: > Only for subscriptions. The unit of time between customer charge dates. One of `weekly`, `monthly` or `yearly`. Example `monthly`. type: string interval: description: >- Only for subscriptions. Number of `interval_units` between customer charge dates. Must be greater than to 1. If `interval_units` is `weekly` and interval is 2, then the customer will be charged every two weeks. Defaults to 1. type: number day_of_month: description: >- Day of month, from 1 to 28. This field is required if interval_unit is set to monthly. Defaults to 1. type: number day_of_week: description: >- Day of week number, from 0 (Sunday) to 6 (Saturday). This field is required if `interval_unit` is set to `weekly`. type: number count: type: number editable_count: type: boolean name_text: type: string created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' completed_at: description: >- Time at which the sessions was completed. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true binary_mode: description: > Binary mode forces instantaneous payment processing, returning an immediate and definitive status — either approved or rejected — within the same request response. This mode prevents inconclusive responses (such as payments with status `submitted`) by using only gateways that can process payments instantly, ensuring a fast and conclusive outcome. It is particularly useful when processing payments in a checkout flow that requires a synchronous response, allowing the customer to receive instant feedback on the transaction result. Also consider that this mode disables automatic retries for rejected payments, but this behavior can be managed also defining the maximum amount of times the payment could be retried automatically by setting the `auto_retries_max_attempts` parameter. type: boolean example: true payment_gateway_identifier: description: >- The custom number you send to the gateway network. In most cases this value is null. type: - 'null' - string example: null public_uri: description: >- The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout. type: string readOnly: true success_url: description: >- The uri on which your customer will be redirected after completing the checkout. type: string link_id: description: Link ID. type: string example: LKLj0JV8xzdMoRk549 payment_method_types: description: > Array of payment method types to allow. If not specified, all available payment methods will be allowed. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Configuration options for specific payment method types, such as disallowing certain card networks or funding types. 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: Available payment methods based on user's gateway configuration type: array items: type: object example: [] readOnly: true title: Session Subscription: description: This object represents a subscription of your organization. type: object properties: id: description: Unique identifier for the Subscription. type: string example: SBmQ6j9NWxblNv readOnly: true object: type: string enum: - subscription amount: description: Subscription amount type: number example: 12.5 description: description: Subscription description type: string example: Ajuste por deuda pasada currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD status: description: Subscription Status type: string example: active enum: - active - paused - cancelled - finished - incomplete - incomplete_expired count: description: > The total number of payments that should be taken by this subscription. type: - 'null' - number example: 12 start_date: description: >- A future date on which the first payment of the subscription should be collected. type: string example: '2022-08-04' interval_unit: description: The unit of time between customer charge dates. type: string example: monthly enum: - weekly - monthly - yearly interval: description: >- Number of `interval_units` between customer charge dates. Must be greater than to 1. If `interval_units` is `weekly` and interval is 2, then the customer will be charged every two weeks. Defaults to 1. type: number example: 1 day_of_month: description: >- Day of month, from 1 to 28. This field is required if `interval_unit` is set to monthly. Defaults to 1. type: number day_of_week: description: >- Day of week number, from 0 (Sunday) to 6 (Saturday). This field is required if `interval_unit` is set to `weekly`. type: - 'null' - number livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: >- The maximum number of times the payments from this subscription could be automatically retried. type: - 'null' - number example: null first_date: description: >- The date on which the first payment should be charged. When left blank and month or day_of_month are provided, this will be set to the date of the first payment. If created without month or day_of_month this will be set as soon as possible. type: string example: '2022-08-04' upcoming_dates: description: Up to 5 upcoming payments charge dates. type: array items: type: string properties: {} example: - '2022-09-04' - '2022-10-04' - '2022-11-04' - '2022-12-04' - '2023-01-04' customer: description: This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer payment_method: description: This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. 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: Subscription first_payment_in_binary_mode: description: > Forces instantaneous payment processing for the first payment of the subscription. This provides an immediate status of either `approved` or `rejected` within the request response. This setting eliminates automatic retries for failed payments, ensuring a swift and conclusive outcome. When set to `true`, the payment is processed immediately. If it fails, the subscription will remain in state `incomplete` and no automatic retries will be attempted. type: boolean example: true Webhook: description: >- You can configure [webhook endpoints](https://debi.pro/docs/webhooks/) via the API to be notified about events that happen in your Debi account or connected accounts. Most users configure webhooks from [the dashboard](https://dashboard.debi.pro/webhooks), which provides a user interface for registering and testing your webhook endpoints. type: object properties: id: description: Unique identifier for the object. type: string example: WHA8EJ1DkDnY readOnly: true object: type: string enum: - webhook url: description: The URL of the webhook endpoint. type: string example: https://debi.pro/webhook/200 maxLength: 5000 enabled: description: Whether the webhook is enabled. type: boolean enabled_events: description: > One of: `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: >- The endpoint's secret, used to generate [webhook signatures](https://debi.pro/docs/api/#webhooks-security). 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: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: This object represents a customer of your organization. type: object properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer cvu: description: CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb event: description: This object represents an event of your account. type: object properties: id: description: Unique identifier for the Event. type: string example: EVm3RnKn3knw readOnly: true object: type: string enum: - event created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: >- Time at which the event was delivered. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true resource: description: Resource attached to the event. type: string example: customer enum: - customer - gateway - import - mandate - payment - payment_method - subscription resource_id: description: ID for the resource attached to the event. type: string example: CS12312d1d1dl type: description: Event type. 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: Event export: description: Export object type: object properties: id: description: Unique identifier for the object. type: string readOnly: true object: description: String representing the object's type. type: string enum: - export type: description: The type of export type: string enum: - payments_monthly - accreditations_monthly - rejected_report - settlement_report - aggregated_rejections_report - new_customers format: description: The format of the export file type: string enum: - csv - xlsx status: description: The current status of the export type: string enum: - pending - processing - completed - failed download_url: description: URL to download the export file (available when status is completed) type: - 'null' - string format: uri file_size: description: Size of the export file in bytes type: - 'null' - integer rows_count: description: Number of rows in the export type: - 'null' - integer error_message: description: Error message if the export failed type: - 'null' - string filters: description: Filters applied to the export type: - 'null' - object livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' completed_at: description: When the export was completed type: - 'null' - string format: date-time required: - id - object - type - format - status - livemode - created_at - updated_at gateway: description: This object represents a gateway of your account. type: object properties: approved_at: description: >- Time at which the gateway was marked as approved. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' code_length: description: Code length type: - 'null' - number example: 8 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' disabled: description: Whether the gateway is disabled. type: boolean id: description: Unique identifier for the Gateway. type: string example: GWBZqKYEK7Y2 readOnly: true livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true number: description: Merchant identifier. type: string example: '123144' number_bank_retries: description: Number Bank Retries. type: - 'null' - number example: 0 object: type: string enum: - gateway provider: description: Provider. 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: Supported payment methods for this 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: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' username: description: Gateway current username. type: string example: foo@bar.com title: Gateway import: description: This object represents an import of your account. type: object properties: id: description: Unique identifier for the Import. type: string example: IM129038120h readOnly: true batch_job: type: object additionalProperties: true properties: {} cancelled_at: description: >- Time at which the import was marked as cancelled. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' invalid_at: description: >- Time at which the import was marked as invalid. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' processed_at: description: >- Time at which the import was marked as processed. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' ready_at: description: >- Time at which the import was marked as ready. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' invalid_rows_count: description: Invalid Rows Count type: number example: 0 valid_rows_count: description: Valid Rows Count type: number example: 0 rows_count: description: Rows Count type: number example: 0 livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true original_filename: type: string example: subscriptions-import-template.csv type: description: Import Type type: string example: subscriptions status: description: Import Status type: string example: processed created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Import link: description: This object represents a public link of your organization. type: object properties: id: description: Unique identifier for the object. type: string readOnly: true uuid: description: UUID identifier for the object. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} extra_fields: description: > A collection of fields designed to be stored as [the metadata](#section/Metadata) of the object that the Session is generating whether it's a [Payment](#tag/Payments), [Subscription](#tag/Subscriptions), or [Mandate](#tag/Mandates). This functionality enables you to request extra information from the user during the checkout process, providing a means to store supplementary details about the object in a well-organized format. 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: > A collection of fields designed to be stored as [the metadata](#section/Metadata) of the [Customer](#tag/Customers) that the Session is generating. This functionality enables you to request extra information from the user during the checkout process, providing a means to store supplementary details about the object in a well-organized format. 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: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Title of the payment link type: string example: Monthly Subscription body: description: Description body of the payment link type: string example: Subscribe to our premium service button_text: description: Text for the payment button type: string example: Pay Now name_text: description: Text for the name field type: string example: Full Name success_url: description: URL to redirect after successful payment type: string format: uri example: https://example.com/success kind: description: Type of payment link type: string example: payment enum: - payment - subscription - mandate enabled: description: Whether the link is enabled type: boolean example: true smart_merge: description: Enable smart merge functionality type: boolean example: false binary_mode: description: > Binary mode forces instantaneous payment processing, returning an immediate and definitive status — either approved or rejected — within the same request response. This mode prevents inconclusive responses (such as payments with status `submitted`) by using only gateways that can process payments instantly, ensuring a fast and conclusive outcome. It is particularly useful when processing payments in a checkout flow that requires a synchronous response, allowing the customer to receive instant feedback on the transaction result. Also consider that this mode disables automatic retries for rejected payments, but this behavior can be managed also defining the maximum amount of times the payment could be retried automatically by setting the `auto_retries_max_attempts` parameter. type: boolean example: true payment_method_types: description: > Array of payment method types to allow. If not specified, all available payment methods will be allowed. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Configuration options for specific payment method types, such as disallowing certain card networks or funding types. 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: Available payment methods based on user's gateway configuration type: array items: type: object example: [] readOnly: true options: description: Payment options for the link 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: The public URL for this payment link type: string example: https://debi.pro/link/LKnJZX0DMv2Mzd4Qp6 readOnly: true title: Link mandate: description: This object represents a mandate of your organization. type: object properties: id: description: Unique identifier for the Mandate. type: string example: MAmQ6j9NWxblNv readOnly: true status: description: Status. type: string enum: - active - revoked uuid: description: UUID identifier for the object. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc object: type: string enum: - mandate livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true customer: description: This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer payment_method: description: This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' title: Mandate payment: description: This object represents a payments of your organization. type: object properties: id: description: Unique identifier for the Payment. type: string example: PYljikas9Fa8 readOnly: true object: type: string enum: - payment amount: description: Payment amount type: number example: 12.5 amount_refunded: description: Payment amount refunded. type: number example: 0 currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD description: description: Payment description type: string example: Ajuste por deuda pasada status: description: Payment Status type: string example: rejected enum: - pending_submission - cancelled - submitted - failed - will_retry - approved - rejected - chargeback - refunded - partially_refunded - requires_action - incomplete response_message: description: Financial institution detailed response type: string example: Falta de fondos rejection_code: description: Internal rejection code type: - 'null' - string example: null provider_rejection_code: description: Provider-specific rejection code type: - 'null' - string example: null paid: description: The payment has been succesfully collected. type: boolean example: false readOnly: true retryable: description: The payment can be retried. type: boolean example: true readOnly: true refundable: description: The payment can be refunded. type: boolean example: false readOnly: true amount_refundable: description: The amount of payment that can be refunded. type: number example: 0 livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' charge_date: description: >- A future date on which the payment should be collected. If not specified, the payment will be collected as soon as possible. type: string example: '2022-08-04' submissions_count: description: >- The number of time the payment has been sent to the financial institution. type: number example: 1 can_auto_retry_until: description: >- The latest date the payment will be sent to the financial institution. Null means no limit type: - 'null' - string example: '2022-08-31' auto_retries_max_attempts: description: >- The maximum number of times the payment could be automatically retried. type: - 'null' - number example: null effective_charged_date: description: The date when the payment will be collected. type: - 'null' - string example: null estimated_accreditation_date: description: >- The estimated date when the financial institution will send the amount collect to your account. type: - 'null' - string example: null updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_status: description: The latest date the payment status was changed. type: - 'null' - string example: '2022-08-31' customer: description: This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer subscription: description: >- The [Subscription](#tag/Subscriptions) associated with the payment if existent. type: - 'null' - string example: SBmX1MrZ77Mwq3 subscription_payment_number: description: The number of payment of the associated Subscription, if existent. type: - 'null' - string example: null gateway: description: The [Gateway](#tag/Gateways) associated with the payment. type: string example: GW1L49J7ARW3 session: description: >- The [Session](#tag/Sessions) associated with the payment if existent. type: - 'null' - string example: SS167GrPwXyd90qQoK payment_method: description: This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method gateway_identifier: description: >- The custom number you send to the gateway network. In most cases this value is null. type: - 'null' - string example: null binary_mode: description: > Binary mode forces instantaneous payment processing, returning an immediate and definitive status — either approved or rejected — within the same request response. This mode prevents inconclusive responses (such as payments with status `submitted`) by using only gateways that can process payments instantly, ensuring a fast and conclusive outcome. It is particularly useful when processing payments in a checkout flow that requires a synchronous response, allowing the customer to receive instant feedback on the transaction result. Also consider that this mode disables automatic retries for rejected payments, but this behavior can be managed also defining the maximum amount of times the payment could be retried automatically by setting the `auto_retries_max_attempts` parameter. type: boolean example: true next_action: description: Additional actions required for the payment type: - 'null' - object example: null recovery_link: description: URL for customer to recover/retry the payment type: string format: uri example: >- https://debi.test/session_recovery/payment?id=PYA8EJ1DkDnY&signature=... logs: description: Payment processing logs 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: Refunds associated with this payment. type: array items: title: Refund description: This object represents a refunds of your organization. type: object properties: id: description: Unique identifier for the Refund. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [Payment ID](#tag/Payments). type: string example: PYgaZlLaPMZO amount: description: Refund amount. type: number example: 12.5 currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Refund Reason type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Refund Status type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: > Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} example: [] metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} title: Payment payment_method: description: This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method refund: description: This object represents a refunds of your organization. type: object properties: id: description: Unique identifier for the Refund. type: string example: RFljikas9Fa8 readOnly: true object: type: string enum: - refund payment_id: description: | [Payment ID](#tag/Payments). type: string example: PYgaZlLaPMZO amount: description: Refund amount. type: number example: 12.5 currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD reason: description: Refund Reason type: string example: requested_by_customer enum: - duplicate - error - requested_by_customer status: description: Refund Status type: string example: approved enum: - pending_submission - submitted - failed - approved created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} title: Refund session: description: This object represents a Session of your organization. type: object properties: id: description: Unique identifier for the Session. type: string example: SSmQ6j9NWxblNv readOnly: true uuid: description: UUID identifier for the object. [Legacy] type: string example: 43751655-7580-4bd7-8bad-3c54ed1c4abc object: type: string enum: - session description: description: Session description type: string example: Ajuste por deuda pasada amount: description: Amount to be collected. type: number example: 12.5 kind: type: string enum: - mandate - payment - subscription customer_id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true customer_name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro customer_email: description: The customer's email address. type: - 'null' - string example: mail@example.com customer_gateway_identifier: description: The customer's reference for bank account statements. type: - 'null' - string example: '383473' editable_amount: description: | Allow the customer to set the amount, useful for donations. type: boolean installments: description: > Only for payments, quantity of payments on which the amount will be splitted. type: integer max_installments: description: > Only for payments, allow the customer to choose how many installments can split the payment. type: integer interval_unit: description: > Only for subscriptions. The unit of time between customer charge dates. One of `weekly`, `monthly` or `yearly`. Example `monthly`. type: string interval: description: >- Only for subscriptions. Number of `interval_units` between customer charge dates. Must be greater than to 1. If `interval_units` is `weekly` and interval is 2, then the customer will be charged every two weeks. Defaults to 1. type: number day_of_month: description: >- Day of month, from 1 to 28. This field is required if interval_unit is set to monthly. Defaults to 1. type: number day_of_week: description: >- Day of week number, from 0 (Sunday) to 6 (Saturday). This field is required if `interval_unit` is set to `weekly`. type: number count: type: number editable_count: type: boolean name_text: type: string created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' completed_at: description: >- Time at which the sessions was completed. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: - 'null' - string format: date-time example: '2022-02-11T23:19:22-03:00' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true binary_mode: description: > Binary mode forces instantaneous payment processing, returning an immediate and definitive status — either approved or rejected — within the same request response. This mode prevents inconclusive responses (such as payments with status `submitted`) by using only gateways that can process payments instantly, ensuring a fast and conclusive outcome. It is particularly useful when processing payments in a checkout flow that requires a synchronous response, allowing the customer to receive instant feedback on the transaction result. Also consider that this mode disables automatic retries for rejected payments, but this behavior can be managed also defining the maximum amount of times the payment could be retried automatically by setting the `auto_retries_max_attempts` parameter. type: boolean example: true payment_gateway_identifier: description: >- The custom number you send to the gateway network. In most cases this value is null. type: - 'null' - string example: null public_uri: description: >- The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout. type: string readOnly: true success_url: description: >- The uri on which your customer will be redirected after completing the checkout. type: string link_id: description: Link ID. type: string example: LKLj0JV8xzdMoRk549 payment_method_types: description: > Array of payment method types to allow. If not specified, all available payment methods will be allowed. type: array items: type: string enum: - card - cbu - cvu - sepa_debit - transfer example: - card - cbu - cvu payment_method_options: description: > Configuration options for specific payment method types, such as disallowing certain card networks or funding types. 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: Available payment methods based on user's gateway configuration type: array items: type: object example: [] readOnly: true title: Session subscription: description: This object represents a subscription of your organization. type: object properties: id: description: Unique identifier for the Subscription. type: string example: SBmQ6j9NWxblNv readOnly: true object: type: string enum: - subscription amount: description: Subscription amount type: number example: 12.5 description: description: Subscription description type: string example: Ajuste por deuda pasada currency: description: >- Currency for the transacion using [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217) codes. Defaults to account's default. type: string example: ARS enum: - ARS - BRL - CLP - COP - MXN - USB - USD status: description: Subscription Status type: string example: active enum: - active - paused - cancelled - finished - incomplete - incomplete_expired count: description: > The total number of payments that should be taken by this subscription. type: - 'null' - number example: 12 start_date: description: >- A future date on which the first payment of the subscription should be collected. type: string example: '2022-08-04' interval_unit: description: The unit of time between customer charge dates. type: string example: monthly enum: - weekly - monthly - yearly interval: description: >- Number of `interval_units` between customer charge dates. Must be greater than to 1. If `interval_units` is `weekly` and interval is 2, then the customer will be charged every two weeks. Defaults to 1. type: number example: 1 day_of_month: description: >- Day of month, from 1 to 28. This field is required if `interval_unit` is set to monthly. Defaults to 1. type: number day_of_week: description: >- Day of week number, from 0 (Sunday) to 6 (Saturday). This field is required if `interval_unit` is set to `weekly`. type: - 'null' - number livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: >- The maximum number of times the payments from this subscription could be automatically retried. type: - 'null' - number example: null first_date: description: >- The date on which the first payment should be charged. When left blank and month or day_of_month are provided, this will be set to the date of the first payment. If created without month or day_of_month this will be set as soon as possible. type: string example: '2022-08-04' upcoming_dates: description: Up to 5 upcoming payments charge dates. type: array items: type: string properties: {} example: - '2022-09-04' - '2022-10-04' - '2022-11-04' - '2022-12-04' - '2023-01-04' customer: description: This object represents a customer of your organization. type: object additionalProperties: false properties: id: description: Unique identifier for the Customer. type: string example: CSljikas98 readOnly: true name: description: The customer's full name or business name. type: - 'null' - string example: Jorgelina Castro email: description: The customer's email address. type: - 'null' - string example: mail@example.com object: type: string enum: - customer livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} mobile_number: description: The customer's mobile phone number. type: - 'null' - string example: '+5491123456789' default_payment_method_id: description: >- The ID of the default payment method to attach to this customer upon creation. type: - 'null' - string example: PMVdYaYwkqOw gateway_identifier: description: The customer's reference for bank account statements. type: - 'null' - string example: '383473' identification_number: description: Customer's Document ID number. type: - 'null' - string example: 15.555.324 identification_type: description: Customer's Document type. type: - 'null' - string example: DNI created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' deleted_at: description: >- Time at which the object was deleted. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Customer payment_method: description: This object represents a payment method of your account. type: object properties: id: description: Unique identifier for the object. type: string example: PMyma6Ql8Wo9 readOnly: true object: type: string enum: - payment_method type: description: >- Type of payment method. One of: `card`, `sepa_debit`, `cbu`, `cvu`, or `transfer`. type: string example: card enum: - card - sepa_debit - cbu - cvu - transfer card: description: This object represents a credit card of your account. type: object properties: country: description: >- Card's [ISO_3166-1_alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). type: string example: AR expiration_month: description: Expiration month. type: - 'null' - number example: 11 expiration_year: description: Expiration year. type: - 'null' - number example: 2030 fingerprint: description: >- Unique fingerprint for this credit card number of your account. type: string example: 8712yh2uihiu1123sxas funding: description: Type of funding of the Credit Card. type: string example: credit enum: - credit - debit - prepaid - unknown issuer: description: Card's issuer. type: - 'null' - string example: argencard last_four_digits: description: Credit's card last four digits. type: string example: '9876' name: description: Card's name. type: string example: Visa network: description: Card's network. type: string example: visa enum: - amex - diners - discover - favacard - jcb - mastercard - naranja - unknown - visa providers: description: >- Available providers on your account that can be used to process this payment method. For example: mercadopago, payway, etc. type: object properties: available: description: Available gateways for this card. type: array items: type: string properties: {} example: - fiserv-argentina preferred: description: Preferred gateway for this card. type: string example: fiserv-argentina title: Credit Card sepa_debit: description: >- This object represents a SEPA Debit used to debit bank accounts within the Single Euro Payments Area (SEPA) region. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - NL - ES fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: Enhanced bank account identification. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - santander-es preferred: description: Preferred gateway for this account. type: - 'null' - string example: santander-es title: CBU cbu: description: This object represents a CBU bank account of your account. type: object properties: bank: description: Bank. type: string country: description: Bank account country. type: string enum: - AR fingerprint: description: >- Unique fingerprint for this bank account number of your account. type: string example: 8712yh2uihiu1123sxas identification: description: >- Enhanced bank account identification. Contains the owners or co-owners of the account. Available upon request, contact Support. type: object last_four_digits: description: Bank account last four digits. type: string example: '9876' providers: description: >- Available providers on your account that can be used to process this payment method. For example: cbu-galicia, cbu-patagonia, cbu-bind, etc. type: object properties: available: description: Available gateways for this account. type: array items: type: string properties: {} example: - cbu-galicia preferred: description: Preferred gateway for this account. type: - 'null' - string example: cbu-galicia title: CBU cvu: description: CVU (Clave Virtual Uniforme) payment method details type: object properties: account_number: description: The CVU account number type: string example: '0001371211179340101691' last_four_digits: description: Last four digits of the CVU account number type: string example: '1691' providers: description: Available and preferred payment providers for this CVU type: object properties: available: description: List of available providers type: array items: type: string example: - bind-transfers preferred: description: Preferred provider for processing type: - 'null' - string example: bind-transfers fingerprint: description: Unique identifier for this CVU account type: string example: R1YRXJAn7SVSH8Jb transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: >- Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. type: - object - 'null' example: some: metadata additionalProperties: maxLength: 500 type: - string - 'null' - number - boolean properties: {} customer_id: description: The ID of the customer this payment method belongs to, if any type: - 'null' - string example: CSbJrDMEDaW9 created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' title: Payment Method metadata: description: | Set of [key-value pairs](#section/Metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting `null` value to `metadata`. 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: Subscription transfer: description: Bank transfer payment method details type: object properties: sender_id: description: ID of the sender for the transfer type: - 'null' - string example: null sender_name: description: Name of the sender for the transfer type: - 'null' - string example: null providers: description: Available and preferred payment providers for this transfer method type: object properties: available: description: List of available providers type: array items: type: string example: [] preferred: description: Preferred provider for processing type: - 'null' - string example: null webhook: description: >- You can configure [webhook endpoints](https://debi.pro/docs/webhooks/) via the API to be notified about events that happen in your Debi account or connected accounts. Most users configure webhooks from [the dashboard](https://dashboard.debi.pro/webhooks), which provides a user interface for registering and testing your webhook endpoints. type: object properties: id: description: Unique identifier for the object. type: string example: WHA8EJ1DkDnY readOnly: true object: type: string enum: - webhook url: description: The URL of the webhook endpoint. type: string example: https://debi.pro/webhook/200 maxLength: 5000 enabled: description: Whether the webhook is enabled. type: boolean enabled_events: description: > One of: `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: >- The endpoint's secret, used to generate [webhook signatures](https://debi.pro/docs/api/#webhooks-security). 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: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean example: true created_at: description: >- Time at which the object was created. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `2015-10-21T08:29:31-03:00`. type: string format: date-time example: '2022-02-11T23:19:22-03:00' updated_at: description: >- Time at which the object was last updated. Formatting follows [RFC339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8). Example: `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: Pagination metadata 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: Pagination Cursor. type: - 'null' - string prev_cursor: description: Pagination Cursor. type: - 'null' - string title: Response Meta links: description: Pagination links 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: Response Meta examples: customer: summary: Sample Customer 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: Sample Event 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: Sample 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: Sample 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: Sample 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: Sample Mandate 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: Sample Payment 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: Sample Payment Method 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: Sample Refund 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: Sample Session 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: Sample Subscription 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: Sample 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: > Authentication using the [publishable key](#section/Authentication). You should send the [Publishable API](#section/Authentication) key in the `key` field of your JSON payload. For Javascript flows. SecretKeyAuthentication: bearerFormat: auth-scheme scheme: bearer type: http description: > Authentication using the [secret key](#section/Authentication). You should send the [Secret API](#section/Authentication) key in the `Authorization` header using the [Bearer](https://tools.ietf.org/html/rfc6750#section-2.1) authentication scheme. tags: - name: Customers description: > This object represents a customer of your organization. It lets you create subscriptions and track payments that belong to the same customer. - name: Events description: > Events are our way of letting you know when something interesting happens in your account. When an interesting event occurs, we create a new Event object. For example, when a payment updates, we create a payment.updated event. Note that many API requests may cause multiple events to be created. For example, if you create a new subscription for a customer, you will receive both a customer.subscription.created event and a payment.created event. 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: Exports description: > Exports allow you to generate reports in various formats (CSV, Excel) for your data. You can export payments, customers, and other entities with customizable filters and date ranges. - name: Gateways description: > A gateway is a institution that authorizes and facilitates payments. It can be a payment processor, a bank, or a card network. In Debi, the gateway object represents the specific configuration and credentials that your company uses to access each service. - name: Imports description: > An Import is an object which contains data to be created in Debi. As these objects may be big, they will be created and processed later. You can check the status of the import. - name: Links description: > A link is a shareable URL that will take your customers to a hosted page. Links can create mandates, payments, or subscription easily. A link can be shared and used multiple times. When a customer opens a payment link, the next step will create a new checkout session to render the page. You can use checkout session events to track the results. - name: Mandates description: > A Mandate is a record of the permission a customer has given you to debit their payment method. - name: Payment Methods description: > PaymentMethod objects represent your customer's payment instruments. You can use them with to create Payments or Subscriptions to a Customer. Also you can create them for tokenization, validation, classification, identification or future use on payments. - name: Payments description: > A Payment is an object you create to charge a credit, debit card, or bank account. You can retrieve information about the payment and also refund them partially or totally. | Status | Meaning | | -------------------- | ---------------------------------------------------------------------------------- | | `pending_submission` | The payment has been issued, but still not submitted to the finnancial entity | | `cancelled` | The payment has been manually cancelled | | `submitted` | The payment is succesfully submitted and being processing by the finnancial entity | | `failed` | Couldn't be submitted to the finnancial entity. There is an error in the request | | `will_retry` | The attempt failed, but the finnancial entity will make a new attempt | | `approved` | Submitted OK and approved | | `rejected` | Submitted OK but couldn't make the collection | | `chargeback` | The customer asked the bank to get them their money back | | `refunded` | The payment has been returned to the customer | | `partially_refunded` | A partial amount of the payment has been returned to the customer | | `requires_action` | The payment requires additional action from the customer | | `incomplete` | The payment is incomplete and waiting for additional information (Payment Method) | - name: Refunds description: > Refund objects allow you to refund a payment that has previously been created but not yet totally refunded. Funds will be refunded to the credit, debit card, or bank account that was originally charged. | Status | Meaning | | -------------------- | --------------------------------------------------------------------------------- | | `pending_submission` | The refund has been issued, but still not submitted to the finnancial entity | | `submitted` | The refund is succesfully submitted and being processing by the finnancial entity | | `failed` | Submitted OK but rejected by the finnancial entity | | `approved` | Submitted OK and approved | - name: Sessions description: > Sessions enable you to use Debi's hosted payment pages to set up mandates, subscriptions or payments with your customers. First you create a Session for your customer, and redirect them to the returned redirect url. Your customer supplies their name, email, address, and bank account or card details, and submits the form. This securely stores their details, and redirects them back to your `back_url` with `session_id=THE_SESSION_ID` in the querystring. You complete the Session, which creates a customer, payment method, and either payment, mandate or subscription, and returns the ID of the session. With this data you may wish to create a subscription or payment at this point. Once you have completed the Session via the API, you should display a confirmation page to your customer, confirming that data has been set up. You can build your own page, or redirect to the one we provide in the `confirmation_url` attribute of the Session. Session expire after completed. You cannot complete an expired or already completed Session. - name: Subscriptions description: > Subscriptions allow you to charge a customer on a recurring basis according to a schedule. | Status | Meaning | | ------------ | ---------------------------------------------------------------------------------------- | | `active` | The subscription is active and generating payments. | | `paused` | The subscription have been manually paused and won't generate payments until is resumed. | | `cancelled` | The subscription have been manually cancelled. | | `finished` | The subscription is completed: all the payments were created succesfully. | | `incomplete` | The subscription is incomplete and waiting for additional information. | - name: Webhooks description: > Webhooks are endpoints you can configure to be notified about events that happen in your Debi account. Most users configure Webhooks from the dashboard, which provides a user interface for registering and testing your webhook endpoints. externalDocs: description: Debi Docs. url: https://debi.pro/docs security: - SecretKeyAuthentication: []