Skip to main content
List accounts

Authorizations

X-API-Key
string
header
required

Your Swipelux API key. Obtain this from the Swipelux Dashboard.

Path Parameters

customerId
string
required

Query Parameters

cursor
string

Opaque cursor returned as nextCursor from the previous page.

limit
integer
default:25

Maximum number of records to return. Defaults to 25.

Required range: 1 <= x <= 100
updatedAfter
string<date-time>

Return only records updated at or after this RFC 3339 timestamp. Use it to recover from missed webhooks by replaying a window of changes.

type
enum<string>

Filter accounts by public account type.

Available options:
wallet,
bank
method
string

Filter bank accounts by payment method. Open enum — values are added over time; clients must tolerate unknown values.

status
enum<string>

Filter accounts by public status. Closed enum — exhaustive; additions would be a breaking change.

Available options:
provisioning,
in_review,
ready,
action_required,
suspended,
rejected,
archived
origin
enum<string>

Filter accounts by origin. Closed enum — exhaustive; additions would be a breaking change.

Available options:
issued,
external

Response

Accounts retrieved

data
object[]
required
nextCursor
string | null
required
hasMore
boolean
required