Skip to main content
GET
List external accounts

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

userId
string
required

ID of the user.

Pattern: ^user_[A-Za-z0-9]+$
counterPartyId
string
required

Public ID of the counter party (prefixed with cpty_)

Query Parameters

limit
integer

default to 10, maximum to 100

Required range: 1 <= x <= 100
startingAfter
string

Return records after this cursor.

endingBefore
string

Return records before this cursor.

status
enum<string>

Filter external accounts by status.

Available options:
ACTIVE,
INACTIVE
transferType
enum<string>

Filter external accounts by transfer type.

Available options:
ACH,
WIRE,
SWIFT,
RTP,
PIX,
SPEI,
CHATS,
FPS,
CIPS,
SEPA,
INSTAPAY,
PESONET,
NEQUI,
BANK
currency
enum<string>

Filter external accounts by currency.

Available options:
USD,
EUR,
BRL,
NGN,
KES,
TZS,
UGX,
BWP,
XAF,
MWK,
RWF,
ZMW,
XOF,
ZAR,
MXN,
PHP,
AED,
HKD,
CNY,
COP,
ARS,
SGD,
GBP

Response

A cursor-paginated list of external accounts.

Cursor-paginated list of external accounts.

data
object[]
pagination
object