Home
POST/v2/transactions/history

Get Incomplete Transaction History

Returns paginated transactions that are incomplete, rejected, cancelled, or failed. Supports optional filters.

Headers

FieldTypeRequiredPossible valuesDescription
AuthorizationstringRequiredBearer {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

FieldTypeRequiredPossible valuesDescription
PageNumberintegerRequired1 | 2 | 3 | 4 | 5 | ... NPage index for paginated results (1-based).
PageSizeintegerRequired10 | 20 | 30 | 40 | 50 | ... NNumber of records to return per page.
DirectionstringOptionaldebit | creditFilter by direction: `debit` (outgoing payment) or `credit` (incoming deposit).
StatusstringOptionalDENIED | PENDING | EXPIRED | CANCELLEDFilter by transaction status (e.g. DENIED, PENDING, EXPIRED, CANCELLED).
TransactionTypestringOptionalPlease refer to the transaction type section in the API ReferenceFilter by transaction type. See Transaction Types in the API reference.
FromDatestringOptional2022-01-01Start of date range (inclusive), in `YYYY-MM-DD` format.
ToDatestringOptional2022-01-01End of date range (inclusive), in `YYYY-MM-DD` format.

Example request

{
  "PageNumber": 1,
  "PageSize": 50
}

Response

FieldTypePossible valuesDescription
ResponseCodeinteger200 | 201 | 204 | 400 | 401 | 403 | 404 | 410 | 422 | 500 | 301 | 503 | 422API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized).
ResponseMessagestringSuccess | Created | NoContent | BadRequest | Unauthorized | Forbidden | NotFound | Gone | UnprocessableContent | ServerError | ResourceMoved | ServiceUnAvailable | UnProcessableEntityHuman-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.
ResponseDataobjectPlease refer to below example for response bodyPaginated list of incomplete, rejected, cancelled, or failed transactions.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "Data": [
      {
        "Amount": "1.00",
        "CreatedAt": "2022-09-13T06:09:23.245-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.

Search guide books, endpoints, paths, or parameters

↑↓navigateopenEscclose