Multigate
  1. 📩 Webhooks / Push Notifications
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
      • 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
      POST
    • Update Client Configuration Current Mode
      PATCH
    • Get Client Configuration
      GET
  1. 📩 Webhooks / Push Notifications

Add a New Client Configuration

POST
/client-service/api/v1/client-configurations
ClientConfiguration

Request

Body Params application/json
ClientConfigInput type
mode
enum<string> 
required
Allowed values:
livesandbox
clientId
string 
required
The client Id
callbackUrl
string 
optional
Client's callback URL
webhookUrl
string 
optional
Client's webhook URL
ipAddresses
array[string]
optional
List of ip adddresses to whitelist
Example
{
  "mode": "live",
  "clientId": "string",
  "callbackUrl": "string",
  "webhookUrl": "string",
  "ipAddresses": [
    "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/client-configurations' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mode": "live",
    "clientId": "string",
    "callbackUrl": "string",
    "webhookUrl": "string",
    "ipAddresses": [
        "string"
    ]
}'

Responses

🟢200OK
application/json
success response
Body
ClientConfigOutput type
data
object (ClientConfigOutputData) 
optional
the response data object
id
number 
optional
The id of the client
entityId
string 
optional
The entity ID of the client (nanoid)
createdAt
string 
optional
The date the entity was created
updatedAt
string 
optional
The last date the entity was updated
createdBy
string 
optional
The email of the user who created the entity
updatedBy
string 
optional
The email of the user who last updated the entity
isDeleted
string 
optional
Check if the entity has been deleted (soft delete)
mode
enum<string> 
required
Allowed values:
livesandbox
clientId
string 
required
The client Id
callbackUrl
string 
optional
Client's callback URL
webhookUrl
string 
optional
Client's webhook URL
ipAddresses
array[string]
optional
List of ip adddresses to whitelist
Example
{
  "data": {
    "id": 0,
    "entityId": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "createdBy": "string",
    "updatedBy": "string",
    "isDeleted": "string",
    "mode": "live",
    "clientId": "string",
    "callbackUrl": "string",
    "webhookUrl": "string",
    "ipAddresses": [
      "string"
    ]
  }
}
🟠400Bad Request
🟠401Unauthorized
Previous
📩 Webhooks / Push Notifications
Next
Update Client Configuration Current Mode
Built with