Saltar al contenido principal

TuCuota API (2022-08-01)

Download OpenAPI specification:Download

Introducción

TuCuota tiene una API REST. Nuestra API tiene direcciones URL predecibles orientadas a los recursos, acepta solicitudes JSON, devuelve respuestas JSON y utiliza códigos de respuesta, autenticación y verbos HTTP estándar.

Las URLs de la API de TuCuota API son:

Content type

La API de TuCuota sólo soporta JSON. No te olvides de incluir el siguiente header en tus requests.

Content-Type Header

Content-Type: "application/json"

Autenticación

La API solo está disponible a través de HTTPS. Intentar acceder a la API a través de una conexión HTTP no segura devolverá un error tls_required.

Crear una clave API

Para crear nuevas claves API, visite la sección de desarrolladores de nuestro sitio.

Para cada entorno (producción y sandbox), encontrará dos tipos de claves de API:

  • Pública (pk_...): puede aparecer en su código del lado del cliente para tokenizar los métodos de pago.
  • Secreta (sk_...): Para ser utilizado en el lado del servidor. Debe ser secreto y almacenarse de forma segura en el código de su aplicación para comunicarse con la API de TuCuota.

Para autenticarse, debe utilizar la clave de API en un Header del request HTTP al realizar solicitudes en la API.

Example Authentication Header

Authorization: Bearer sk_live_...

Todas las solicitudes de API deben realizarse a través de HTTPS. Las llamadas realizadas a través de HTTP fallarán. Las solicitudes de API sin autenticación también fallarán.

Errores

This API uses HTTP status codes to communicate with the API consumer.

  • 200 OK - Response to a successful GET, PUT, PATCH or DELETE.
  • 201 Created - Response to a POST that results in a creation.
  • 204 No Content - Response to a successful request that won't be returning a body (like a DELETE request).
  • 400 Bad Request - Malformed request.
  • 401 Unauthorized - When no or invalid authentication details are provided.
  • 403 Forbidden - When authentication succeeded but authenticated user doesn't have access to the resource.
  • 404 Not Found - When a non-existent resource is requested.
  • 405 Method Not Allowed - Method not allowed.
  • 406 Not Acceptable - Could not satisfy the request Accept header.
  • 415 Unsupported Media Type - Unsupported media type in request.
  • 422 Unprocessable Entity - Form validation errors.

Respuestas de Error

Esta API devuelve códigos de error legibles por máquina y mensajes de error legibles por humanos cuando hay un error.

Ejemplos
Error de Validación
{
  "message": "The given data was invalid.",
  "errors": {
    "organization_name": ["El campo debe tener algún valor."],
    "mobile_number": ["El campo debe tener algún valor."],
    "province": ["El campo debe tener algún valor."],
    "locality": ["El campo debe tener algún valor."],
    "address": ["El campo debe tener algún valor."]
  }
}
Error Genérico
{
  "message": "Unauthenticated."
}

Idempotencia

La API admite la idempotencia para volver a intentar solicitudes de forma segura sin realizar accidentalmente la misma operación dos veces. Esto es útil cuando una llamada API se interrumpe en tránsito y no recibe una respuesta. Por ejemplo, si una solicitud para crear un pago no responde debido a un error de conexión a la red, puede volver a intentar la solicitud con la misma clave de idempotencia para garantizar que no se cree más de un cargo.

Para realizar una solicitud idempotente, envía un encabezado Idempotency-Key: <key> adicional en la llamada HTTP.

La idempotencia funciona guardando el código de estado y el contenido de la primera solicitud realizada para cualquier clave de idempotencia dada, independientemente de si tuvo éxito o no. Las solicitudes posteriores con la misma clave devuelven el mismo resultado, incluidos los errores 500.

Una clave de idempotencia es un valor único generado por el cliente que el servidor utiliza para reconocer reintentos posteriores de la misma solicitud. La forma en que crea claves únicas depende de usted, pero sugerimos usar UUID V4 u otra cadena aleatoria con suficiente entropía para evitar colisiones.

Las claves son elegibles para eliminarse del sistema después de que tengan al menos 24 horas de antigüedad, y se genera una nueva solicitud si una clave se reutiliza después de que se eliminó la original. La capa de idempotencia compara los parámetros entrantes con los de la solicitud original y los errores a menos que sean los mismos para evitar el uso indebido accidental.

Los resultados solo se guardan si un extremo de la API comenzó a ejecutarse. Si los parámetros entrantes fallaron en la validación o la solicitud entró en conflicto con otra que se estaba ejecutando al mismo tiempo, no se guarda ningún resultado idempotente porque ningún extremo de la API comenzó a ejecutarse. Es seguro volver a intentar estas solicitudes.

Todas las solicitudes POST aceptan claves de idempotencia. El envío de claves de idempotencia en solicitudes GET y DELETE no tiene ningún efecto y debe evitarse, ya que estas solicitudes son idempotentes por definición.

Metadata

Los siguientes objetos tienen un parámetro metadata que puedes usar para guardar pares de clave-valor:

La metadata es útil para almacenar información estructurada adicional sobre un objeto.

No almacene información confidencial (números de cuentas bancarias, detalles de tarjetas, etc.) como metadata.

Paginación

Todos los recursos de la API pueden listarse a través de métodos de la API. Por ejemplo, puede obtener pagos, obtener clientes y obtener suscripciones. Estos métodos API de lista comparten una estructura común, tomando al menos estos tres parámetros: limit, starting_after y ending_before.

La respuesta de un método API de lista representa una sola página en un orden cronológico inverso. Si no especificas starting_after o ending_before, recibirás la primera página de este objecto, que contiene los objetos más nuevos. Puede especificar un ID en el campo starting_after para obtener la página de objetos más antiguos que aparecen inmediatamente después del objeto en cuestión. De manera similar, puedes especificar ending_before para recibir una página de objetos más nuevos que ocurren inmediatamente antes del objeto en cuestión. Los objetos de una página siempre aparecen en orden cronológico inverso. Solo se puede usar starting_after o ending_before.

IDs de Request

Cada request a la API tiene un identificador de request asociado. Puede encontrar este valor en el header Request-Id. También puede encontrar estos IDs en logs de requests en su Panel.

Convenciones

Notational Conventions

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC2119.

HTTP Methods

This API uses HTTP verbs (methods) as following:

  • GET - Read - used to read (or retrieve) a representation of a resource,
  • POST - Create - used to create new resources. In particular, it's used to create subordinate resources.
  • PUT - Update/Replace - used for update capabilities, PUT-ing to a known resource URI with the request body containing the newly-updated representation of the original resource. On successful request, replaces identified resource with the request body.
  • PATCH - Update/Modify - used for modify capabilities. The PATCH request only needs to contain the changes to the resource, not the complete resource.
  • DELETE - Delete - used to delete a resource identified by a URI.

Representation of Date and Time

All exchange of date and time-related data MUST be done according to RFC339 standard.

Versioning

This API uses Api-Version header to identify requested version. Every minor version SHOULD be backward compatible. However, major versions MAY introduce breaking changes.

Api-Version:

This header SHOULD be present in every request. If not, API MUST use the newest available major release.

If requested version is not available, API SHOULD try to fall back to the next available minor release.

When backwards-incompatible changes are made to the API, a new, dated version is released. The current version of the API is 2022-02-14.

Resource IDs

This API uses short non-sequential url-friendly unique ids. Every resource id MUST consists of 12 url-friendly characters: A-Z, a-z, 0-9, _ and -.

Example

PY6b3Rr6nRMo

Tarjetas de prueba

En modo sandbox, las siguientes tarjetas de prueba y CBU se pueden usar para crear pagos que producen respuestas específicas útiles para probar diferentes escenarios.

Marca Número Resultado
cbu 2859363672283668188432 approved
cbu 2852656051819605126406 rejected
cbu 2858814288841490615567 failed
cbu 0110022831266917230013 will_retry
mastercard 5447651834106668 approved
mastercard 5457948807868523 rejected
mastercard 5292525121482410 failed
visa 4024007127322104 approved
visa 4532417816926690 approved*
visa 4556854712355908 rejected
visa 4485388690536078 failed
amex 377539501632477 approved
amex 341400508811411 rejected
amex 372974912152697 failed

* Usando el número 4532417816926690 también emitirá un evento payment_method.automatically_updated, que informa que el número de un método de pago ha sido actualizado automáticamente.

Notificaciones de Webhook

