Multigate
  1. 💰 Accounts
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
      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
  1. 💰 Accounts

Get Account

GET
/client-service/api/v1/accounts/{accountNumber}
Account
Retrieve a specific account by the account number.

Request

Path Params
accountNumber
string 
required
Account Number

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/'

Responses

🟢200OK
application/json
success response
Body
AccountOutput type
entityId
string 
optional
Account id
currencyIso3Code
string 
optional
Account currency
accountName
string 
optional
Account name
fundingDetails
array [object {5}] 
optional
Account funding details (SSIs)
bankOrSortCode
string 
optional
Bank code e.g. SWIFT BIC, sort code, routing code
accountNumber
string 
optional
Account number
bankCountry
string 
optional
Bank country
bankName
string 
optional
Bank name
bankAddress
string 
optional
Bank address
status
enum<string> 
optional
Account status
Allowed values:
processingactivedisconnecteddisabledfailed
availableBalance
number 
optional
Available balance
accountType
enum<string> 
optional
Account type
Allowed values:
multigatelinked
Example
{
  "entityId": "MeMjZgLaixUunSHLRqP9d",
  "currencyIso3Code": "NGN",
  "accountName": "ABC Limited",
  "fundingDetails": [
    {
      "bankOrSortCode": "100039",
      "accountNumber": "9832903324",
      "bankCountry": "NGA",
      "bankName": "Paystack Titan",
      "bankAddress": null
    }
  ],
  "status": "active",
  "availableBalance": 543754.76,
  "accountType": "multigate"
}
🟠400Bad Request
🟠401Unauthorized
Previous
Create Virtual Account
Next
Get Accounts By
Built with