Sign in

v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Payments

List external accounts

Retrieves a paginated list of external accounts linked to the calling platform, optionally filtered by participants, account type, or account status.

get/payments/external_accounts

Query parameters

participantsstring
Example:ABCDEF

Comma-separated list of participant codes to filter on (e.g. ABCDEF,DEMO01).

account_type'checking' | 'savings'

Filter for a specific account_type

account_status'pending' | 'submitted' | 'approved' | 'closed' | 'deleted' | 'rejected' | 'locked' | 'disabled' | 'revoked' | 'failed'

Filter for a specific account_status

pagenumber

Filter for a specific page (pagination)

sizenumber

Filter for the amount of external account 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 external accounts with optional filters: participants, account_type, account_status.

request_idstring

Request id

pagenumber
page_sizenumber
countnumber

Example response

{
  "request_id": "0f68333e-2114-469d-b505-c850d776e063",
  "message": [
    {
      "external_account_id": "0f68333e-2114-469d-b505-c850d776e063",
      "account_number": "123456789",
      "routing_number": "011401533",
      "account_nickname": "test1",
      "participant_code": "ALI123",
      "platform_code": "TES123",
      "created_at": "2026-05-04T11:54:13.099Z",
      "updated_at": "1975-08-19T23:15:30.000Z",
      "status_reason": "invalid processor token"
    }
  ],
  "page": 1,
  "page_size": 200,
  "count": 10
}