Get Transactions
Description: To get a list of agency transactions, a HTTP GET request is made to the URL with the page number, transaction type and session token.
Method: GET
URI: /agency/transactions
Parameters:
page: The page of transactions
type: The type of transaction. Either "credit" or "debit".
Headers: Authorization: Third party based authorization header
Returns
| Field | Type | Description |
|---|---|---|
| id | Integer | Unique ID of the transaction. |
| agency_id | Integer | Unique ID of the transaction's agency. |
| user_id | Integer | Unique ID of the user who created the transaction. |
| reference | String | Unique reference number of the transaction. |
| amount | Integer | Monetary value specified in cents. |
| comment | String | Comment about the transaction. |
| created | Integer | Returns Unix timestamp of when transaction was created. |
| credit | Boolean | The transaction is a credit type. |
| debit | Boolean | The transaction is a debit type. |
| given_name | String | First name of the transaction's creator. |
| surname | String | Last name of the transaction's creator. |
| form_id | Integer | Unique ID of the form in the transaction. |
| failed | Boolean | Returns true if trasaction failed. |
| failed_reason | String | A string relating to why the transaction failed. |
Example
Request
Response