Los webhooks son URLs que puedes configurar para recibir notificaciones sobre eventos que suceden en tu cuenta de TuCuota. La mayoría de los usuarios configuran los webhooks desde el panel, que proporciona una interfaz de usuario para registrar y probar sus webhooks.

Webhook de ejemplo:
{
  "id": "EVPYeJeyeJ7r",
  "created_at": "2019-05-23T20:18:28-0300",
  "data": {
    "object": {
      "id": "CS9PL8eeo8aB",
      "paid": false,
      "amount": 1600,
      "status": "pending_submission",
      "gateway": "GWd1e9nQwK7v",
      "currency": "ARS",
      "customer": {
        "id": "CS9PL8eeo8aB",
        "name": "Máximo Irizarry",
        "email": "mirrizarry@paez.com",
        "livemode": true,
        "metadata": { "key": "value" },
        "created_at": "2018-05-01T11:45:14-0300",
        "updated_at": "2018-05-01T11:45:14-0300",
        "gateway_identifier": "001234",
        "mobile_number": "+5493812596655",
        "identification_type": "",
        "identification_number": ""
      },
      "livemode": true,
      "metadata": { "key": "value" },
      "retryable": false,
      "created_at": "2018-05-01T11:45:14-0300",
      "updated_at": "2018-05-01T11:45:14-0300",
      "charge_date": "2019-05-15",
      "description": "Pago extra",
      "subscription": null,
      "name": "Máximo Irizarry",
      "email": "mirrizarry@paez.com",
      "gateway_identifier": "456700",
      "mobile_number": "+5493812596655",
      "identification_type": "",
      "identification_number": ""
    }
  },
  "livemode": true,
  "resource": "payment",
  "resource_id": "PY6b3Rr6nRMo",
  "type": "payment.retrying"
}

Cuando ocurre un evento en su cuenta, lo enviaremos a cada webhook habilitado como una solicitud POST.

Tipos de eventos de Webhooks

  • customer.created
  • customer.disabled
  • customer.restored
  • customer.updated
  • gateway.created
  • gateway.disabled
  • gateway.updated
  • payment.cancelled
  • payment.created
  • payment.retrying
  • payment.updated
  • payment_method.automatically_updated
  • payment_method.created
  • payment_method.updated
  • subscription.cancelled
  • subscription.created
  • subscription.finished
  • subscription.paused
  • subscription.resumed
  • subscription.updated
  • user.updated_available_brands

Prueba de los webhooks en entornos locales

You can easy create test webhooks using https://webhook.site/ With that you will be able to see what we are sending to our API consumers.

Also, to start integrating the webhooks, your code will need to be accessible from the internet so TuCuota can reach it with HTTP requests. If you’re working locally, the easiest way to do this is with ngrok.

Asegurando los Webhooks

TuCuota signs the webhook events it sends to your endpoints by including a signature in each event’s TuCuota-Signature header. This allows you to verify that the events were sent by TuCuota, not by a third party.

Before you can verify signatures, you need to retrieve your endpoint’s secret "Secreto webhook" from your webhooks in our developers panel. Add or select the endpoint you want to obtain the secret for, then click the "mostrar" button.

TuCuota 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, TuCuota starts to sign each webhook it sends to the endpoint.

Webhooks authenticity validation steps

TuCuota 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.

Clientes

Este objeto representa a un cliente de su organización. Le permite crear suscripciones y realizar un seguimiento de los pagos que pertenecen al mismo cliente.

id
string

Identificador único del Cliente.

name
string or null

El nombre completo del cliente.

email
string or null

El email del cliente.

object
string
Value: "customer"
livemode
boolean

Tiene el valor true si el objeto existe en mode de producción o el valor false si el objeto existe en modo de prueba.

object or null

Conjunto de pares clave/valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información sobre el objeto en un formato estructurado. Todas las claves se pueden borrar publicando un valor nulo en metadatos.

null or string

Número de teléfono válido del cliente (con código de área).

gateway_identifier
string or null

La referencia del cliente en los extractos bancarios.

null or string

Número del Documento del cliente.

null or string

Tipo de Documento del cliente.

created_at
string <date-time>

Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

updated_at
string <date-time>

Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

null or string <date-time>

Hora en la que se eliminó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

{
  • "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": {
    },
  • "livemode": true,
  • "created_at": "2021-07-05T12:24:32-03:00",
  • "updated_at": "2021-07-05T12:24:32-03:00",
  • "deleted_at": null
}

Obtener todos los clientes

Por defecto, los clientes más nuevos serán los primeros en la lista.

Authorizations:
SecretKeyAuthentication
query Parameters
all
boolean

Incluye clientes archivados.

object (range_query_specs)

Un filtro en la lista, basado en el campo created_at del objeto. El valor puede ser un Unix Timestamp, o puede ser un diccionario con varias opciones de consulta diferentes.

ending_before
string

Un cursor para utilizar en la paginación. ending_before es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, comenzando con obj_ID, la próxima llamda puede incluir ending_before=obj_ID para obtener la página previa.

limit
integer
Example: limit=20

Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25.

starting_after
string

Un cursor para utilizar en la paginación. starting_after es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, terminando con obj_ID, la próxima llamda puede incluir starting_after=obj_ID para obtener la página siguiente.

Responses

Response Schema: application/json
required
Array of objects (Cliente)
object (Metadata de Respuesta)

Links de paginación

object (Response Meta)

Metadata de paginación

Request samples

curl --request GET \
  --url 'https://api.tucuota.com/v1/customers?all=SOME_BOOLEAN_VALUE&created_at=SOME_OBJECT_VALUE&ending_before=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer sk_live_...'

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {}
}

Crear un cliente

Crear un cliente.

Authorizations:
SecretKeyAuthentication
Request Body schema: application/json
name
string or null

El nombre completo del cliente.

email
string or null

El email del cliente.

gateway_identifier
string or null

La referencia del cliente en los extractos bancarios.

null or string

Tipo de Documento del cliente.

null or string

Número del Documento del cliente.

object or null

Conjunto de pares clave/valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información sobre el objeto en un formato estructurado. Todas las claves se pueden borrar publicando un valor nulo en metadatos.

Responses

Response Schema: application/json
object (Cliente)

Este objeto representa a un cliente de su organización.

id
string

Identificador único del Cliente.

name
string or null

El nombre completo del cliente.

email
string or null

El email del cliente.

object
string
Value: "customer"
livemode
boolean

Tiene el valor true si el objeto existe en mode de producción o el valor false si el objeto existe en modo de prueba.

object or null

Conjunto de pares clave/valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información sobre el objeto en un formato estructurado. Todas las claves se pueden borrar publicando un valor nulo en metadatos.

null or string

Número de teléfono válido del cliente (con código de área).

gateway_identifier
string or null

La referencia del cliente en los extractos bancarios.

null or string

Número del Documento del cliente.

null or string

Tipo de Documento del cliente.

created_at
string <date-time>

Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

updated_at
string <date-time>

Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

null or string <date-time>

Hora en la que se eliminó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

Request samples

