Campo
Tipo
Descripción
_id
El id que asignamos a este pago. Omítelo al crear un pago y envíalo al actualizar uno.
externalId
Tu propio id para este pago, desde tu software. Obligatorio cuando no se envía _id. Envía de nuevo el mismo externalId para actualizar este pago en lugar de agregar uno nuevo. Usamos este valor para hacer la coincidencia, pero no evitamos duplicados, así que manténgalo único dentro del sitio.
displayName
El nombre de visualización seguro y amigable del método de pago. Ejemplo: VISA **** 3421.
amount
El monto que se pagó. Este es un número entero de centavos, por lo que 1035 significa $10.35.
paidOn
La fecha y hora en que se realizó el pago. Un momento en el tiempo en formato ISO 8601, con zona horaria. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
gatewayTransactionId
El identificador único que se asignó al registro de pago desde la pasarela cuando se procesó el pago.
invoice
Una referencia al registro de orden de compra. En una escritura, así es como el pago se aplica a orden de compra; se devuelve en una lectura, junto con la lista más completa allocations.
allowMissingInvoice
Cuando invoice.externalId nombre una orden de compra que aún no se ha enviado, guarda el pago sin aplicarlo en lugar de rechazarlo. Una llamada a Add/Update Invoice con ese externalId dentro de 30 días le aplica el pago. Sin esto, el pago se rechaza con Invoice was not found y no se guarda nada.
Default = false
status
El estado actual del pago. created: registrado, pero aún no enviado al procesador. failed: el intento falló antes de que el procesador respondiera. declined: el procesador lo rechazó. expired: no se completó a tiempo. cancelled: se canceló antes de ser procesado. authorized: la tarjeta fue aprobada y los fondos están retenidos, pero aún no se han cobrado. captured: el pago se cobró y aún no se ha liquidado. settled: el procesador liquidó los fondos. voided: cancelado antes de liquidarse, por lo que no se movió dinero. refundRequested: un reembolso está esperando a que el pago se liquide. returned: el banco devolvió el pago. chargebacked: el titular de la tarjeta disputó el pago. Un reembolso es un pago independiente, con refunded, refundSettled o refundFailed.
Default = captured | One of failed, declined, created, expired, cancelled, authorized, captured, voided, settled, returned, refundFailed, refunded, refundSettled, chargebacked, refundRequested
type
El tipo de método de pago utilizado para realizar el pago. credit es un crédito aplicado a una orden de compra (consulte credit); lo establece el sistema y no se puede enviar.
One of payment_card, ach, eft, apple_pay, google_pay, oxxo, spei, bnpl, dlocal, cash, check, other, credit
subType
El subtipo del método de pago utilizado para realizar el pago.
One of visa, mastercard, amex, discover, diners, jcb, checking, savings, oxxo, spei, bnpl, google_pay, dlocal, cash, check, other, creditNote
totals
Cómo se desglosa el monto del pago.
allocations
Las asignaciones para el pago. Este es un arreglo de objetos que especifican cómo se asignó el pago a diferentes pedidos o reembolsos.
deleted
Esta bandera representa si el registro ha sido eliminado y ya no está disponible para ser utilizado.