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

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`.

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`

createdAt

Date

The date the payment was created.

updatedAt

Date

The date the payment was last updated.

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`

subType

String

The sub type of the payment method used to make the payment.
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.

deleted

Boolean

This flag represents whether the record is deleted and no longer available to be used.

Sample Response

			
{
  "_id": "61f32dc2f62bdc6a48945067",
  "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"
}