Use this service to retrieve transactions for a date range.
Edit me
API Details
Note: Before using this API request you must first retrieve the URI (the account identifier - {accountId}) for your Origix IP technical account. See List Account.
The List Transactions service retrieves transactions for a required date range.
| Usage | Use your {accountId} and specify a date range and/or an amount range to refine the list of transactions returned. |
| Method | POST |
| URI | /accounts/{accountId}/transactions/list |
| Optional Arguments | filter.valuedateFrom
Epoch timestamp format; the date from which the transactions should be returned. |
| filter.valuedateTo
Epoch timestamp format; the date up to when the balance should be returned. |
|
| filter.amountFrom
The lower amount in the range. |
|
| filter.amountTo
The higher amount in the range (Max amount 9,999,999,999.99). |
A successful request will return a 200 OK response code
Two key details are returned:- id: A value that uniquely identifies the account in Origix IP.
- uri: A resolvable path containing the account. Use this in the List and View Transaction requests.
The following is the complete list of possible status codes, which may be returned in the response:
| Status Code | Description |
|---|---|
| 200 | OK - The request completed successfully. |
| 201 | Created - A new resource has been created successfully. The resource is appended to the response. |
| 400 | Bad Request - The request was malformed. The response body will include an error providing further information. |
| 401 | Unauthorized - Your API key is wrong. |
| 403 | Forbidden - The client has provided a valid Authentication header, but it does not have permission to access this resource. |
| 404 | Not Found - The requested resource did not exist. |
| 405 | Method Not Allowed - When a HTTP method is being requested that isn’t allowed. |
| 410 | Gone - The API requested has been removed from our servers. |
| 412 | Precondition Failed - Certain unmet conditions must be fulfilled before the request to be processed e.g. timestamp is too old. |
| 415 | Unsupported Media Type - If incorrect content type was provided as part of the request (e.g. other than “application/json”). |
| 422 | Unprocessable Entity - Used for validation errors. More details will be provided in response body. |
| 500 | Internal Server Error - We had a problem with our server. Try again later and if the problem persists contact the Nuapay application support team. |
| 501 | Not Implemented - When the endpoint is not implemented yet. |
| 503 | Service Unavailable - We’re temporarially offline for maintanance. Please try again later. |