Content type
application/json
{
  • "name": "Pedro Lombardo",
  • "email": "pedrolombardo@email.com",
  • "gateway_identifier": "1234",
  • "identification_type": "DNI",
  • "identification_number": "237767265",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obtener un cliente

Obtener un cliente.

Authorizations:
SecretKeyAuthentication
path Parameters
id
required
string
Example: CS9PL8eeo8aB

Responses

Response Schema: application/json
object (Cliente)

Este objeto representa a un cliente de su organización.

id
string

Identificador único del Cliente.

name
string or null

El nombre completo del cliente.

email
string or null

El email del cliente.

object
string
Value: "customer"
livemode
boolean

Tiene el valor true si el objeto existe en mode de producción o el valor false si el objeto existe en modo de prueba.

object or null

Conjunto de pares clave/valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información sobre el objeto en un formato estructurado. Todas las claves se pueden borrar publicando un valor nulo en metadatos.

null or string

Número de teléfono válido del cliente (con código de área).

gateway_identifier
string or null

La referencia del cliente en los extractos bancarios.

null or string

Número del Documento del cliente.

null or string

Tipo de Documento del cliente.

created_at
string <date-time>

Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

updated_at
string <date-time>

Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

null or string <date-time>

Hora en la que se eliminó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

Request samples

curl --request GET \
  --url https://api.tucuota.com/v1/customers/CS9PL8eeo8aB \
  --header 'Authorization: Bearer sk_live_...'

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualiza un cliente

Actualiza un cliente.

Authorizations:
SecretKeyAuthentication
path Parameters
id
required
string
Example: CS9PL8eeo8aB
Request Body schema: application/json
name
string or null

El nombre completo del cliente.

email
string or null

El email del cliente.

gateway_identifier
string or null

La referencia del cliente en los extractos bancarios.

null or string

Tipo de Documento del cliente.

null or string

Número del Documento del cliente.

object or null

Conjunto de pares clave/valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información sobre el objeto en un formato estructurado. Todas las claves se pueden borrar publicando un valor nulo en metadatos.

Responses

Response Schema: application/json
object (Cliente)

Este objeto representa a un cliente de su organización.

id
string

Identificador único del Cliente.

name
string or null

El nombre completo del cliente.

email
string or null

El email del cliente.

object
string
Value: "customer"
livemode
boolean

Tiene el valor true si el objeto existe en mode de producción o el valor false si el objeto existe en modo de prueba.

object or null

Conjunto de pares clave/valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información sobre el objeto en un formato estructurado. Todas las claves se pueden borrar publicando un valor nulo en metadatos.

null or string

Número de teléfono válido del cliente (con código de área).

gateway_identifier
string or null

La referencia del cliente en los extractos bancarios.

null or string

Número del Documento del cliente.

null or string

Tipo de Documento del cliente.

created_at
string <date-time>

Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

updated_at
string <date-time>

Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

null or string <date-time>

Hora en la que se eliminó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

Request samples

Content type
application/json
{
  • "name": "Pedro Lombardo",
  • "email": "pedrolombardo@email.com"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Archivar un cliente

Archivar un cliente y cancelar suscripciones y pagos en proceso.

Authorizations:
SecretKeyAuthentication
path Parameters
id
required
string
Example: CS9PL8eeo8aB

Responses

Request samples

curl --request POST \
  --url https://api.tucuota.com/v1/customers/CS9PL8eeo8aB/actions/archive \
  --header 'Authorization: Bearer sk_live_...'

Response samples

Content type
application/json
{
  • "message": "Archived successfully"
}

Restaurar un cliente

Restaurar inmediatamente un cliente.

Authorizations:
SecretKeyAuthentication
path Parameters
id
required
string
Example: CS9PL8eeo8aB

Responses

Request samples

curl --request POST \
  --url https://api.tucuota.com/v1/customers/CS9PL8eeo8aB/actions/restore \
  --header 'Authorization: Bearer sk_live_...'

Response samples

Content type
application/json
{
  • "message": "Restored successfully"
}

Buscar clientes

Buscar clientes.

Authorizations:
SecretKeyAuthentication
query Parameters
q
required
string
Example: q=john doe
limit
integer
Example: limit=20

Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25.

page
required
string
Example: page=john doe

Un cursor para la paginación en varias páginas de resultados. No incluya este parámetro en la primera llamada. Utilice el valor de next_page devuelto en una respuesta anterior para solicitar resultados posteriores.

Responses

Response Schema: application/json
required
Array of objects (Cliente)
object (Metadata de Respuesta)

Links de paginación

object (Response Meta)

Metadata de paginación

Request samples

curl --request GET \
  --url 'https://api.tucuota.com/v1/customers/search?q=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&page=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer sk_live_...'

Response samples

Content type
application/json
{}

Eventos

Los eventos son nuestra forma de avisarte cuando sucede algo interesante en tu cuenta. Cuando ocurre un evento, creamos un nuevo objeto Evento. Por ejemplo, cuando se actualiza un pago, creamos un evento de pago actualizado. Tenga en cuenta que muchas solicitudes de API pueden provocar la creación de varios eventos. Por ejemplo, si crea una nueva suscripción para un cliente, recibirá un evento creado por la suscripción del cliente y un evento creado por el pago.

Los eventos ocurren cuando cambia el estado de otro recurso API. El estado del recurso al momento del cambio está embebido en el campo data del evento. Por ejemplo, un evento de payment.updated contendrá un pago y un evento customer.created contendrá un cliente.

id
string

Identificador único del Evento.

object
string
Value: "event"
created_at
string <date-time>

Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

object
delivered_at
string or null <date-time>

Hora en que se entregó el evento. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

livemode
boolean

Tiene el valor true si el objeto existe en mode de producción o el valor false si el objeto existe en modo de prueba.

resource
string
Enum: "customer" "gateway" "import" "mandate" "payment" "payment_method" "subscription"

Recurso relacionado con el evento.

resource_id
string

ID del recurso relacionado con el evento.

type
string
Enum: "customer.created" "customer.disabled" "customer.restored" "customer.updated" "gateway.created" "gateway.disabled" "gateway.enabled" "gateway.updated" "import.processed" "mandate.created" "mandate.restored" "mandate.revoked" "payment.cancelled" "payment.created" "payment.retrying" "payment.updated" "payment_method.automatically_updated" "payment_method.created" "payment_method.updated" "refund.approved" "refund.created" "refund.failed" "subscription.automatically_paused" "subscription.cancelled" "subscription.created" "subscription.finished" "subscription.paused" "subscription.resumed" "subscription.updated" "user.updated_available_brands"

Tipo de evento.

{
  • "created_at": "2022-02-05T01:42:13-03:00",
  • "data": {
    },
  • "delivered_at": "2022-02-11T20:11:38-03:00",
  • "id": "EVaX3JagwR6x",
  • "livemode": true,
  • "object": "event",
  • "resource": "customer",
  • "resource_id": "CSnlZxyY3jwr",
  • "type": "customer.created"
}

Obtener eventos

Obtener una lista páginada por cursor de tus eventos.

Authorizations:
SecretKeyAuthentication
query Parameters
delivery_success
boolean

Filtre los eventos según si todos los webhooks se entregaron correctamente. Si es falso, se muestran eventos que aún están pendientes o cuyos intentos intentos de entrega hayan fallado.

related_object
string <= 255 characters
Example: related_object=CS9PL8eeo8aB

Filtra eventos para un objeto en particular. Puede recibir cualquier ID de cualquier objecto.

type
string <= 255 characters

Puede contener un nombre de evento específico o un grupo de eventos utilizando * como comodín. La lista se filtrará para incluir solo eventos con que coincidan.

object (range_query_specs)

Un filtro en la lista, basado en el campo created_at del objeto. El valor puede ser un Unix Timestamp, o puede ser un diccionario con varias opciones de consulta diferentes.

ending_before
string

Un cursor para utilizar en la paginación. ending_before es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, comenzando con obj_ID, la próxima llamda puede incluir ending_before=obj_ID para obtener la página previa.

limit
integer
Example: limit=20

Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25.

starting_after
string

Un cursor para utilizar en la paginación. starting_after es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, terminando con obj_ID, la próxima llamda puede incluir starting_after=obj_ID para obtener la página siguiente.

Responses

Response Schema: application/json
Array of objects (Evento)
object (Metadata de Respuesta)

Links de paginación

object (Response Meta)

Metadata de paginación

Request samples

curl --request GET \
  --url 'https://api.tucuota.com/v1/events?delivery_success=SOME_BOOLEAN_VALUE&related_object=SOME_STRING_VALUE&type=SOME_STRING_VALUE&created_at=SOME_OBJECT_VALUE&ending_before=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer sk_live_...'

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {}
}

Obtener un evento

Obtener un evento.

Authorizations:
SecretKeyAuthentication
path Parameters
id
required
string
Example: EVaX3JagwR6x

Responses

Response Schema: application/json
object (Evento)

Este objeto representa un evento en tu cuenta.

id
string

Identificador único del Evento.

object
string
Value: "event"
created_at
string <date-time>

Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

object
delivered_at
string or null <date-time>

Hora en que se entregó el evento. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

livemode
boolean

Tiene el valor true si el objeto existe en mode de producción o el valor false si el objeto existe en modo de prueba.

resource
string
Enum: "customer" "gateway" "import" "mandate" "payment" "payment_method" "subscription"

Recurso relacionado con el evento.

resource_id
string

ID del recurso relacionado con el evento.

type
string
Enum: "customer.created" "customer.disabled" "customer.restored" "customer.updated" "gateway.created" "gateway.disabled" "gateway.enabled" "gateway.updated" "import.processed" "mandate.created" "mandate.restored" "mandate.revoked" "payment.cancelled" "payment.created" "payment.retrying" "payment.updated" "payment_method.automatically_updated" "payment_method.created" "payment_method.updated" "refund.approved" "refund.created" "refund.failed" "subscription.automatically_paused" "subscription.cancelled" "subscription.created" "subscription.finished" "subscription.paused" "subscription.resumed" "subscription.updated" "user.updated_available_brands"

Tipo de evento.

Request samples

curl --request GET \
  --url https://api.tucuota.com/v1/events/EVaX3JagwR6x \
  --header 'Authorization: Bearer sk_live_...'

Response samples

Content type
application/json
{
  • "data": {
    }
}

Gateways

Un Gateway es un objeto

approved_at
string <date-time>

Hora en la que el gateway se marcó como aprobado. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

code_length
number or null

Longitud del código

created_at
string <date-time>

Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

disabled
boolean

Declara si el gateway está deshabilitado.

id
string

Identificador único del Gateway.

livemode
boolean

Tiene el valor true si el objeto existe en mode de producción o el valor false si el objeto existe en modo de prueba.

number
string

Identificador para el procesador.

number_bank_retries
number or null

Número de reintentos bancarios.

object
string
Value: "gateway"
provider
string
Enum: "amex" "bac" "banamex" "banistmo" "banorte" "cabal" "cbu-bind" "cbu-galicia" "cbu-patagonia" "favacard" "fiserv-argentina" "fiserv-mexico" "mercado-pago-argentina" "naranja" "payway" "prisma-visa" "prisma-visa-debit" "prisma-mastercard" "wompi"

Proveedor.

object

Medios de pago soportados por este Gateway.

updated_at
string <date-time>

Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

username
string

Nombre de usuario actual del Gateway.

{
  • "approved_at": "2023-02-14T11:41:40-03:00",
  • "code_length": null,
  • "created_at": "2023-01-31T16:18:31-03:00",
  • "disabled": false,
  • "id": "GWM8DK6VKoG3",
  • "livemode": false,
  • "number": "1203764444",
  • "number_bank_retries": null,
  • "object": "gateway",
  • "provider": "mercado-pago-argentina",
  • "supported_payment_methods": {
    },
  • "updated_at": "2023-02-01T16:36:06-03:00",
  • "username": "user@name.com"
}

Listado de Gateways

Obtener una lista de todas sus gateways.

Authorizations:
SecretKeyAuthentication
query Parameters
ending_before
string

Un cursor para utilizar en la paginación. ending_before es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, comenzando con obj_ID, la próxima llamda puede incluir ending_before=obj_ID para obtener la página previa.

limit
integer
Example: limit=20

Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25.

starting_after
string

Un cursor para utilizar en la paginación. starting_after es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, terminando con obj_ID, la próxima llamda puede incluir starting_after=obj_ID para obtener la página siguiente.

Responses

Response Schema: application/json
required
Array of objects (Gateway)
object (Metadata de Respuesta)

Links de paginación

object (Response Meta)

Metadata de paginación

Request samples

curl --request GET \
  --url 'https://api.tucuota.com/v1/gateways?ending_before=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer sk_live_...'

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {}
}

