Skip to main content
POST
banking.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-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by banking.accounts.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
endUserRef
string

Your identifier for the person; when supplied it must match the consent owner.

Required string length: 1 - 256

Response

The result

rowRef
string

Handle of this row. Pass it as ref to banking.account.get, banking.account.balances.get or banking.account.owners.get.

type
string

Bank's account type.

Required string length: 1 - 100
name
string

Bank's account display name.

Required string length: 1 - 200
maskedAccountNumber
string

Account number with only its last digits visible.

Required string length: 1 - 34
Pattern: ^[Xx*]{2,30}[0-9]{1,4}$
currency
string

ISO currency code.

Pattern: ^[A-Z]{3}$