Hyfin Logotipo
Documentación de la API 3.0Documentació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} , {external_id} and {site_id} variables with the appropriate values.

GET
{base_url}/api/v3.1/site/{site_id}/payment/{external_id}
Solicitud
Ningún cuerpo es necesario para esta llamada de API
Respuesta
Campo
Tipo
Requerido
Descripción
external_id
String
The unique payment id from the source system/database. If we detect a record with the same `external_id`, it will be updated, otherwise it will be added.
gateway_transaction_id
String
El identificador único que se asignó al registro de pago desde la pasarela cuando se procesó el pago.
display_name
String
The secure friendly display name of the payment method. Example: `VISA **** 3421`.
last_4
String
--
Los últimos 4 dígitos del método de pago.
total
Number
--
El monto que se pagó. Format = 0.00
paid_on
Date
La fecha y hora en que se realizó el pago. Format = YYYY-MM-DDTHH:mm:ssZ
tip
Number
--
La cantidad de propina que se agregó. Format = 0.00
tax
Number
--
El monto de impuestos que se agregó. Format = 0.00
fee
Number
--
La cantidad de la tarifa que se agregó. Format = 0.00
payment_type
String
--
El tipo de método de pago utilizado para realizar el pago.
One of `payment_card`, `ach`, `cash`, `check`
payment_sub_type
String
--
El subtipo del método de pago utilizado para realizar el pago.
One of `checking`, `savings`, `visa`, `mastercard`, `discover`, `amex`, `cash`, `other`
status
String
--
El estado actual del pago.
Default = `captured` | One of `declined`, `authorized`, `captured`, `voided`, `settled`, `returned`, `refundFailed`, `refunded`, `refundSettled`
transaction_type
String
--
El tipo de transacción.
active
Boolean
--
Esta bandera representa si el registro de pago está activo.
Default = `true`
created_at
Date
--
La fecha en que se creó el pago.
updated_at
Date
--
La fecha en que se actualizó el pago por última vez.
Sample Response
			
				{
  "_id": "61f32dc2f62bdc6a48945067",
  "external_id": "65432325",
  "payment_type": "payment_card",
  "payment_sub_type": "amex",
  "display_name": "AMEX ****** 3422",
  "last_4": "3422",
  "total": 30,
  "paid_on": "2021-03-15T16:32:11Z",
  "status": "captured",
  "transaction_type": "capture",
  "active": true,
  "created_at": "2025-05-30T19:19:44.143Z",
  "updated_at": "2025-05-30T19:19:44.143Z"
}