TRtrytoku
Payments

Modificar Payment

Changed on

Modifica los datos de un pago ya registrado sobre un Invoice.

Se usa para corregir el monto, la fecha o el medio de pago de un Payment informado antes. El Payment se identifica por el Invoice que salda, y ese Invoice debe tener un pago registrado: si no lo tiene, la llamada responde 404.

El monto no se puede modificar cuando el Invoice ya tiene un comprobante emitido; en ese caso la llamada responde 400. Los demás campos sí se pueden corregir.

put/payments

Request

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

Headers

x-account-keystring

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

Request body

buy_orderstring

Identificador del documento que respalda el pago en tu sistema, por ejemplo el número de la orden o del comprobante.

due_datestring

Identificador del periodo adeudado. Es texto libre, no necesariamente una fecha, y es obligatorio cuando no envías invoice_external_id.

id_payment_intentstring

Identificador del cobro de Toku que originó el pago. Si lo envías, el Invoice se determina a partir de ese cobro y no de product_id / due_date, y debe corresponder a un cobro autorizado.

id_receiptinteger

Identificador del comprobante asociado al pago, cuando corresponde.

invoice_external_idstring

Identificador del Invoice que salda el Payment. Si lo omites, se construye como {product_id}-{due_date}.

payment_amountnumber

Monto pagado del Invoice. No puede ser negativo.

payment_methodstring

Medio de pago con el que se pagó, como texto libre.

product_idstring

Identificador con el que reconoces el producto o servicio adeudado. Es obligatorio cuando no envías invoice_external_id.

Example request

{
  "due_date": "202101",
  "id_payment_intent": "pi_1YPKc-NZPwxBYf6hnLsstaqG9JAZKxX9",
  "invoice_external_id": "9897af7987d9245d-202101",
  "payment_amount": 1000,
  "product_id": "9897af7987d9245d"
}

Response

El Payment fue modificado.

messagestring required

Changes