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} , {_id} and {site_id} variables with the appropriate values.
GET
{base_url}/api/v4/site/{site_id}/payment/{_id}
Request
No body is required for this API call
Response
Field
Type
Description
_id
String
The id of the payment. This field is auto generated by the system and is not required when creating a new payment, but it is required when updating an existing payment.
displayName
String
The secure friendly display name of the payment method. Example: VISA **** 3421.
amount
Number
The amount that was paid. This is an integer number of cents, so 1035 means $10.35.
paidOn
Date
The date and time of when the payment was made. Format = YYYY-MM-DDTHH:mm:ssZ
status
String
The current status of the payment.
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
The _id of the customer who made the payment.
site
String
The _id of the site
type
String
The type of payment method used to make the payment.
One of payment_card, ach, cash, check
One of payment_card, ach, cash, check
subType
String
The sub type of the payment method used to make the payment.
One of checking, savings, visa, mastercard, discover, amex, cash, other
One of checking, savings, visa, mastercard, discover, amex, cash, other
totals
The total amounts of the payment.
allocations
The allocations for the payment. This is an array of objects that specify how the payment was allocated to different orders or refunds.
paymentTransactionEvents
The transaction events for the payment. This is an array of objects that specify the history of the payment transaction, such as when it was authorized, captured, refunded, etc.
Sample Response
{
"_id": "61f32dc2f62bdc6a48945067",
"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",
"allocations": [
{
"refType": "Invoice",
"ref": "61f32dc2f62bdc6a48951255",
"amount": 3515
}
],
"paymentTransactionEvents": [
{
"type": "sale",
"amount": 3515,
"successful": true,
"createdAt": "2021-01-01T14:32:18.000Z",
"transactionId": "53912387124235234"
}
]
}