Registrar un pago

Autorizaciones

Authorization
string
header
requerido

Clave de API de tu organización en el header Authorization: Bearer <clave>. Las claves empiezan con moz_ y las emite un superadmin desde el Admin.

Cuerpo

amount
number
requerido

Monto abonado, mayor a 0.

debtorId
string
requerido

ID del deudor que realizó el pago

externalId
string
requerido

Clave de idempotencia del cliente. Un reintento con el mismo valor y el mismo cuerpo (misma cartera) devuelve el pago ya creado, sin duplicarlo; con otro cuerpo responde 409 idempotency_conflict.

Required string length: 1 - 128
paymentDate
string
requerido

Fecha en que ocurrió el pago, formato YYYY-MM-DD.

Pattern: ^\d{4}-\d{2}-\d{2}$
portfolioId
string
requerido

ID del portafolio del pago

currency
string

Código ISO 4217 de la moneda del pago. Opcional: si se omite se deriva de la moneda de la deuda indicada en debtId, si la hay; si no, de la única moneda de las deudas vivas del deudor o, si no alcanza, de la moneda principal de la cartera; si no se puede derivar, responde 400.

debtId
string

ID de la deuda específica a la que aplica

method
enum<string>
Opciones disponibles:
transfer,
cash,
collection_network,
deposit,
card,
check,
other
reference
string

Número de cheque, comprobante bancario o código de depósito

Respuesta

Response for status 200

data
object
requerido