Pago ya realizado sobre un Invoice: cuánto se pagó, cuándo y por qué medio.
Pago ya realizado sobre un Invoice: cuánto se pagó, cuándo y por qué medio.
Un Payment puede ser un cobro procesado por Toku o un pago que el deudor hizo por fuera (transferencia, caja, efectivo) y que se registra para dejar el Invoice como pagado.
Un Payment no se referencia por un identificador propio, sino por el Invoice que salda: con invoice_external_id, o con product_id y due_date, que juntos lo componen. Los campos enviados como texto vacío se tratan como ausentes.
Atributos
buy_order string
Identificador del documento que respalda el pago en tu sistema, por ejemplo el número de la orden o del comprobante.
due_date string
Identificador del periodo adeudado. Es texto libre, no necesariamente una fecha, y es obligatorio cuando no envías invoice_external_id.
id_payment_intent string
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_receipt integer
Identificador del comprobante asociado al pago, cuando corresponde.
invoice_external_id string
Identificador del Invoice que salda el Payment. Si lo omites, se construye como {product_id}-{due_date}.
payment_amount number
Monto pagado del Invoice. No puede ser negativo.
payment_date string (date) | string (date-time)
Fecha en que se realizó el pago, en formato ISO 8601. Acepta solo la fecha (2020-08-26) o fecha y hora (2020-08-26T12:06:34Z); si envías solo la fecha, se toma a las 00:00. Si lo omites al registrar el pago, se usa el momento en que Toku recibe la solicitud.
payment_method string
Medio de pago con el que se pagó, como texto libre.
product_id string
Identificador con el que reconoces el producto o servicio adeudado. Es obligatorio cuando no envías invoice_external_id.
Ejemplo
{
"buy_order": "string",
"due_date": "202101",
"id_payment_intent": "pi_1YPKc-NZPwxBYf6hnLsstaqG9JAZKxX9",
"id_receipt": 0,
"invoice_external_id": "9897af7987d9245d-202101",
"payment_amount": 1000,
"payment_date": "2020-08-16T19:20:30-04:00",
"payment_method": "string",
"product_id": "9897af7987d9245d"
}