- Introduction
- Authorization
- Beneficiaries
- Cards
- Card Programs
- Clients
- Endusers
- Transactions
- Wallets
- Relays
- Webhooks
Get beneficiary by ID
GET
/customers/v1/beneficiaries/{id}
Request
Path Params
id
string
required
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/customers/v1/beneficiaries/'Responses
🟢200Success
application/json
Body
id
string
required
account_number
string
required
bank_code
string
required
bank_code_type
enum<string>
required
Allowed values:
BSBBPAYROUTING_NUMBER
bank_country
string
required
bank_name
string
required
created_at
string <date-time>
required
metadata
object
required
email
string
required
updated_at
string <date-time>
required
status
enum<string>
required
Allowed values:
ACTIVEINACTIVE
person
object
required
name
string
required
Example
{
"id": "string",
"account_number": "string",
"bank_code": "string",
"bank_code_type": "BSB",
"bank_country": "string",
"bank_name": "string",
"created_at": "2019-08-24T14:15:22Z",
"metadata": {
"email": "string"
},
"updated_at": "2019-08-24T14:15:22Z",
"status": "ACTIVE",
"person": {
"name": "string"
}
}