InitPaymentResponseModelDto
The InitPaymentResponseModelDto is a data transfer object (DTO) used in the NoWallet API to represent the response received after initiating a payment.
This model contains essential information about the payment transaction, including the country, currency, signature, available and authorized operators, and the payment URL.
JSON Response Example
The JSON section provides a sample response that the server returns after a payment transaction is created. It includes several important fields:
- country: The country code where the transaction is taking place.
- currency: The currency code used for the transaction.
- signature: The signature generated from API for the transaction.
- available_operator and authorized_operator: Lists of operators available and authorized for the transaction.
- payment_url: The payment URL for the transaction initiated by the merchant.
This example serves as a quick reference to understand the expected structure and content.
Example Payload
Here is an example of a valid payload for the InitPaymentResponseModelDto:
{
"country": "CM",
"currency": "XAF",
"signature": "EXAMPLE-XXXXX-XXXXX",
"available_operator": ["MTN", "OM"],
"authorized_operator": ["MTN", "OM"],
"payment_url": "https://example.com/payment"
}
Properties
The Properties table offers a detailed description of each field present in the JSON response:
- The Name of the field,
- Its Type (e.g.,
string,array), - Whether it is Required or not,
- Any Restrictions that apply to the field,
- A brief Description of the field's purpose.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| country | string | true | none | country code of the transaction, the country code is an ISO 3166-1 alpha-2 or alpha-3 |
| currency | string | true | none | currency code of the transaction, the currency code is an ISO 4217 |
| signature | string | true | none | signature generate from ClaPay for the transaction |
| available_operator | array | true | none | operators available for this transaction |
| authorized_operator | array | true | none | operators authorized for this transaction |
| payment_url | string | true | none | payment url of the transaction initiated by the merchant |
This section helps developers fully understand the meaning and correct handling of each data item returned by the API.
Enumerated Values
The Enumerated Values section lists all the possible values for the country property.
Each value corresponds to a standardized country code, based on ISO 3166-1 alpha-2 or alpha-3 standards.
| Property | Value |
|---|---|
| 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 ensures that only valid, recognized country codes are used when identifying the country of origin for a transaction.
Was this page helpful?