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

Get All Beneficiaries

GET
/client-service/api/v1/beneficiaries
Beneficiary

Request

Query Params
pageSize
integer 
optional
page size - int64
pageOffset
integer 
optional
page offset- int64
sortField
string 
optional
field to sort by - string
sortDirection
enum<string> 
optional
Allowed values:
ASCDESC
sourceBankBicOrCode
string 
optional
field to input sourceBankBicOrCode - string
sourceAccountNumber
string 
optional
field to input sourceAccountNumber - string
sourceCurrencyIso3Code
string 
optional
field to input sourceCurrencyIso3Code - string
partnerProfileId
string 
optional
field to input partnerProfileId - 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 GET 'https://api-gateway-uat.mmacs.io/platform/client-service/api/v1/beneficiaries?pageSize&pageOffset&sortField&sortDirection&sourceBankBicOrCode&sourceAccountNumber&sourceCurrencyIso3Code&partnerProfileId'

Responses

🟢200OK
application/json
success response
Body
BeneficiaryOutputArray type
message
string 
optional
the response message
count
number 
optional
the data count
items
array[object (BeneficiaryOutput) {18}] 
optional
the response data object
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)
clientId
string 
optional
Reason for the account opening (optional)
subClientId
string 
optional
Reason for the account opening (optional)
intermediaryBank
#/components/schemas/IntermediaryBankInput
optional
the response data object
Could not resolve '#/components/schemas/IntermediaryBankInput'
branchInformation
#/components/schemas/BranchInformationInput
optional
the response data object
Could not resolve '#/components/schemas/BranchInformationInput'
Example
{
  "message": "string",
  "count": 0,
  "items": [
    {
      "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
Previous
Create Beneficiary
Next
Get Beneficiary
Built with