Sign in

v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Payments

List fiat transaction statuses

Retrieves fiat transaction status objects for the calling platform. Defaults: when start_date/end_date are omitted, the last day of transactions is returned; when page/size are omitted, the first 200 transactions are returned; omitting participant or status removes the respective filter.

get/payments/status

Query parameters

start_dateinteger
Example:1777895286

Inclusive start of the query window as a Unix timestamp in seconds.

end_dateinteger
Example:1777895700

Inclusive end of the query window as a Unix timestamp in seconds.

participantstring

Filter for the given participant code

transaction_idstring

Filter for the given transaction_id

trade_idstring

Filter for the given trade_id

status'posted' | 'cancelled' | 'failed' | 'returned' | 'submitted' | 'pending' | 'settled' | 'rejected' | 'pending_trade' | 'returned_settled' | 'retried' | 'unspecified'

Filter for the given status of the transaction

pagenumber

Filter for a specific page (pagination)

sizenumber

Filter for the amount of transaction status objects returned

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 transaction statuses with optional filters: start_date, end_date, participant, transaction_id, trade_id, status.

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",
      "amount": "12.01",
      "bank_transfer_id": "0f68333e-2114-469d-b505-c850d776e061",
      "trade_id": "0f68333e-2114-469d-b505-c850d776e061",
      "trade_status": "terminated",
      "velocity_failed_rule": "participant_transactions(in_flight_transfers_by_participant)",
      "ach_failure_reason": "Insufficient balance",
      "created_at": "1975-08-19T23:15:30.000Z",
      "updated_at": "1975-08-19T23:15:30.000Z"
    }
  ],
  "page": 1,
  "page_size": 200,
  "count": 10
}