Multigate
  1. 👤 Beneficiaries
Multigate
  • 🚀 Getting Started
  • 🔓 Authentication
    • Get Token
    • Refresh Token
    • Logout User
  • 👋 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
  1. 👤 Beneficiaries

Validate Beneficiary Account (NGN only)

POST
/client-service/api/v1/beneficiaries/validate
Beneficiary

Request

Body Params application/json
BeneficiaryLookUpInput type
bankAccountNumber
string 
optional
The client profile UUID (optional)
countryIso3Code
string 
optional
Account currency (required)
currencyIso3Code
string 
optional
Account Name (required)
bankCode
string 
optional
Account country (optional)
Example
{
  "bankAccountNumber": "string",
  "countryIso3Code": "string",
  "currencyIso3Code": "string",
  "bankCode": "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 POST 'https://api-gateway-uat.mmacs.io/platform/client-service/api/v1/beneficiaries/validate' \
--header 'Content-Type: application/json' \
--data-raw '{
    "bankAccountNumber": "string",
    "countryIso3Code": "string",
    "currencyIso3Code": "string",
    "bankCode": "string"
}'

Responses

🟢200OK
application/json
success response
Body
BeneficiaryLookUpOutput type
accountName
string 
optional
The client profile UUID (optional)
bankName
string 
optional
Account currency (required)
Example
{
  "accountName": "string",
  "bankName": "string"
}
🟠400Bad Request
🟠401Unauthorized
Previous
Update Beneficiary
Next
Create Single Transfer
Built with