Importaciones

Una Importación es un objeto que contiene datos para ser creados en TuCuota. Como estos objetos pueden ser grandes, se crearán y procesarán más tarde. Puede comprobar el estado de la importación.

id
string

Identificador único de la Importación.

batch_job
object
cancelled_at
string <date-time>

Hora en la que se canceló la importación. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

invalid_at
string <date-time>

Hora en la que la importación se marcó como inválida. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

processed_at
string <date-time>

Hora en la que la importación se marcó como procesada. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

ready_at
any <date-time>

Hora en la que la importación se marcó como lista. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.type: string

invalid_rows_count
number

Cantidad de filas no válido

valid_rows_count
number

Cantidad de filas válidas

rows_count
number

Cantidad de filas

livemode
boolean

Tiene el valor true si el objeto existe en mode de producción o el valor false si el objeto existe en modo de prueba.

original_filename
string
type
string

Tipo de importación

status
string

Estado de importación

created_at
string <date-time>

Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

updated_at
string <date-time>

Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

{
  • "batch_job": {
    },
  • "cancelled_at": null,
  • "created_at": "2021-06-08T09:49:04-03:00",
  • "id": "IMB1rRDqkM5X",
  • "invalid_at": null,
  • "invalid_rows_count": 0,
  • "livemode": true,
  • "original_filename": "subscriptions-import-template.csv",
  • "processed_at": "2021-06-08T09:49:06-03:00",
  • "ready_at": "2021-06-08T09:49:05-03:00",
  • "rows_count": 2,
  • "status": "processed",
  • "type": "subscriptions",
  • "updated_at": "2021-06-08T09:49:06-03:00",
  • "valid_rows_count": 2
}

Listado de Importaciones

Obtener una lista de todas sus importaciones.

Authorizations:
SecretKeyAuthentication
query Parameters
search
string
Example: search=foo@bar.com

Search.

status
string
Example: status=ready

Valores permitidos: pending, ready, invalid, cancelled, processing, processed.

object (range_query_specs)

Un filtro en la lista, basado en el campo created_at del objeto. El valor puede ser un Unix Timestamp, o puede ser un diccionario con varias opciones de consulta diferentes.

ending_before
string

Un cursor para utilizar en la paginación. ending_before es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, comenzando con obj_ID, la próxima llamda puede incluir ending_before=obj_ID para obtener la página previa.

limit
integer
Example: limit=20

Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25.

starting_after
string

Un cursor para utilizar en la paginación. starting_after es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, terminando con obj_ID, la próxima llamda puede incluir starting_after=obj_ID para obtener la página siguiente.

Responses

Response Schema: application/json
required
Array of objects (Importación)
object (Metadata de Respuesta)

Links de paginación

object (Response Meta)

Metadata de paginación

Request samples

curl --request GET \
  --url 'https://api.tucuota.com/v1/imports?search=SOME_STRING_VALUE&status=SOME_STRING_VALUE&created_at=SOME_OBJECT_VALUE&ending_before=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer sk_live_...'

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {}
}

Crear una importación

Crear una importación.

Authorizations:
SecretKeyAuthentication
Request Body schema: application/json
type
string
filename
string
original_filename
string
auto
boolean
object or null

Conjunto de pares clave/valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información sobre el objeto en un formato estructurado. Todas las claves se pueden borrar publicando un valor nulo en metadatos.

Responses

Response Schema: application/json
object (Importación)

Este objeto representa una importación de su cuenta.

id
string

Identificador único de la Importación.

batch_job
object
cancelled_at
string <date-time>

Hora en la que se canceló la importación. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

invalid_at
string <date-time>

Hora en la que la importación se marcó como inválida. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

processed_at
string <date-time>

Hora en la que la importación se marcó como procesada. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

ready_at
any <date-time>

Hora en la que la importación se marcó como lista. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.type: string

invalid_rows_count
number

Cantidad de filas no válido

valid_rows_count
number

Cantidad de filas válidas

rows_count
number

Cantidad de filas

livemode
boolean

Tiene el valor true si el objeto existe en mode de producción o el valor false si el objeto existe en modo de prueba.

original_filename
string
type
string

Tipo de importación

status
string

Estado de importación

created_at
string <date-time>

Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

updated_at
string <date-time>

Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

Request samples

Content type
application/json
{
  • "type": "customers",
  • "filename": "a.csv",
  • "original_filename": "a.csv",
  • "auto": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obtener una importación

Obtener una importación.

Authorizations:
SecretKeyAuthentication
path Parameters
id
required
string
Example: IMKd7zlGJAna

Import ID.

Responses

Response Schema: application/json
object (Importación)

Este objeto representa una importación de su cuenta.

id
string

Identificador único de la Importación.

batch_job
object
cancelled_at
string <date-time>

Hora en la que se canceló la importación. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

invalid_at
string <date-time>

Hora en la que la importación se marcó como inválida. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

processed_at
string <date-time>

Hora en la que la importación se marcó como procesada. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

ready_at
any <date-time>

Hora en la que la importación se marcó como lista. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.type: string

invalid_rows_count
number

Cantidad de filas no válido

valid_rows_count
number

Cantidad de filas válidas

rows_count
number

Cantidad de filas

livemode
boolean

Tiene el valor true si el objeto existe en mode de producción o el valor false si el objeto existe en modo de prueba.

original_filename
string
type
string

Tipo de importación

status
string

Estado de importación

created_at
string <date-time>

Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

updated_at
string <date-time>

Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

Request samples

curl --request GET \
  --url https://api.tucuota.com/v1/imports/IMKd7zlGJAna \
  --header 'Authorization: Bearer sk_live_...'

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obtener filas de una Importación

Obtener filas de una Importación.

Authorizations:
SecretKeyAuthentication
path Parameters
id
required
string
Example: IMKd7zlGJAna

Import ID.

query Parameters
filter
string

Validation. Example: valid. Allows values: valid, invalid.

object (range_query_specs)

Un filtro en la lista, basado en el campo created_at del objeto. El valor puede ser un Unix Timestamp, o puede ser un diccionario con varias opciones de consulta diferentes.

ending_before
string

Un cursor para utilizar en la paginación. ending_before es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, comenzando con obj_ID, la próxima llamda puede incluir ending_before=obj_ID para obtener la página previa.

limit
integer
Example: limit=20

Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25.

starting_after
string

Un cursor para utilizar en la paginación. starting_after es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, terminando con obj_ID, la próxima llamda puede incluir starting_after=obj_ID para obtener la página siguiente.

Responses

Response Schema: application/json
required
Array of objects (Fila de Importación)
object (Metadata de Respuesta)

Links de paginación

object (Response Meta)

Metadata de paginación

Request samples

curl --request GET \
  --url 'https://api.tucuota.com/v1/imports/IMKd7zlGJAna/rows?filter=SOME_STRING_VALUE&created_at=SOME_OBJECT_VALUE&ending_before=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer sk_live_...'

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {}
}

