TRtrytoku
Payments

Obtener Payment

Devuelve el detalle de un Payment a partir de su identificador.

Se usa para consultar cómo quedó registrado un pago: el monto, la fecha, el Invoice que salda y el deudor asociado. Cuando el pago tiene un medio de pago asociado, la respuesta también incluye sus datos.

Sirve tanto para los pagos que Toku procesó como para los que se registraron de forma externa; processed_by_toku distingue unos de otros. Si el identificador no es válido o no corresponde a un Payment visible para tus credenciales, la llamada responde 404.

get/payments/{encrypted_payment_id}

Request

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

Path parameters

encrypted_payment_idstring required

Identificador del Payment que se quiere consultar.

Example:pay_dsQ5-sNZPwxBYf6hnLsstaqG9JAZK432

Headers

x-account-keystring

Llave de API de una Account, para operar sobre esa Account en lugar de la principal.

Response

Detalle del Payment.

amountnumber

Monto pagado. En los pagos registrados de forma externa corresponde al monto informado al registrarlos.

authorization_codestring

Código de autorización entregado al aprobarse el cobro.

buy_orderstring

Identificador del documento que respalda el pago.

card_numberstring

Últimos dígitos de la tarjeta utilizada. Llega con valor solo cuando el pago tiene un medio de pago asociado con datos de tarjeta.

card_typestring

Tipo de tarjeta utilizada. Llega con valor solo cuando el pago tiene un medio de pago asociado con datos de tarjeta.

created_atstring date-time required

Fecha y hora en que el pago quedó registrado en Toku.

customerstring

Customer dueño del Invoice pagado.

deleted_atstring date-time

Fecha y hora en que el Payment fue eliminado. Es null si sigue vigente.

due_datestring

due_date del Invoice que se saldó.

government_idstring

Identificador tributario del deudor, tal como está registrado en el Customer.

invoicestring

Invoice que salda el Payment.

mc_order_idstring

Identificador de la orden en el sistema del medio de pago.

namestring

Nombre del deudor, tal como está registrado en el Customer.

payment_methodstring

Medio de pago con el que se pagó, en formato legible.

payment_typestring

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

processed_by_tokuboolean

Es true cuando el cobro lo procesó Toku y false cuando el pago se registró de forma externa.

product_idstring

product_id del Invoice que se saldó.

transaction_datestring date-time

Fecha en que se realizó el pago.

Example response

{
  "customer": "cus_1YPKc-NZPwxBYf6hnLsstaqG9JAZKxX9",
  "invoice": "in_1YPKc-NZPwxBYf6hnLsstaqG9JAZKxX9"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.