Skip to main content
POST
finance.receiving-accounts.list

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
accountId
string

Optional connected sub-account ID; omit to use your own account.

Required string length: 1 - 200
Pattern: ^[A-Za-z0-9_-]+$
limit
number

Number of records, 1 to 50; default 10.

Required range: x >= 1
cursor
string

Next cursor returned by the previous list call.

Required string length: 1 - 2048
countryCode
string

Two-letter country code.

Required string length: 1 - 2
Pattern: ^[A-Z]{2}$
nickname
string

Exact receiving account label filter.

Required string length: 1 - 200
status
enum<string>

Receiving account state filter.

Available options:
active,
closed,
processing,
failed
requiredCurrency
string

Three-letter currency code.

Required string length: 1 - 3
Pattern: ^[A-Z]{3}$
supportedCurrency
string

Three-letter currency code.

Required string length: 1 - 3
Pattern: ^[A-Z]{3}$
fromCreatedAt
string<date-time>

Date and time in ISO 8601 format.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
toCreatedAt
string<date-time>

Date and time in ISO 8601 format.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Response

The result

results
object[]
required

Receiving accounts with bank details and holder identity.

Maximum array length: 50
nextCursor
string

Cursor for the next page, when there is one.

Maximum string length: 2048