v1

latestOpenAPI 3.1.02026-07-241653251.3 MB

Payments

List fiat transaction history

Retrieves the historical fiat transactions (ACH / same-day ACH / wire / RTP) for the calling platform, with optional filters by participant, transfer type, or a set of transaction identifiers.

get/payments/history

Query parameters

participantstring

Example:ABCDEF

Filter to a single participant code.

transaction_idsstring[]

Optional list of transaction identifiers to fetch. Repeat the query parameter for multiple ids (e.g. ?transaction_ids=id1&transaction_ids=id2).

transfer_type'credit' | 'debit'

Filter for the given transfer_type

pagenumber

Filter for a specific page (pagination)

sizenumber

Filter for the amount of transaction objects will be returned per request

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required

Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Response

Successfully retrieved paginated list of fiat transactions with optional filters: participant, transfer_type.

request_idstring uuid

Request identifier echoed back from the request.

pagenumber

page_sizenumber

countnumber

Example response

{
  "request_id": "0f68333e-2114-469d-b505-c850d776e063",
  "message": [
    {
      "transaction_id": "0f68333e-2114-469d-b505-c850d776e061",
      "participant_code": "ALI123",
      "external_account_id": "0f68333e-2114-469d-b505-c850d776e063",
      "amount": "12.01",
      "bank_fee": "12.01",
      "status_history": [
        {
          "timestamp": "1975-08-19T23:15:30.000Z"
        }
      ],
      "trade_id": "0f34533e-2114-469d-b505-c850d776e061",
      "bank_transfer_id": "0f68333e-2114-469d-b505-c850d776e061",
      "created_at": "1975-08-19T23:15:30.000Z",
      "updated_at": "1975-08-19T23:15:30.000Z"
    }
  ],
  "page": 1,
  "page_size": 200,
  "count": 10
}