Reporting
Our reporting endpoint allows you to retrieve details on all the payments in your account.
Payment details are retrieved by sending a GET request to the /payments
endpoint, using the same authentication as you would when submitting a payment request.
GET /payments
This will return a maximum of 20 payments, starting from one month prior to today.
The response will consist of a JSON object with two properties. available
tells you the maximum number of possible results given the supplied parameters, and results
contains an array of payment details.
{
"available": 4,
"results": [
{...},
{...},
{...},
{...}
]
}
Parameters
You can restrict the search range using the from
and to
parameters. Each is a time in ISO8601 format, eg: 2021-03-15T12:01:10-05:00.
GET /payments?from=2021-03-15T12%3A01%3A10&to=2021-03-15T12%3A01%3A10
Please note that payments are recorded in UTC so times provided will be converted to UTC before being used. In general, this should be pretty seamless, though you should be aware of this fact if you opt to provide from
or to
parameters which do not include your timezone offset.
Pagination
Two further parameters allow you to paginate through the results.
limit
allows you to specify how many results you want to be returned, with a minimum of 1, up to a maximum of 100.
offset
allows you to specify the point in the available results after which you want the returned results to start.
As an example, let's assume there are 13 possible results available.
GET /payments?limit=5
This will return results 1, 2, 3, 4 & 5.
GET /payments?limit=5&offset=5
This will return results 6, 7, 8, 9 & 10.
Updated over 3 years ago