Adhesiones

Una Adhesión es un registro del permiso que un cliente te ha dado para debitar su método de pago.

id
string

Identificador único de la Adhesión.

status
string
Enum: "active" "revoked"

Estado.

uuid
string

Identificador UUID del objeto. [Legacy]

object
string
Value: "mandate"
livemode
boolean

Tiene el valor true si el objeto existe en mode de producción o el valor false si el objeto existe en modo de prueba.

object (Cliente)

Este objeto representa a un cliente de su organización.

object (Método de pago)

Este objeto representa un Método de Pago de su cuenta.

object or null

Conjunto de pares clave/valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información sobre el objeto en un formato estructurado. Todas las claves se pueden borrar publicando un valor nulo en metadatos.

created_at
string <date-time>

Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

updated_at
string <date-time>

Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

null or string <date-time>

Hora en la que se eliminó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

{
  • "created_at": "2022-02-01T19:06:37-03:00",
  • "customer": {
    },
  • "deleted_at": null,
  • "id": "MA9aQOWen2kZe6qypB",
  • "uuid": "3990a740-83ab-11ec-8651-cde6203c968e",
  • "livemode": true,
  • "metadata": {
    },
  • "object": "mandate",
  • "payment_method": {
    },
  • "status": "active",
  • "updated_at": "2022-02-01T19:06:37-03:00"
}

Obtener todos las adhesiones

Por defecto, las adhesiones más nuevas serán los primeras en la lista.

Authorizations:
SecretKeyAuthentication
query Parameters
all
boolean

Incluye adhesiones archivadas.

customer_id
required
string
Example: customer_id=CS9PL8eeo8aB
object (range_query_specs)

Un filtro en la lista, basado en el campo created_at del objeto. El valor puede ser un Unix Timestamp, o puede ser un diccionario con varias opciones de consulta diferentes.

ending_before
string

Un cursor para utilizar en la paginación. ending_before es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, comenzando con obj_ID, la próxima llamda puede incluir ending_before=obj_ID para obtener la página previa.

limit
integer
Example: limit=20

Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25.

starting_after
string

Un cursor para utilizar en la paginación. starting_after es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, terminando con obj_ID, la próxima llamda puede incluir starting_after=obj_ID para obtener la página siguiente.

Responses

Response Schema: application/json
required
Array of objects (Adhesión)
object (Metadata de Respuesta)

Links de paginación

object (Response Meta)

Metadata de paginación

Request samples

curl --request GET \
  --url 'https://api.tucuota.com/v1/mandates?all=SOME_BOOLEAN_VALUE&customer_id=SOME_STRING_VALUE&created_at=SOME_OBJECT_VALUE&ending_before=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer sk_live_...'

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {}
}

Crear una adhesión

Crear una adhesión.

Authorizations:
SecretKeyAuthentication
Request Body schema: application/json
customer_id
payment_method_id

Responses

Request samples

Content type
application/json
{
  • "customer_id": "CS3oDRqz9wzB",
  • "payment_method_id": "PMBja4YZ2GDR"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obtener una adhesión

Obtener una adhesión.

Authorizations:
SecretKeyAuthentication
path Parameters
id
required
string
Example: MA9aQOWen2kZe6qypB

Responses

Response Schema: application/json
object (Adhesión)

Este objeto representa una adhesión de su organización.

id
string

Identificador único de la Adhesión.

status
string
Enum: "active" "revoked"

Estado.

uuid
string

Identificador UUID del objeto. [Legacy]

object
string
Value: "mandate"
livemode
boolean

Tiene el valor true si el objeto existe en mode de producción o el valor false si el objeto existe en modo de prueba.

object (Cliente)

Este objeto representa a un cliente de su organización.

object (Método de pago)

Este objeto representa un Método de Pago de su cuenta.

object or null

Conjunto de pares clave/valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información sobre el objeto en un formato estructurado. Todas las claves se pueden borrar publicando un valor nulo en metadatos.

created_at
string <date-time>

Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

updated_at
string <date-time>

Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

null or string <date-time>

Hora en la que se eliminó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

Request samples

curl --request GET \
  --url https://api.tucuota.com/v1/mandates/MA9aQOWen2kZe6qypB \
  --header 'Authorization: Bearer sk_live_...'

Response samples

Content type
application/json
{
  • "data": {
    }
}

Revocar una adhesión

Esta acción revocará la adhesión y también cancelará todos las suscripciones cancelables adjuntas al mismo customer y al mismo payment_method.

Authorizations:
SecretKeyAuthentication
path Parameters
id
required
string
Example: MA9aQOWen2kZe6qypB

Responses

Request samples

curl --request POST \
  --url https://api.tucuota.com/v1/mandates/MA9aQOWen2kZe6qypB/actions/revoke \
  --header 'Authorization: Bearer sk_live_...'

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restaurar la adhesión

Esta acción restaurará la adhesión revocada.

Authorizations:
SecretKeyAuthentication
path Parameters
id
required
string
Example: MA9aQOWen2kZe6qypB

Responses

Request samples

curl --request POST \
  --url https://api.tucuota.com/v1/mandates/MA9aQOWen2kZe6qypB/actions/restore \
  --header 'Authorization: Bearer sk_live_...'

Response samples

Content type
application/json
{
  • "data": {
    }
}

Buscar adhesiones

Buscar adhesiones.

Authorizations:
SecretKeyAuthentication
query Parameters
q
required
string
Example: q=john doe
limit
integer
Example: limit=20

Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25.

page
required
string
Example: page=john doe

Un cursor para la paginación en varias páginas de resultados. No incluya este parámetro en la primera llamada. Utilice el valor de next_page devuelto en una respuesta anterior para solicitar resultados posteriores.

Responses

Response Schema: application/json
required
Array of objects (Adhesión)
object (Metadata de Respuesta)

Links de paginación

object (Response Meta)

Metadata de paginación

Request samples

curl --request GET \
  --url 'https://api.tucuota.com/v1/mandates/search?q=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&page=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer sk_live_...'

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Métodos de Pago

Estos objetos representan los Métodos de Pago de su cliente. Puede usarlos para crear pagos o suscripciones a un cliente.

id
string

Identificador único del objeto.

object
string
Value: "payment_method"
type
string
Enum: "card" "cbu"

Tipo de medio de pago. Uno de: cbu, card.

object (Tarjeta de Crédito)

Este objeto representa una tarjeta de crédito de su cuenta.

object (CBU)

Este objeto representa una cuenta bancaria (CBU) de su cuenta.

livemode
boolean

Tiene el valor true si el objeto existe en mode de producción o el valor false si el objeto existe en modo de prueba.

object or null

Conjunto de pares clave/valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información sobre el objeto en un formato estructurado. Todas las claves se pueden borrar publicando un valor nulo en metadatos.

created_at
string <date-time>

Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

updated_at
string <date-time>

Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

{
  • "card": {
    },
  • "created_at": "2022-02-01T23:13:04-03:00",
  • "id": "PMBja4YZ2GDR",
  • "livemode": true,
  • "metadata": null,
  • "object": "payment_method",
  • "type": "card",
  • "updated_at": "2022-02-01T23:13:04-03:00"
}

Obtener todos los métodos de pago

Obtener una lista de métodos de pago.

Authorizations:
SecretKeyAuthentication
query Parameters
page
number
Example: page=1

Cursor value to paginate response.

limit
integer
Example: limit=20

Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25.

Responses

Response Schema: application/json
required
Array of objects (Método de pago)
object (Metadata de Respuesta)

Links de paginación

object (Response Meta)

Metadata de paginación

Request samples

curl --request GET \
  --url 'https://api.tucuota.com/v1/payment_methods?page=SOME_NUMBER_VALUE&limit=SOME_INTEGER_VALUE' \
  --header 'Authorization: Bearer sk_live_...'

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {}
}

