Get Payment
The following endpoint can be used to retrieve the details of a payment within the Centz application.
Punto Final
The following endpoint can be used to retrieve a payment. You must replace the {base_url} , {_id} and {site_id} variables with the appropriate values.
GET
{base_url}/api/v4/site/{site_id}/payment/{_id}
Solicitud
Ningún cuerpo es necesario para esta llamada de API
Respuesta
Campo
Tipo
Descripción
_id
String
El id del pago. Este campo es generado automáticamente por el sistema y no es necesario al crear un nuevo pago, pero es necesario al actualizar un pago existente.
externalId
String
El id único del pago del sistema o base de datos de origen. Obligatorio cuando no se envía _id. Si detectamos un registro con el mismo externalId, se actualizará; de lo contrario, se agregará.
displayName
String
El nombre de visualización seguro y amigable del método de pago. Ejemplo: VISA **** 3421.
amount
Number
El monto que se pagó. Este es un número entero de centavos, por lo que 1035 significa $10.35.
paidOn
Date
La fecha y hora en que se realizó el pago. Format = YYYY-MM-DDTHH:mm:ssZ
status
String
El estado actual del pago.
Default = captured | One of declined, authorized, captured, voided, settled, returned, refundFailed, refunded, refundSettled
Default = captured | One of declined, authorized, captured, voided, settled, returned, refundFailed, refunded, refundSettled
customer
String
El _id del cliente que realizó el pago.
site
String
El _id del sitio
type
String
El tipo de método de pago utilizado para realizar el pago.
One of payment_card, ach, cash, check
One of payment_card, ach, cash, check
subType
String
El subtipo del método de pago utilizado para realizar el pago.
One of checking, savings, visa, mastercard, discover, amex, cash, other
One of checking, savings, visa, mastercard, discover, amex, cash, other
totals
Los montos totales del pago.
isRefund
Boolean
Indica si el pago es un reembolso de otro pago.
origPayment
String
En un reembolso, el _id del pago que reembolsó. Se omite en los pagos que no son reembolsos.
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.
paymentTransactionEvents
Los eventos de transacción para el pago. Esta es una matriz de objetos que especifican la historia de la transacción de pago, como cuándo fue autorizada, capturada, reembolsada, etc.
Sample Response
{
"_id": "61f32dc2f62bdc6a48945067",
"externalId": "62331255",
"displayName": "VISA **** 5123",
"site": "6201825a0cf5e23261a08646",
"customer": "649dc5bb468bd5b5d863c7d1",
"type": "payment_card",
"subType": "visa",
"amount": 3515,
"totals": {
"taxes": 0,
"discounts": 0,
"total": 3515
},
"paidOn": "2021-01-01T14:32:18.000Z",
"status": "captured",
"isRefund": false,
"allocations": [
{
"refType": "Invoice",
"ref": "61f32dc2f62bdc6a48951255",
"amount": 3515
}
],
"paymentTransactionEvents": [
{
"type": "sale",
"amount": 3515,
"successful": true,
"createdAt": "2021-01-01T14:32:18.000Z",
"transactionId": "53912387124235234"
}
]
}
Sample Response (Refund)
{
"_id": "61f32dc2f62bdc6a48962418",
"externalId": null,
"displayName": "VISA **** 5123",
"site": "6201825a0cf5e23261a08646",
"customer": "649dc5bb468bd5b5d863c7d1",
"type": "payment_card",
"subType": "visa",
"amount": 3515,
"totals": {
"taxes": 0,
"discounts": 0,
"total": 3515
},
"paidOn": "2021-01-04T09:12:40.000Z",
"status": "refunded",
"isRefund": true,
"origPayment": "61f32dc2f62bdc6a48945067",
"allocations": [
{
"refType": "Invoice",
"ref": "61f32dc2f62bdc6a48951255",
"amount": 3515
}
],
"paymentTransactionEvents": [
{
"type": "refund",
"amount": 3515,
"successful": true,
"createdAt": "2021-01-04T09:12:40.000Z",
"transactionId": "53912387124298771"
}
]
}