Get Beneficiary

GET

/client-service/api/v1/beneficiaries/{beneficiaryId}

Beneficiary

Request

Path Params

beneficiaryId

string

required

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

success response

Body

BeneficiaryOutput type

accountName

string

optional

The client profile UUID (optional)

accountNumber

string

optional

Account currency (required)

bankBicOrCode

string

optional

Account Name (required)

bankName

string

optional

Account country (optional)

bankAddress

string

optional

Account bankCode (optional)

name

string

optional

Account number (optional)

addressLine1

string

optional

Partner uuid (optional)

addressLine2

string

optional

Reason for the account opening (optional)

city

string

optional

Reason for the account opening (optional)

state

string

optional

Reason for the account opening (optional)

country

string

optional

Reason for the account opening (optional)

currencyIso3Code

string

optional

Reason for the account opening (optional)

emailAddress

string

optional

Reason for the account opening (optional)

phoneNumber

string

optional

Reason for the account opening (optional)

clientId

string

optional

Reason for the account opening (optional)

subClientId

string

optional

Reason for the account opening (optional)

intermediaryBank

#/components/schemas/IntermediaryBankInput

optional

the response data object

branchInformation

#/components/schemas/BranchInformationInput

optional

the response data object

Example

🟠400Bad Request

🟠401Unauthorized

Get All Beneficiaries

Update Beneficiary