Create Limit Profile(s)
Creates a Limit Profile for a merchant. Allowing the merchant to set a limit on a customer's account.
This endpoint is protected with OAuth 2.0 Bearer token
Endpoint URL: {{base_url}}/api/v1/limit-profile/
HTTP Method: POST
The {{base_url}} for test is https://sandbox.monnify.com but when you go live, it changes to the live url
Once the request is sent, a Limit Profile code will be returned. This Limit Profile code is the unique identifier for that Limit Profile and will be used to reference the Limit Profile in reserve account requests.
Create Limit Profile Request
{
"limitProfileName":"Test Limit Profile",
"singleTransactionValue":2000,
"dailyTransactionVolume":500,
"dailyTransactionValue": 150000
} Create Limit Response
{
"requestSuccessful": true,
"responseMessage": "success",
"responseCode": "0",
"responseBody": {
"limitProfileCode": "2XKTQ3LE9NH2",
"limitProfileName": "Test Limit Profile",
"singleTransactionValue": 2000,
"dailyTransactionVolume": 500,
"dailyTransactionValue": 150000,
"dateCreated": "29/10/2019 01:49:09 PM",
"lastModified": "29/10/2019 01:49:09 PM"
}
}Field Reference
(M) indicates fields that are mandatory in the request body
Field | Description |
|---|---|
limitProfileName (M) | The name of the Limit Profile |
singleTransactionValue(M) | The maximum amount that can be allowed per transaction on the reserved accounts. |
dailyTransactionVolume(M) | The maximum number of transaction count per day allowed on the reserved accounts |
dailyTransactionValue(M) | The maximum amount per day in all transactions that can be allowed on the reserved accounts |
limitProfileCode | This Limit Profile code is the unique identifier for the Limit Profile used to reference the Limit Profile |