Get Payments
The following endpoint can be used to retrieve the details of Payments within the Hyfin application.
Endpoint
The following endpoint can be used to retrieve Payments. You must replace the {base_url} , {site_id} and {updated_after} variables with the appropriate values.
GET
{base_url}/api/v3.1/site/{site_id}/payments?updated_after={updated_after}
Request Query Parameters
Field
Type
Required
Description
updated_after
Date
--
A timestamp to be used as the start of the date range (exclusive) of the query. On subsequent requests, you should pass in the `next_updated_after` value that was in the response of the previous request. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
Response
Field
Type
Description
records_matched
Number
The number of records that matched the query parameters.
records_returned
Number
The number of records that were returned.
next_updated_after
Date
A timestamp to be used as the start of the date range (exclusive) of the next query for the same endpoint. This is used for pagination when querying with an updated_after parameter. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
records
The list of contacts that matched the query parameters.