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
      • Download 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

Get All Beneficiaries

GET
/client-service/api/v1/beneficiaries

Request

Query Params

Request Code 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

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
Modified at 2025-01-29 16:40:48
Previous
Create Beneficiary
Next
Get Beneficiary
Built with