Multigate
  1. 💰 Accounts
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
      POST
    • Get Account
      GET
    • Get Accounts By
      GET
    • Get All Accounts
      GET
    • Simulate Inflow (UAT only)
      POST
  • 🔃 Conversions
    • Get Quote
    • Lock Rate
    • Get Trade
    • Get All Trades
  • 💸 Payments
    • 🏦 Banks
      • Get Bank Details
    • 👤 Beneficiaries
      • Create Beneficiary
      • Get All Beneficiaries
      • Get Beneficiary
      • Update Beneficiary
      • Validate Beneficiary Account (NGN only)
    • Create Single Transfer
    • Get Purpose Codes
    • Get Transfer Fields & Fees
    • Find Transfers
  • 📩 Webhooks / Push Notifications
    • Add a New Client Configuration
    • Update Client Configuration Current Mode
    • Get Client Configuration
  • 📲 Remittance
    • Initiate Remittance
    • Get Remittance
  1. 💰 Accounts

Get Accounts By

GET
/client-service/api/v1/accounts/by
Account
Retrieve accounts by accountNumber or, if no accountNumber is available, the account entityId.

Request

Query Params
accountNumber
string 
optional
Account number
Example:
1238286123
entityId
string 
optional
Account entityId
Example:
8nlhb1PyH1M5IdvcNOab9

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/accounts/by?accountNumber=1238286123&entityId=8nlhb1PyH1M5IdvcNOab9'

Responses

🟢200OK
application/json
success response
Body
message
string 
required
account
object (AccountOutput) 
required
AccountOutput type
entityId
string 
required
Account id
currencyIso3Code
string 
required
Account currency
accountName
string 
required
Account name
fundingDetails
array [object {6}] 
required
Account funding details (SSIs)
status
enum<string> 
required
Account status
Allowed values:
processingactivedisconnecteddisabledfailed
availableBalance
number 
required
Available balance
accountType
enum<string> 
optional
Account type
Allowed values:
multigatelinked
Example
{
    "message": "account(s) successfully retrieved",
    "account": {
        "entityId": "zqkLGh3pDQoXD4WBqttQH",
        "currencyIso3Code": "NGN",
        "accountName": "Lateef Reconfirmation Test Account",
        "status": "active",
        "availableBalance": 0,
        "accountType": "multigate",
        "fundingDetails": [
            {
                "bankOrSortCode": "test-bank",
                "accountNumber": "1238286191",
                "bankCountry": "NGA",
                "bankName": "Paystack Titan",
                "bankAddress": null,
                "countryIso3Code": "NGA"
            }
        ]
    }
}
🟠400Bad Request
🟠401Unauthorized
Modified at 2025-05-29 09:42:52
Previous
Get Account
Next
Get All Accounts
Built with