Crear un método de pago

Crear un método de pago

Authorizations:
PublishableKeyAuthenticationSecretKeyAuthentication
Request Body schema: application/json
type
string
Enum: "card" "cbu"

Uno de card, o cbu.

object (Tarjeta de Crédito)

Este objeto representa una tarjeta de crédito de su cuenta.

object (CBU)

Este objeto representa una cuenta bancaria (CBU) de su cuenta.

Responses

Response Schema: application/json
object (Método de pago)

Este objeto representa un Método de Pago de su cuenta.

id
string

Identificador único del objeto.

object
string
Value: "payment_method"
type
string
Enum: "card" "cbu"

Tipo de medio de pago. Uno de: cbu, card.

object (Tarjeta de Crédito)

Este objeto representa una tarjeta de crédito de su cuenta.

object (CBU)

Este objeto representa una cuenta bancaria (CBU) de su cuenta.

livemode
boolean

Tiene el valor true si el objeto existe en mode de producción o el valor false si el objeto existe en modo de prueba.

object or null

Conjunto de pares clave/valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información sobre el objeto en un formato estructurado. Todas las claves se pueden borrar publicando un valor nulo en metadatos.

created_at
string <date-time>

Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

updated_at
string <date-time>

Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

Request samples

Content type
application/json
Example
{
  • "type": "card",
  • "card": {
    }
}

Response samples

Content type
application/json
Example
{
  • "data": {
    }
}

Obtener un Método de Pago

Obtener un Método de Pago.

Authorizations:
SecretKeyAuthentication
path Parameters
id
required
string
Example: PMVA0W8y1aQO

Payment method ID.

Responses

Response Schema: application/json
object (Método de pago)

Este objeto representa un Método de Pago de su cuenta.

id
string

Identificador único del objeto.

object
string
Value: "payment_method"
type
string
Enum: "card" "cbu"

Tipo de medio de pago. Uno de: cbu, card.

object (Tarjeta de Crédito)

Este objeto representa una tarjeta de crédito de su cuenta.

object (CBU)

Este objeto representa una cuenta bancaria (CBU) de su cuenta.

livemode
boolean

Tiene el valor true si el objeto existe en mode de producción o el valor false si el objeto existe en modo de prueba.

object or null

Conjunto de pares clave/valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información sobre el objeto en un formato estructurado. Todas las claves se pueden borrar publicando un valor nulo en metadatos.

created_at
string <date-time>

Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

updated_at
string <date-time>

Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

Request samples

curl --request GET \
  --url https://api.tucuota.com/v1/payment_methods/PMVA0W8y1aQO \
  --header 'Authorization: Bearer sk_live_...'

Response samples

Content type
application/json
{
  • "data": {
    }
}

Buscar métodos de pago

Buscar métodos de pago.

Authorizations:
SecretKeyAuthentication
query Parameters
q
required
string
Example: q=john doe
limit
integer
Example: limit=20

Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25.

page
required
string
Example: page=john doe

Un cursor para la paginación en varias páginas de resultados. No incluya este parámetro en la primera llamada. Utilice el valor de next_page devuelto en una respuesta anterior para solicitar resultados posteriores.

Responses

Response Schema: application/json
required
Array of objects (Método de pago)
object (Metadata de Respuesta)

Links de paginación

object (Response Meta)

Metadata de paginación

Request samples

curl --request GET \
  --url 'https://api.tucuota.com/v1/payment_methods/search?q=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&page=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer sk_live_...'

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Pagos

Un pago es un objeto que crea para cargar una tarjeta de crédito, débito o una cuenta bancaria. Puede obtener información sobre el pago y también reembolsarlos parcial o totalmente.

Estado Razón
pending_submission El pago se ha emitido, pero aún no se ha presentado a la entidad financiera
cancelled El pago ha sido cancelado manualmente.
submitted El pago se ha realizado correctamente y está siendo procesado por la entidad financiera
failed No se ha podido presentar en la entidad financiera. Hay un error en la solicitud
will_retry El intento fracasó, pero la entidad financiera hará un nuevo intento
approved Enviado OK y aprobado
rejected Se envió correctamente, pero no se pudo cobrar.
chargeback El cliente le pidió al banco que le devolvieran su dinero.
refunded El pago ha sido devuelto al cliente.
partially_refunded Una cantidad parcial del pago ha sido devuelta al cliente
id
string

Identificador único del Pago.

object
string
Value: "payment"
amount
number

Monto del pago

amount_refunded
number

Payment amount refunded.

currency
string
Enum: "ARS" "BRL" "CLP" "COP" "MXN" "USB" "USD"

Moneda de la transacción usando códigos ISO_4217. Los valores predeterminados son los predeterminados de la cuenta.

description
string

Descripción del pago

status
string
Enum: "pending_submission" "cancelled" "submitted" "failed" "will_retry" "approved" "rejected" "chargeback" "refunded" "partially_refunded"

Estado del pago

response_message
string

Respuesta detallada de la institución financiera

paid
boolean

El pago se ha cobrado con éxito.

retryable
boolean

Se puede volver a intentar el pago.

refundable
boolean

El pago puede ser reembolsado.

amount_refundable
number

El monto del pago que se puede reembolsar.

livemode
boolean

Tiene el valor true si el objeto existe en mode de producción o el valor false si el objeto existe en modo de prueba.

created_at
string <date-time>

Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

charge_date
string

Una fecha futura en la que se debe cobrar el pago. Si no se especifica, el pago se cobrará lo antes posible.

submissions_count
number

El número de veces que el pago ha sido enviado a la institución financiera.

null or string

La última fecha en que se enviará el pago a la institución financiera. Nulo significa sin límite

null or number

El número máximo de veces que se puede volver a intentar el pago automáticamente.

null or string

La fecha en que se cobrará el pago.

null or string

La fecha estimada en la que la entidad financiera enviará el monto a cobrar a tu cuenta.

updated_at
string <date-time>

Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

null or string

La última fecha en que se cambió el estado del pago.

object (Cliente)

Este objeto representa a un cliente de su organización.

null or string

La Suscripción asociada con el pago si existe.

null or number

El número de pago de la Suscripción asociada, si existiera.

gateway
string

El Gateway asociada con el pago.

object (Método de pago)

Este objeto representa un Método de Pago de su cuenta.

null or number

El número personalizado que envía al Gateway. En la mayoría de los casos este valor es nulo.

refunds
Array of arrays

Reembolsos asociados con este pago.

object or null

Conjunto de pares clave/valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información sobre el objeto en un formato estructurado. Todas las claves se pueden borrar publicando un valor nulo en metadatos.

{
  • "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": {
    },
  • "subscription": null,
  • "subscription_payment_number": null,
  • "gateway": "GW1L49J7ARW3",
  • "payment_method": {
    },
  • "gateway_identifier": null,
  • "metadata": null,
  • "refunds": [ ]
}

Obtener pagos

Obtener pagos en order cronológico, los más nuevos aparecerán primero.

Authorizations:
SecretKeyAuthentication
query Parameters
customer_id
string
Example: customer_id=CS9PL8eeo8aB

Mostrar solo los métodos de pago de un cliente determinado.

subscription_id
string
Example: subscription_id=SBmX1MrZ77Mwq3

Mostrar solo los métodos de pago de una suscripción determinada.

object (range_query_specs)

Un filtro en la lista, basado en el campo created_at del objeto. El valor puede ser un Unix Timestamp, o puede ser un diccionario con varias opciones de consulta diferentes.

ending_before
string

Un cursor para utilizar en la paginación. ending_before es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, comenzando con obj_ID, la próxima llamda puede incluir ending_before=obj_ID para obtener la página previa.

limit
integer
Example: limit=20

Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25.

starting_after
string

Un cursor para utilizar en la paginación. starting_after es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, terminando con obj_ID, la próxima llamda puede incluir starting_after=obj_ID para obtener la página siguiente.

Responses

Response Schema: application/json
required
Array of objects (Payment)
object (Metadata de Respuesta)

Links de paginación

object (Response Meta)

Metadata de paginación

Request samples

