Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
e) Organisation Management

Get an organisation's beneficiary by ID

get/eclipse-conductor/rest/v1/tenants/{tenantId}/organisations/{organisationId}/beneficiaries/{beneficiaryId}

Path parameters

tenantIdinteger required
organisationIdinteger required
beneficiaryIdinteger required

Response

OK

accountHolderNamestring

Beneficiary account holder name

accountTypestring

Optional. Account type of beneficiary account details.

address1string

Beneficiary address1

address2string

Beneficiary address2

aliasstring

Alias (some friendly name)

bankAccountNumberstring

Beneficiary's bank account number

bankIdentificationCodestring

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

bankNamestring

Beneficiary's Bank name

beneficiaryIdinteger

Unique Id of Beneficiary

branchCodestring

Beneficiary's branch code

citystring

Beneficiary's city

codestring

Beneficiary postal code

countrystring

Beneficiary's country

createdstring date-time

ISO 8601 date/time of when the record was first created

customerIdinteger

Id of Customer

dobstring

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

emailstring
firstNamestring

Beneficiary first/given name

ibanstring

International Bank Account Number unique identifier for a specific customer

identityNumberstring

Beneficiary identity number

identityType'SBR' | 'SID' | 'SPP' | 'TRN'
lastModifiedstring date-time

ISO 8601 date/time of when the record was last modified

lastNamestring

Beneficiary last name

middleNamestring

Beneficiary middle name

mobileMoneyNetworkstring

Beneficiary mobile-money network

mobileNumberstring

Beneficiary mobile number

nationalitystring
organisationIdinteger

Id of Organisation

referencestring

Reference (some reference name)

statestring

Beneficiary's state

status'ACTIVE' | 'BLOCKED' | 'PENDING' | 'REJECTED'
walletIdinteger

Beneficiary's wallet-Id

Example response

{
  "created": "2022-03-10T12:15:50-04:00",
  "lastModified": "2022-03-10T12:15:50-04:00"
}