Skip to main content
POST
finance.beneficiary-requirements.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
profileId
string
required

Id of a record in your connected account.

Required string length: 1 - 16
Pattern: ^[1-9][0-9]{0,15}$
quoteId
string<uuid>

Id of a transfer quote in your connected account.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
fromCurrency
string

Three-letter currency code.

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

Three-letter currency code.

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

Positive amount in currency units.

Required range: x <= 1000000000000
originatorType
enum<string>

Actual sender type.

Available options:
personal,
business
addressRequired
boolean
default:false

Force address to be required; quote GET only.

draft
object

Recipient draft containing holder identity and bank-routing data; forwarded only for validation.

Response

The result

types
object[]
required

Conditional requirements for each route.

Maximum array length: 30