Skip to main content
POST
finance.receiving-account.get

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
receivingAccountId
string
required

ID of a record in your connected account.

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

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

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

Response

The result

receivingAccountId
string
required

ID of a record in your connected account.

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

Two-letter country code.

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

Account holder name.

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

Current receiving account state.

Available options:
active,
closed,
processing,
failed,
unknown
features
object[]
required

Requested receiving features.

Maximum array length: 50
supportedFeatures
object[]
required

Receiving and debit features available on the account.

Maximum array length: 50
accountNumber
string

Bank account number.

Required string length: 1 - 100
accountType
enum<string>

Bank account category.

Available options:
checking,
saving,
current,
payment
iban
string

International bank account number.

Required string length: 1 - 50
swiftCode
string

Bank SWIFT code.

Required string length: 1 - 20
nickname
string

Your label for the account.

Required string length: 1 - 200
alternateEmail
string

Alternate email identifier for Canadian deposits.

Required string length: 1 - 320
depositConversionCurrency
string

Three-letter currency code.

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

The account's bank details as one scheme, where its routing gives exactly one.