POST
/v2/transactions/history/completedGet Completed Transactions History
Returns paginated completed and authorized transactions. Supports optional filters.
Headers
| Field | Type | Required | Possible values | Description |
|---|---|---|---|---|
Authorization | string | Required | Bearer {SessionToken} | Session token from Get Session Token, sent as `Authorization: Bearer {SessionToken}`. Replace with the value from the `x-refresh-token` response header when present (typically within 2 minutes of expiry). Secured calls must use the same IP as the auth request. |
Request body
| Field | Type | Required | Possible values | Description |
|---|---|---|---|---|
PageNumber | integer | Required | 1 | 2 | 3 | 4 | 5 | ... N | Page index for paginated results (1-based). |
PageSize | integer | Required | 10 | 20 | 30 | 40 | 50 | ... N | Number of records to return per page. |
Direction | string | Optional | debit | credit | Filter by direction: `debit` (outgoing payment) or `credit` (incoming deposit). |
TransactionType | String | Optional | Please refer to the transaction type section in the API Reference | Filter by transaction type. See Transaction Types in the API reference. |
FromDate | string | Optional | 2022-01-01 | Start of date range (inclusive), in `YYYY-MM-DD` format. |
ToDate | string | Optional | 2022-01-01 | End of date range (inclusive), in `YYYY-MM-DD` format. |
Description | string | Optional | Test API Payment | Filter completed transactions by matching this description text. |
Example request
{
"PageNumber": 1,
"PageSize": 30
}Response
| Field | Type | Possible values | Description |
|---|---|---|---|
ResponseCode | integer | 200 | 201 | 204 | 400 | 401 | 403 | 404 | 410 | 422 | 500 | 301 | 503 | 422 | API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized). |
ResponseMessage | string | Success | Created | NoContent | BadRequest | Unauthorized | Forbidden | NotFound | Gone | UnprocessableContent | ServerError | ResourceMoved | ServiceUnAvailable | UnProcessableEntity | Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome. |
ResponseData | object | Please refer to below example for response body | Paginated list of completed or authorized transactions. |
Example response
{
"ResponseCode": 200,
"ResponseMessage": "Success",
"ResponseData": {
"Data": [
{
"Amount": "1.00",
"CreatedAt": "2022-09-13T06:10:03.029-04:00",
"Currency": "USD",
"Description": "Dummy Deposit For Test",
"Direction": "Credit",
"From": "Test Sender",
…Requires `Authorization: Bearer {SessionToken}` from Get Session Token. Refresh via `x-refresh-token` when supplied; use the same client IP as authentication.