Skip to main content
POST
finance.beneficiaries.search

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

Exact beneficiary bank account to find.

Required string length: 1 - 25
Pattern: ^[0-9]{4,25}$
routingCode
string
required

Exact Indian bank routing code.

Required string length: 1 - 11
Pattern: ^[A-Z]{4}0[A-Z0-9]{6}$

Response

The result

items
object[]
required

Matching beneficiary in your own account; name, bank and contact details.

Maximum array length: 1