Multigate
  1. 👤 Beneficiaries
Multigate
  • 🚀 Getting Started
  • 🔓 Authentication
    • Get Token
    • Refresh Token
    • Logout User
    • Reset Password
    • Get Current User Info
  • 👋 Onboarding
    • Create Subclient
    • Get All Subclients
    • Get Subclient
    • Update Subclient
    • Create Subclient Shareholder
    • Get Subclient Shareholders
    • Update Subclient Shareholder
    • Upload Subclient Documents
    • Get Subclient Documents
    • Delete Subclient
    • Submit Subclient
  • 💰 Accounts
    • 📄 Statements
      • Get Statement
    • Create Virtual Account
    • Get Account
    • Get Accounts By
    • Get All Accounts
    • Simulate Inflow (UAT only)
  • 🔃 Conversions
    • Get Quote
    • Lock Rate
    • Get Trade
    • Get All Trades
  • 💸 Payments
    • 🏦 Banks
      • Get Bank Details
    • 👤 Beneficiaries
      • Create Beneficiary
        POST
      • Get All Beneficiaries
        GET
      • Get Beneficiary
        GET
      • Update Beneficiary
        PUT
      • Validate Beneficiary Account (NGN only)
        POST
    • Create Single Transfer
      POST
    • Get Purpose Codes
      GET
    • Get Transfer Fields & Fees
      POST
    • Find Transfers
      GET
  • 📩 Webhooks / Push Notifications
    • Add a New Client Configuration
    • Update Client Configuration Current Mode
    • Get Client Configuration
  • 📲 Remittance
    • Initiate Remittance
    • Get Remittance
  1. 👤 Beneficiaries

Update Beneficiary

PUT
/client-service/api/v1/beneficiaries/{beneficiaryId}/update
Beneficiary
Update a beneficiary's details.

Request

Path Params
beneficiaryId
string 
required
Body Params application/json
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)
paymentMethod
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)
postcode
string 
optional
Reason for the account opening (optional)
intermediaryBank
object (IntermediaryBankInput) 
optional
the response data object
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
the response data object
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",
    "postcode": "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
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://api-gateway-uat.mmacs.io/platform/client-service/api/v1/beneficiaries//update' \
--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",
    "postcode": "string",
    "intermediaryBank": {
        "bankName": "string",
        "bic": "string",
        "country": "string"
    },
    "branchInformation": {
        "branchName": "string",
        "branchCode": "string",
        "city": "string"
    }
}'

Responses

🟢200OK
application/json
success response
Body
UpdateBeneficiaryInput 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)
paymentMethod
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)
postcode
string 
optional
Reason for the account opening (optional)
intermediaryBank
object (IntermediaryBankInput) 
optional
the response data object
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
the response data object
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",
    "postcode": "string",
    "intermediaryBank": {
        "bankName": "string",
        "bic": "string",
        "country": "string"
    },
    "branchInformation": {
        "branchName": "string",
        "branchCode": "string",
        "city": "string"
    }
}
🟠400Bad Request
🟠401Unauthorized
Modified at 2025-02-03 16:54:44
Previous
Get Beneficiary
Next
Validate Beneficiary Account (NGN only)
Built with