curl --request GET \
  --url 'https://api.tucuota.com/v1/payments?customer_id=SOME_STRING_VALUE&subscription_id=SOME_STRING_VALUE&created_at=SOME_OBJECT_VALUE&ending_before=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&starting_after=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer sk_live_...'

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {}
}

Crear un pago

Crear un pago.

Authorizations:
SecretKeyAuthentication
Request Body schema: application/json
amount
required
number

El monto del pago.

description
required
string

La descripción del pago.

customer_id
required
payment_method_id
required
string

El ID del Método de Pago para este pago.

charge_date
string <date>

Una fecha futura en la que se debe cobrar el pago. Si no se especifica, el pago se cobrará lo antes posible.

can_auto_retry_until
string <date>

La fecha máxima en la que se puede volver a intentar el pago automáticamente.

auto_retries_max_attempts
integer

La cantidad máxima de veces que se puede volver a intentar el pago automáticamente.

gateway_identifier
string

Identificador de Gateway para su pago.

object or null

Conjunto de pares clave/valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información sobre el objeto en un formato estructurado. Todas las claves se pueden borrar publicando un valor nulo en metadatos.

Responses

Response Schema: application/json
object (Payment)

Este objeto representa un pago de su organización.

id
string

Identificador único del Pago.

object
string
Value: "payment"
amount
number

Monto del pago

amount_refunded
number

Payment amount refunded.

currency
string
Enum: "ARS" "BRL" "CLP" "COP" "MXN" "USB" "USD"

Moneda de la transacción usando códigos ISO_4217. Los valores predeterminados son los predeterminados de la cuenta.

description
string

Descripción del pago

status
string
Enum: "pending_submission" "cancelled" "submitted" "failed" "will_retry" "approved" "rejected" "chargeback" "refunded" "partially_refunded"

Estado del pago

response_message
string

Respuesta detallada de la institución financiera

paid
boolean

El pago se ha cobrado con éxito.

retryable
boolean

Se puede volver a intentar el pago.

refundable
boolean

El pago puede ser reembolsado.

amount_refundable
number

El monto del pago que se puede reembolsar.

livemode
boolean

Tiene el valor true si el objeto existe en mode de producción o el valor false si el objeto existe en modo de prueba.

created_at
string <date-time>

Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

charge_date
string

Una fecha futura en la que se debe cobrar el pago. Si no se especifica, el pago se cobrará lo antes posible.

submissions_count
number

El número de veces que el pago ha sido enviado a la institución financiera.

null or string

La última fecha en que se enviará el pago a la institución financiera. Nulo significa sin límite

null or number

El número máximo de veces que se puede volver a intentar el pago automáticamente.

null or string

La fecha en que se cobrará el pago.

null or string

La fecha estimada en la que la entidad financiera enviará el monto a cobrar a tu cuenta.

updated_at
string <date-time>

Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

null or string

La última fecha en que se cambió el estado del pago.

object (Cliente)

Este objeto representa a un cliente de su organización.

null or string

La Suscripción asociada con el pago si existe.

null or number

El número de pago de la Suscripción asociada, si existiera.

gateway
string

El Gateway asociada con el pago.

object (Método de pago)

Este objeto representa un Método de Pago de su cuenta.

null or number

El número personalizado que envía al Gateway. En la mayoría de los casos este valor es nulo.

refunds
Array of arrays

Reembolsos asociados con este pago.

object or null

Conjunto de pares clave/valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información sobre el objeto en un formato estructurado. Todas las claves se pueden borrar publicando un valor nulo en metadatos.

Request samples

