API Docs 3.1API Docs 4.0 SimpleAPI Docs 4.0

Get Payment

The following endpoint can be used to retrieve the details of a payment within the Hyfin application.

Endpoint

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}
Request
No body is required for this API call
Response
Field
Type
Description
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
The unique id that was assigned to the payment record from the gateway when the payment was processed.
display_name
String
The secure friendly display name of the payment method. Example: VISA **** 3421.
last_4
String
The last 4 digits of the payment method.
amount
Number
The amount that was paid. Format = 0.00
paid_on
Date
The date and time of when the payment was made. Format = YYYY-MM-DDTHH:mm:ssZ
tip
Number
The tip amount that was added. Format = 0.00
tax
Number
The tax amount that was added. Format = 0.00
fee
Number
The fee amount that was added. Format = 0.00
payment_type
String
The type of payment method used to make the payment.
One of payment_card, ach, cash, check
payment_sub_type
String
The sub type of the payment method used to make the payment.
One of checking, savings, visa, mastercard, discover, amex, cash, other
status
String
The current status of the payment.
Default = captured | One of declined, authorized, captured, voided, settled, returned, refundFailed, refunded, refundSettled
transaction_type
String
The type of transaction.
active
Boolean
This flag represents whether the payment record is active.
Default = true
created_at
Date
The date the payment was created.
updated_at
Date
The date the payment was last updated.
Sample Response
			
{
  "_id": "61f32dc2f62bdc6a48945067",
  "external_id": "65432325",
  "payment_type": "payment_card",
  "payment_sub_type": "amex",
  "display_name": "AMEX ****** 3422",
  "last_4": "3422",
  "amount": 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"
}