PaymentLimitationAmountDto
The PaymentLimitationAmountDto is a data transfer object (DTO) used by the NoWallet API to define and enforce transaction amount limits based on country and method.
This DTO is primarily useful for validating transactions according to regulatory and platform-specific thresholds across different African countries.
JSON Response Example
The code block at the bottom of the paragraph provides a sample JSON payload illustrating how the DTO might look when populated. In this example, a CASHIN transaction is allowed with a minimum amount of 10 and a maximum of 100,000 for the country code CM (Cameroon). This structure helps developers understand the expected format and types of data involved when working with the API.
{
"max_amount": 100000,
"min_amount": 10,
"method": "CASHIN",
"country": "CM"
}
Properties
The Properties table breaks down the individual fields included in the DTO. Each property is listed with its name, data type, whether it is required, and a brief description of its purpose:
- max_amount and min_amount define the upper and lower thresholds allowed for the transaction.
- method specifies the transaction type (e.g., CASHIN, CASHOUT).
- country refers to the ISO 3166-1 alpha-2 country code representing where the limitation applies.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| max_amount | number | true | none | transaction maximum amount |
| min_amount | number | true | none | transaction minimum amount |
| method | string | true | none | transaction method of limitation |
| country | string | true | none | transaction country code of limitation |
These fields are all mandatory and ensure that the transaction stays within allowed parameters.
Enumerated Values
The enumerated values section specifies the accepted values for the method and country fields. For method, three types are supported: CASHIN, MERCHANT, and CASHOUT, representing different transaction flows. For country, a comprehensive list of supported African countries is provided, using their two-letter ISO codes.
| Property | Value |
|---|---|
| method | CASHIN |
| method | MERCHANT |
| method | CASHOUT |
| country | DZ |
| country | AO |
| country | BJ |
| country | BW |
| country | BF |
| country | BI |
| country | CM |
| country | CV |
| country | CF |
| country | TD |
| country | KM |
| country | CG |
| country | CD |
| country | CI |
| country | DJ |
| country | EG |
| country | GQ |
| country | ER |
| country | ET |
| country | GA |
| country | GM |
| country | GH |
| country | GN |
| country | GW |
| country | KE |
| country | LS |
| country | LR |
| country | LY |
| country | MG |
| country | MW |
| country | ML |
| country | MR |
| country | MU |
| country | YT |
| country | MA |
| country | MZ |
| country | NA |
| country | NE |
| country | NG |
| country | RE |
| country | RW |
| country | ST |
| country | SN |
| country | SC |
| country | SL |
| country | SO |
| country | ZA |
| country | SS |
| country | SD |
| country | SZ |
| country | TZ |
| country | TG |
| country | TN |
| country | UG |
| country | EH |
| country | ZM |
| country | ZW |
This section ensures that developers implement the API using only valid predefined options, reducing errors and promoting interoperability across systems that depend on standardized country and method codes.
Was this page helpful?