Content type
application/json
{
  • "amount": 100,
  • "description": "Unique payment",
  • "gateway_identifier": "001234",
  • "customer_id": "CSr7Dg3LkDP2",
  • "payment_method_id": "PMBja4YZ2GDR"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Obtener un pago

Obtener un pago.

Authorizations:
SecretKeyAuthentication
path Parameters
id
required
string
Example: PYdOz9bgVReV

Responses

Response Schema: application/json
object (Payment)

Este objeto representa un pago de su organización.

id
string

Identificador único del Pago.

object
string
Value: "payment"
amount
number

Monto del pago

amount_refunded
number

Payment amount refunded.

currency
string
Enum: "ARS" "BRL" "CLP" "COP" "MXN" "USB" "USD"

Moneda de la transacción usando códigos ISO_4217. Los valores predeterminados son los predeterminados de la cuenta.

description
string

Descripción del pago

status
string
Enum: "pending_submission" "cancelled" "submitted" "failed" "will_retry" "approved" "rejected" "chargeback" "refunded" "partially_refunded"

Estado del pago

response_message
string

Respuesta detallada de la institución financiera

paid
boolean

El pago se ha cobrado con éxito.

retryable
boolean

Se puede volver a intentar el pago.

refundable
boolean

El pago puede ser reembolsado.

amount_refundable
number

El monto del pago que se puede reembolsar.

livemode
boolean

Tiene el valor true si el objeto existe en mode de producción o el valor false si el objeto existe en modo de prueba.

created_at
string <date-time>

Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

charge_date
string

Una fecha futura en la que se debe cobrar el pago. Si no se especifica, el pago se cobrará lo antes posible.

submissions_count
number

El número de veces que el pago ha sido enviado a la institución financiera.

null or string

La última fecha en que se enviará el pago a la institución financiera. Nulo significa sin límite

null or number

El número máximo de veces que se puede volver a intentar el pago automáticamente.

null or string

La fecha en que se cobrará el pago.

null or string

La fecha estimada en la que la entidad financiera enviará el monto a cobrar a tu cuenta.

updated_at
string <date-time>

Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

null or string

La última fecha en que se cambió el estado del pago.

object (Cliente)

Este objeto representa a un cliente de su organización.

null or string

La Suscripción asociada con el pago si existe.

null or number

El número de pago de la Suscripción asociada, si existiera.

gateway
string

El Gateway asociada con el pago.

object (Método de pago)

Este objeto representa un Método de Pago de su cuenta.

null or number

El número personalizado que envía al Gateway. En la mayoría de los casos este valor es nulo.

refunds
Array of arrays

Reembolsos asociados con este pago.

object or null

Conjunto de pares clave/valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información sobre el objeto en un formato estructurado. Todas las claves se pueden borrar publicando un valor nulo en metadatos.

Request samples

curl --request GET \
  --url https://api.tucuota.com/v1/payments/PYdOz9bgVReV \
  --header 'Authorization: Bearer sk_live_...'

Response samples

Content type
application/json
{
  • "data": {
    }
}

Actualizar un pago

Actualizar un pago.

Authorizations:
SecretKeyAuthentication
path Parameters
id
required
string
Example: PYdOz9bgVReV
Request Body schema: application/json
amount
number

El nuevo monto del pago.

auto_retries_max_attempts
integer

La cantidad máxima de veces que se puede volver a intentar el pago automáticamente.

can_auto_retry_until
string <date>

La fecha máxima en la que se puede volver a intentar el pago automáticamente.

charge_date
string <date>

Una fecha futura en la que se debe cobrar el pago.

description
string

La nueva descripción del pago.

payment_method_id
string

El ID del Método de Pago para este pago.

object or null

Conjunto de pares clave/valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información sobre el objeto en un formato estructurado. Todas las claves se pueden borrar publicando un valor nulo en metadatos.

Responses

Response Schema: application/json
object (Payment)

Este objeto representa un pago de su organización.

id
string

Identificador único del Pago.

object
string
Value: "payment"
amount
number

Monto del pago

amount_refunded
number

Payment amount refunded.

currency
string
Enum: "ARS" "BRL" "CLP" "COP" "MXN" "USB" "USD"

Moneda de la transacción usando códigos ISO_4217. Los valores predeterminados son los predeterminados de la cuenta.

description
string

Descripción del pago

status
string
Enum: "pending_submission" "cancelled" "submitted" "failed" "will_retry" "approved" "rejected" "chargeback" "refunded" "partially_refunded"

Estado del pago

response_message
string

Respuesta detallada de la institución financiera

paid
boolean

El pago se ha cobrado con éxito.

retryable
boolean

Se puede volver a intentar el pago.

refundable
boolean

El pago puede ser reembolsado.

amount_refundable
number

El monto del pago que se puede reembolsar.

livemode
boolean

Tiene el valor true si el objeto existe en mode de producción o el valor false si el objeto existe en modo de prueba.

created_at
string <date-time>

Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

charge_date
string

Una fecha futura en la que se debe cobrar el pago. Si no se especifica, el pago se cobrará lo antes posible.

submissions_count
number

El número de veces que el pago ha sido enviado a la institución financiera.

null or string

La última fecha en que se enviará el pago a la institución financiera. Nulo significa sin límite

null or number

El número máximo de veces que se puede volver a intentar el pago automáticamente.

null or string

La fecha en que se cobrará el pago.

null or string

La fecha estimada en la que la entidad financiera enviará el monto a cobrar a tu cuenta.

updated_at
string <date-time>

Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

null or string

La última fecha en que se cambió el estado del pago.

object (Cliente)

Este objeto representa a un cliente de su organización.

null or string

La Suscripción asociada con el pago si existe.

null or number

El número de pago de la Suscripción asociada, si existiera.

gateway
string

El Gateway asociada con el pago.

object (Método de pago)

Este objeto representa un Método de Pago de su cuenta.

null or number

El número personalizado que envía al Gateway. En la mayoría de los casos este valor es nulo.

refunds
Array of arrays

Reembolsos asociados con este pago.

object or null

Conjunto de pares clave/valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información sobre el objeto en un formato estructurado. Todas las claves se pueden borrar publicando un valor nulo en metadatos.

Request samples

Content type
application/json
{
  • "description": "New payment title"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Cancelar pago

Cancelar pago.

Authorizations:
SecretKeyAuthentication
path Parameters
id
required
string
Example: PYdOz9bgVReV

Responses

Request samples

curl --request POST \
  --url https://api.tucuota.com/v1/payments/PYdOz9bgVReV/actions/cancel \
  --header 'Authorization: Bearer sk_live_...'

Response samples

Content type
application/json
{
  • "message": "Cancelled successfully"
}

Reintentar un pago

Reintentar un pago.

Authorizations:
SecretKeyAuthentication
path Parameters
id
required
string
Example: PYdOz9bgVReV

Responses

Request samples

curl --request POST \
  --url https://api.tucuota.com/v1/payments/PYdOz9bgVReV/actions/retry \
  --header 'Authorization: Bearer sk_live_...'

Response samples

Content type
application/json
{
  • "message": "Retried successfully"
}

Detener reintentos automáticos

Detener reintentos automáticos, impide que luego de un rechazo el pago continue realizando reintentos automáticos. Esta acción puede solicitarse en cualquier momento del ciclo del pago, es decir, incluso cuando el pago está enviado a la entidad financiera.

Authorizations:
SecretKeyAuthentication
path Parameters
id
required
string
Example: PYdOz9bgVReV

Responses

Request samples

curl --request POST \
  --url https://api.tucuota.com/v1/payments/PYdOz9bgVReV/actions/stop_auto_retrying \
  --header 'Authorization: Bearer sk_live_...'

Response samples

Content type
application/json
{
  • "message": "Stopped autoretries successfully"
}

Buscar pagos

Buscar pagos.

Authorizations:
SecretKeyAuthentication
query Parameters
q
required
string
Example: q=john doe
limit
integer
Example: limit=20

Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25.

page
required
string
Example: page=john doe

Un cursor para la paginación en varias páginas de resultados. No incluya este parámetro en la primera llamada. Utilice el valor de next_page devuelto en una respuesta anterior para solicitar resultados posteriores.

Responses

Response Schema: application/json
required
Array of objects (Payment)
object (Metadata de Respuesta)

Links de paginación

object (Response Meta)

Metadata de paginación

Request samples

curl --request GET \
  --url 'https://api.tucuota.com/v1/payments/search?q=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&page=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer sk_live_...'

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Devoluciones

Los objetos de devoluciones le permiten reembolsar un pago que se ha creado anteriormente pero que aún no se ha reembolsado por completo. Los fondos se reembolsarán a la tarjeta de crédito, débito o cuenta bancaria que se cargó originalmente.

Estado Razón
pending_submission Se ha emitido la devolución, pero aún no se ha presentado a la entidad financiera
submitted La devolución se ha presentado correctamente y está siendo tramitada por la entidad financiera
failed Enviado OK pero rechazado por la entidad financiera
approved Enviado OK y aprobado
id
string

Identificador único de la Devolución.

object
string
Value: "refund"
payment_id
string
amount
number

Monto devuelto.

currency
string
Enum: "ARS" "BRL" "CLP" "COP" "MXN" "USB" "USD"

Moneda de la transacción usando códigos ISO_4217. Los valores predeterminados son los predeterminados de la cuenta.

reason
string
Enum: "duplicate" "error" "requested_by_customer"

Motivo del reembolso

status
string
Enum: "pending_submission" "submitted" "failed" "approved"

Estado del reembolso

created_at
string <date-time>

Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

updated_at
string <date-time>

Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

object or null

Conjunto de pares clave/valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información sobre el objeto en un formato estructurado. Todas las claves se pueden borrar publicando un valor nulo en metadatos.

{
  • "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
}

Mostrar todas las devoluciones

Esta lista muestras las devoluciones ordenadas por fecha de creación.

Authorizations:
SecretKeyAuthentication
query Parameters
object (range_query_specs)

Un filtro en la lista, basado en el campo created_at del objeto. El valor puede ser un Unix Timestamp, o puede ser un diccionario con varias opciones de consulta diferentes.

ending_before
string

Un cursor para utilizar en la paginación. ending_before es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, comenzando con obj_ID, la próxima llamda puede incluir ending_before=obj_ID para obtener la página previa.

limit
integer
Example: limit=20

Especifica el número máximo de ítems a ser retornados. El límite puede variar entre 1 y 100, y el valor predeterminado es 25.

starting_after
string

Un cursor para utilizar en la paginación. starting_after es un ID que define tu lugar en la lista. Por ejemplo, si en el primer request recibes 100 objetos, terminando con obj_ID, la próxima llamda puede incluir starting_after=obj_ID para obtener la página siguiente.

Responses

Response Schema: application/json
required
Array of objects (Devolución)
object (Metadata de Respuesta)

Links de paginación

object (Response Meta)

Metadata de paginación

Request samples

curl --request GET \
  --url 'https://api.tucuota.com/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_...'

Response samples

Content type
application/json
{}

Crear una devolución

Crear una devolución.

Authorizations:
SecretKeyAuthentication
Request Body schema: application/json
payment_id
required
string
amount
number

Monto a devolver. Si es nulo se devolverá la totalidad del pago.

reason
required
string

Motivo del reembolso. Uno de: duplicate, error, or requested_by_customer.

object or null

Conjunto de pares clave/valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información sobre el objeto en un formato estructurado. Todas las claves se pueden borrar publicando un valor nulo en metadatos.

Responses

Response Schema: application/json
object (Devolución)

Este objeto representa una devolución de su organización.

id
string

Identificador único de la Devolución.

object
string
Value: "refund"
payment_id
string
amount
number

Monto devuelto.

currency
string
Enum: "ARS" "BRL" "CLP" "COP" "MXN" "USB" "USD"

Moneda de la transacción usando códigos ISO_4217. Los valores predeterminados son los predeterminados de la cuenta.

reason
string
Enum: "duplicate" "error" "requested_by_customer"

Motivo del reembolso

status
string
Enum: "pending_submission" "submitted" "failed" "approved"

Estado del reembolso

created_at
string <date-time>

Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

updated_at
string <date-time>

Hora en la que se actualizó por última vez el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

object or null

Conjunto de pares clave/valor que puede adjuntar a un objeto. Esto puede ser útil para almacenar información sobre el objeto en un formato estructurado. Todas las claves se pueden borrar publicando un valor nulo en metadatos.

Request samples

Content type
application/json
{
  • "payment_id": "PYgaZlLaPMZO.",
  • "amount": 12.5,
  • "reason": "requested_by_customer",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retorna una devolución

Retorna una devolución.

Authorizations:
SecretKeyAuthentication
path Parameters
id
required
string
Example: RFgaZlLaPMZO

Responses

Response Schema: application/json
object (Devolución)

Este objeto representa una devolución de su organización.

id
string

Identificador único de la Devolución.

object
string
Value: "refund"
payment_id
string
amount
number

Monto devuelto.

currency
string
Enum: "ARS" "BRL" "CLP" "COP" "MXN" "USB" "USD"

Moneda de la transacción usando códigos ISO_4217. Los valores predeterminados son los predeterminados de la cuenta.

reason
string
Enum: "duplicate" "error" "requested_by_customer"

Motivo del reembolso

status
string
Enum: "pending_submission" "submitted" "failed" "approved"

Estado del reembolso

created_at
string <date-time>

Hora en la que se creó el objeto. Formato: RFC339. Ejemplo: 2015-10-21T08:29:31-03:00.

updated_at