TRtrytoku
Payments

Listar Payments

Changed on

Devuelve los Payments de la organización autenticada, paginados y ordenados por fecha.

Cada elemento trae el detalle del cobro junto con la Invoice, el Customer y el medio de pago asociados, de modo que no hace falta consultar esas entidades por separado.

La paginación se recorre incrementando page hasta que la respuesta sea 404, que es la forma en que esta operación indica que no quedan Payments para los filtros usados.

Límite de tasa: 20 solicitudes por hora. Al superarlo, la API responde 429. Ver Límites de tasa.

get/organization/payments

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/organization/payments
  • Auth
    API key in header x-api-key

Query parameters

pageinteger required

Número de página a consultar. Comienza en 1.

start_datestring date

Fecha desde la que se incluyen Payments, según su fecha de creación, en formato YYYY-MM-DD.

end_datestring date

Fecha hasta la que se incluyen Payments, según su fecha de creación, en formato YYYY-MM-DD. El día indicado queda incluido.

page_sizeinteger

Cantidad de Payments por página.

Response

Successful Response

amount_paidnumber

Monto efectivamente pagado. Puede diferir de payment_amount cuando el pago se hizo con un cupón de pago y el Customer pagó un monto distinto al emitido.

authorization_codestring

Código de autorización que entregó el medio de pago al aprobar la transacción.

buy_orderstring

Número de orden de compra que el medio de pago asignó a la transacción.

card_numberstring

Últimos dígitos de la tarjeta usada en el cobro. Es null si el cobro no fue con tarjeta.

card_typestring

Marca de la tarjeta usada en el cobro. Es null si el cobro no fue con tarjeta.

created_atstring required

Fecha y hora en que se registró el Payment, en formato ISO 8601.

customerstring required

Identificador público del Customer que realizó el Payment. Queda vacío si no hay Customer asociado.

deleted_atstring

Fecha y hora en que el Payment fue eliminado, en formato ISO 8601. Es null si sigue vigente.

due_datestring

Fecha de vencimiento de la Invoice que el Payment salda.

government_idstring

Identificador tributario del Customer (RUT en Chile, CPF/CNPJ en Brasil).

idstring required

Identificador público del Payment.

invoicestring required

Identificador público de la Invoice que el Payment salda. Queda vacío si el Payment no tiene Invoice asociada.

mc_order_idstring

Identificador de la orden en el proveedor de recaudación que procesó el cobro.

namestring

Nombre del Customer que realizó el Payment.

payment_amountnumber

Monto cobrado en la transacción, en la moneda de la Invoice.

payment_methodstring

Nombre del medio de pago con que se cobró (por ejemplo la tarjeta o el proveedor de recaudación).

payment_typestring

Modalidad de la tarjeta con que se cobró: Credit, Debit o Prepaid.

processed_by_tokuboolean required

Indica si el cobro fue procesado por Toku. Es false cuando la organización registró un pago conciliado fuera de la plataforma.

product_idstring

Identificador del producto o servicio que la organización cobra en la Invoice.

transaction_datestring

Fecha y hora en que la transacción fue procesada por el medio de pago, en formato ISO 8601.

Example response

[
  {
    "customer": "cus_pBf2NL0d0gvBM7Ei1E3HIWnTN4W93xOa",
    "id": "pay_R6vDrjIgY9UcSHDdmzNa2XlJp07q1UeD",
    "invoice": "in_bQ7nWzX4TgKpLmR8vY2aJdH5sC3fN6uE"
  }
]

Changes