Get Payment

Usa esto cuando necesites los detalles completos de un pago, por ejemplo, después de un webhook de pago.


The following endpoint can be used to retrieve the details of a payment within the Hyfin 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 que asignamos a este pago. Omítelo al crear un pago y envíalo al actualizar uno.
externalId
String
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
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
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
status
String
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
manualStatusChange
El cambio de estado más reciente que un usuario hizo manualmente en la app, como marcar un pago como rechazado. Úselo para distinguir un cambio manual de uno reportado por la pasarela de pago. Se omite cuando nadie ha cambiado el estado del pago manualmente.
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. 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
String
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.
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.
credit
String
En una aplicación de crédito (type credit), el _id del crédito que se aplicó; null en cualquier otro pago. Una aplicación de crédito no mueve dinero a través de una pasarela de pago, no tiene comisiones y no se puede reembolsar ni actualizar mediante la API.
checkout
El pago en el portal de clientes del que formó parte este pago, para poder agrupar un pago con tarjeta y los créditos aplicados con él; null en caso contrario.
syncToPrimaryOnly
Boolean
true en una aplicación de crédito: registra cómo se saldó una orden de compra y no debe registrarse en un sistema contable como un pago en efectivo.
authCode
String
El código de autorización que devolvió la pasarela de pago cuando aprobó el pago; null cuando no devolvió ninguno, como en la mayoría de los pagos bancarios.
paymentGatewayTransaction
El registro del pago en la pasarela de pago.
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.
			
{
  "_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
    }
  ],
  "authCode": "253558",
  "paymentGatewayTransaction": {
    "id": "53912387124235234",
    "key": "253558",
    "keyDisplay": "Auth Code"
  },
  "paymentTransactionEvents": [
    {
      "type": "sale",
      "amount": 3515,
      "successful": true,
      "createdAt": "2021-01-01T14:32:18.000Z",
      "transactionId": "53912387124235234"
    }
  ]
}


		

Ver también