Add a new beneficiary for the organisation

post

https://eclipse-java-sandbox.ukheshe.rocks/eclipse-conductor/rest/v1/tenants/{tenantId}/organisations/{organisationId}/beneficiaries

Creates a new beneficiary

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tenantId

int64

required

organisationId

int64

required

Body Params

accountHolderName

string

length between 2 and 50

Beneficiary account holder name

accountType

string

length between 2 and 30

Optional. Account type of beneficiary account details.

additionalFields

array of objects

additionalFields

address1

string

Beneficiary address1

address2

string

Beneficiary address2

alias

string

length between 1 and 50

Alias (some friendly name)

bankAccountNumber

string

Beneficiary's bank account number

bankIdentificationCode

string

length between 2 and 50

Bank Identification Code(BIC) unique identifier for a specific financial institution

bankName

string

Beneficiary's Bank name

beneficiaryAccountId

string

Account Id of Beneficiary's account

branchCode

string

Beneficiary's branch code

city

string

Beneficiary's city

code

string

Beneficiary postal code

country

string

Beneficiary's country

dob

string

length between 8 and 8

Beneficiary's Date of birth must be in form of yyyyMMdd

string

firstName

string

length between 2 and 50

Beneficiary first/given name

iban

string

length between 2 and 50

International Bank Account Number unique identifier for a specific customer

identityNumber

string

Beneficiary identity number

identityType

string

enum

Beneficiary identity Type

Allowed:

initials

string

lastName

string

length between 2 and 50

Beneficiary last name

middleName

string

Beneficiary middle name

mobileMoneyNetwork

string

Beneficiary mobile-money network

mobileNumber

string

Beneficiary mobile number

nationality

string

onlyCheck

boolean

Optional. If true, the beneficiary will not be created, but the account number will be validated in AVS to confirm its eligibility for the transaction.

provider

string

enum

Currently supported remittance types.

Allowed:

reference

string

Reference (some reference name)

saveOnPass

boolean

Optional. If true, the beneficiary will be created only if the beneficiary status is ACTIVE.

state

string

Beneficiary's state

walletId

int64

Beneficiary's wallet-Id

Responses

400

Bad Request

200OK