Get Limit Profiles
Returns a list of Limit Profiles previously created by the merchant.
This endpoint is protected with OAuth 2.0 Bearer token
Endpoint URL: {{base_url}}/api/v1/limit-profile/
HTTP Method: GET
The {{base_url}} for test is https://sandbox.monnify.com but when you go live, it changes to the live url
Get Limit Profile Response
{
"requestSuccessful": true,
"responseMessage": "success",
"responseCode": "0",
"responseBody": {
"content": [
{
"limitProfileCode": "CJNRPG6VDHYE",
"limitProfileName": "test1572206098031",
"singleTransactionValue": 1000.00,
"dailyTransactionVolume": 10,
"dailyTransactionValue": 10000.00,
"dateCreated": "27/10/2019 07:54:58 PM",
"lastModified": "27/10/2019 07:54:58 PM"
},
{
"limitProfileCode": "R36JFNENPWJ5",
"limitProfileName": "Apata_Merchant_1",
"singleTransactionValue": 23000.00,
"dailyTransactionVolume": 571,
"dailyTransactionValue": 410000000.00,
"dateCreated": "28/10/2019 04:01:58 PM",
"lastModified": "28/10/2019 04:01:58 PM"
},
{
"limitProfileCode": "2XKTQ3LE9NH2",
"limitProfileName": "Update-Name",
"singleTransactionValue": 601.00,
"dailyTransactionVolume": 6,
"dailyTransactionValue": 6000.00,
"dateCreated": "29/10/2019 01:49:09 PM",
"lastModified": "30/10/2019 10:00:15 AM"
}
],
"pageable": {
"sort": {
"sorted": false,
"unsorted": true,
"empty": true
},
"pageSize": 10,
"pageNumber": 0,
"offset": 0,
"unpaged": false,
"paged": true
},
"totalElements": 3,
"last": true,
"totalPages": 1,
"sort": {
"sorted": false,
"unsorted": true,
"empty": true
},
"first": true,
"numberOfElements": 3,
"size": 10,
"number": 0,
"empty": false
}
}
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 |