Create Beneficiary

Request

Body Params application/json

accountName

string

required

Beneficiary account name

accountNumber

string

required

Beneficiary account number

bankBicOrCode

string

required

Beneficiary bank BIC or code

bankName

string

required

Beneficiary bank name

bankAddress

string

required

Beneficiary bank address

name

string

required

Beneficiary name

<= 100 characters

addressLine1

string

required

Beneficiary address

<= 200 characters

addressLine2

string

optional

Beneficiary address

<= 200 characters

city

string

required

Beneficiary city

state

string

required

Beneficiary state

country

string

required

Beneficiary country (ISO3 code)

currencyIso3Code

string

required

Beneficiary account currency

emailAddress

string

required

Beneficiary email address

phoneNumber

string

required

Beneficiary phone number

paymentMethod

string

optional

Reason for the account opening (optional)

clientId

string

required

Client id

subClientId

string

optional

Subclient id (if applicable)

intermediaryBank

object (IntermediaryBankInput)

optional

IntermediaryBankInput type

bankName

string

required

bank name (optional)

bic

string

required

bic of the intermediary bank (optional)

country

string

required

country of intermediary bank (optional)

branchInformation

object (BranchInformationInput)

optional

BranchInformationInput type

branchName

string

optional

branchName of bank branch (optional)

branchCode

string

optional

branchCode of bank branch (optional)

city

string

optional

city of bank branch (optional)

Example

{
  "accountName": "string",
  "accountNumber": "string",
  "bankBicOrCode": "string",
  "bankName": "string",
  "bankAddress": "string",
  "name": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "city": "string",
  "state": "string",
  "country": "string",
  "currencyIso3Code": "string",
  "emailAddress": "string",
  "phoneNumber": "string",
  "paymentMethod": "string",
  "clientId": "string",
  "subClientId": "string",
  "intermediaryBank": {
    "bankName": "string",
    "bic": "string",
    "country": "string"
  },
  "branchInformation": {
    "branchName": "string",
    "branchCode": "string",
    "city": "string"
  }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api-gateway-uat.mmacs.io/platform/client-service/api/v1/beneficiaries' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountName": "string",
    "accountNumber": "string",
    "bankBicOrCode": "string",
    "bankName": "string",
    "bankAddress": "string",
    "name": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "currencyIso3Code": "string",
    "emailAddress": "string",
    "phoneNumber": "string",
    "paymentMethod": "string",
    "clientId": "string",
    "subClientId": "string",
    "intermediaryBank": {
        "bankName": "string",
        "bic": "string",
        "country": "string"
    },
    "branchInformation": {
        "branchName": "string",
        "branchCode": "string",
        "city": "string"
    }
}'

Responses

🟢200OK

application/json

success response

Body

BeneficiaryOutput type

id

string

optional

Beneficiary id

accountName

string

optional

Beneficiary account name

accountNumber

string

optional

Beneficiary account number

bankBicOrCode

string

optional

Beneficiary bank BIC or code

bankName

string

optional

Beneficiary bank name

bankAddress

string

optional

Beneficiary bank address

name

string

optional

Beneficiary name

addressLine1

string

optional

Beneficiary address

addressLine2

string

optional

Beneficiary address

city

string

optional

Beneficiary city

state

string

optional

Beneficiary state

country

string

optional

Beneficiary country (ISO3 code)

currencyIso3Code

string

optional

Beneficiary account currency

emailAddress

string

optional

Beneficiary email address

phoneNumber

string

optional

Beneficiary phone number

paymentMethod

string

optional

Beneficiary payment method

clientId

string

optional

Client id

subClientId

string

optional

Subclient id (if applicable)

intermediaryBank

object (IntermediaryBankInput)

optional

IntermediaryBankInput type

bankName

string

required

bank name (optional)

bic

string

required

bic of the intermediary bank (optional)

country

string

required

country of intermediary bank (optional)

branchInformation

object (BranchInformationInput)

optional

BranchInformationInput type

branchName

string

optional

branchName of bank branch (optional)

branchCode

string

optional

branchCode of bank branch (optional)

city

string

optional

city of bank branch (optional)

Example

{
  "id": "string",
  "accountName": "string",
  "accountNumber": "string",
  "bankBicOrCode": "string",
  "bankName": "string",
  "bankAddress": "string",
  "name": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "city": "string",
  "state": "string",
  "country": "string",
  "currencyIso3Code": "string",
  "emailAddress": "string",
  "phoneNumber": "string",
  "paymentMethod": "string",
  "clientId": "string",
  "subClientId": "string",
  "intermediaryBank": {
    "bankName": "string",
    "bic": "string",
    "country": "string"
  },
  "branchInformation": {
    "branchName": "string",
    "branchCode": "string",
    "city": "string"
  }
}

🟠400Bad Request

🟠401Unauthorized