Skip to main content
POST
finance.beneficiary.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

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

Recipient legal name, as the bank holds it.

Required string length: 1 - 200
bank
object
required

Bank details; scheme says which fields apply.

beneficiaryId
string

Your own ID for the saved record. Accounts that assign their own IDs decline it; accounts that need yours decline its absence.

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

Connected sub-account to save into; omit to use your own account.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
entityType
enum<string>

A person or a company.

Available options:
individual,
company
firstName
string

Person's first name, when the account asks for it.

Required string length: 1 - 100
lastName
string

Person's last name, when the account asks for it.

Required string length: 1 - 100
dateOfBirth
string<date>

Calendar date, YYYY-MM-DD.

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])))$
address
object

Postal address.

currency
string

Currency of the recipient's bank account; some schemes imply it.

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

Contact email.

Maximum string length: 200
Pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
phone
string

Contact phone number.

Required string length: 1 - 32
Pattern: ^[0-9+() -]{8,32}$
additionalInfo
object

Identity details some corridors require.

nickname
string

Your label for the recipient.

Required string length: 1 - 200
transferMethods
enum<string>[]

Bank networks to use for this recipient, where the account asks.

Required array length: 1 - 2 elements

Local bank network or international bank transfer.

Available options:
local,
swift
payerEntityType
enum<string>

Expected payer type.

Available options:
individual,
company
scaExemptible
boolean

Whether the saved recipient may be exempted from additional authentication.

transferReason
string

Business reason used to validate recipient details.

Required string length: 1 - 200

Response

The result

beneficiaryId
string
required

Your beneficiary record ID, for follow-up calls.

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

Beneficiary name.

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

Account's reported beneficiary state; saved means the account accepted the details and has no separate verification step.

Available options:
pending,
saved,
verified,
invalid,
canceled,
failed,
deleted,
unknown
verificationOffered
boolean

Whether this account verifies saved beneficiaries itself, so status can become verified. When false, saved is the final usable state.

bank
object

Bank details, typed by scheme.

currency
string

Currency of the bank account, when known.

Required string length: 1 - 3
bankAccount
string

Bank account number or IBAN, when present; the same as in bank.

Required string length: 1 - 34
routingCode
string

Bank routing code, when the scheme has one; the same as in bank.

Required string length: 1 - 34
paymentAddress
string

Payment address, when present.

Required string length: 1 - 256
email
string

Beneficiary email, when present.

Required string length: 1 - 320
phone
string

Beneficiary phone, when present.

Required string length: 1 - 32
entityType
enum<string>

Person or company.

Available options:
individual,
company
nickname
string

Your label for the recipient.

Required string length: 1 - 200
createdAt
string<date-time>

Date and time with timezone, ISO 8601.

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)))$