Documentación de la API 3.1Documentación de la API 4.0 SimpleDocumentación de la API 4.0

Get Payment

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 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.
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
createdAt
Date
La fecha en que se creó el pago.
updatedAt
Date
La fecha en que se actualizó el pago por última vez.
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
subType
String
El subtipo del método de pago utilizado para realizar el pago.
One of checking, savings, visa, mastercard, discover, amex, cash, other
totals
Los montos totales 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.
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.
deleted
Boolean
Esta bandera representa si el registro ha sido eliminado y ya no está disponible para ser utilizado.
Sample Response
			
{
  "_id": "61f32dc2f62bdc6a48945067",
  "paymentType": "payment_card",
  "paymentSubType": "amex",
  "displayName": "AMEX ****** 3422",
  "last4": "3422",
  "amount": 3000,
  "paidOn": "2021-03-15T16:32:11Z",
  "status": "captured",
  "transactionType": "capture",
  "createdAt": "2025-05-30T19:19:44.143Z",
  "updatedAt": "2025-05-30T19:19:44.143Z",
  "deleted": false
}