StatePaymentResponseDto
This document presents the StatePaymentResponseDto, a key data structure used in the NoWallet API to retrieve detailed information about a transaction's current state.
It helps merchants track the payment flow, verify balances, fees, transaction statuses, and other operational details.
JSON Response Example
The JSON snippet illustrates a typical response structure for a payment state query. It includes multiple fields such as:
- status: The current status of the transaction.
- transaction_id: A unique identifier for the transaction.
- additional_infos: Customer information like email, name, and phone number.
- amount: The transaction amount.
- currency: The currency used for the transaction.
- fee_percent: The percentage of the transaction fee.
- fee_value: The value of the transaction fee.
- balance: The merchant's balance after the transaction.
- balance_before: The merchant's balance before the transaction.
- balance_after: The merchant's balance after the transaction.
- transaction_method: The method used for the transaction.
- transaction_phone_number: The phone number associated with the transaction.
- transaction_dialcode: The dial code for the transaction phone number.
- signature: The signature generated for the transaction.
- transaction_date: The date of the transaction.
- transaction_country_code: The country code for the transaction.
- transaction_service_name: The name of the service used for the transaction.
- transaction_observation: Any observations related to the transaction.
Example Payload
Here is an example of a valid payload for the StatePaymentResponseDto:
{
"status": "SUCCESS",
"transaction_id": "EXAMPLE-ba325fc6-ca09eb7b4dce",
"additional_infos": {
"customer_email": "[email protected]",
"customer_lastname": "Doe",
"customer_firstname": "John",
"customer_phone": "+237691234567"
},
"amount": 200,
"currency": "XAF",
"fee_percent": 1.2,
"fee_value": 20,
"balance": 200,
"balance_before": 180,
"balance_after": 220,
"transaction_method": "MERCHANT",
"transaction_phone_number": "691234567",
"transaction_dialcode": "+237",
"signature": "EXAMPLE-XXXXX-XXXXX",
"transaction_date": "2025-01-01TZ00:00:00",
"transaction_country_code": "CM",
"transaction_service_name": "ORANGE MONEY",
"transaction_observation": ""
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| status | string | true | none | transaction status |
| transaction_id | string | true | none | transaction id |
| additional_infos | object | true | none | client informations like email, lastname, firstname, phone |
| amount | number | true | none | transaction amount |
| currency | string | true | none | transaction currency |
| fee_percent | number | true | none | fees applied to the transaction in percentage |
| fee_value | number | true | none | fees applied to the transaction in value |
| balance | number | true | none | merchant balance |
| balance_before | number | true | none | merchant balance before the transaction |
| balance_after | number | true | none | merchant balance after the transaction |
| transaction_method | string | true | none | transaction type (CASHIN, CASHOUT, MERCHANT) |
| transaction_phone_number | string | true | none | customer phone number |
| transaction_dialcode | string | true | none | customer phone number dial code |
| signature | string | true | none | signature generate from ClaPay for the transaction |
| transaction_date | string | true | none | transaction date |
| transaction_country_code | string | true | none | transaction country code |
| transaction_service_name | string | true | none | transaction operator label |
| transaction_observation | string | true | none | transaction observation note if there is any issue |
Enumerated Values
Some fields use predefined values:
| Property | Value |
|---|---|
| status | FAILED |
| status | SUCCESSFUL |
| status | PENDING |
| status | INITIATED |
| status | INITIATEFROMCLIENT |
| status | UNCOMPLETED |
| status | CLOSED |
| status | UNKNOWN |
| status | SIGNATURE_DESTROYED |
| status | INPROGRESS |
| status | UNAVAILABLE_SERVICES |
| currency | DZD |
| currency | AOA |
| currency | BWP |
| currency | BIF |
| currency | CVE |
| currency | XAF |
| currency | KMF |
| currency | CDF |
| currency | DJF |
| currency | EGP |
| currency | ERN |
| currency | ETB |
| currency | EUR |
| currency | GMD |
| currency | GHS |
| currency | GNF |
| currency | XOF |
| currency | KES |
| currency | LSL |
| currency | LRD |
| currency | LYD |
| currency | MGA |
| currency | MWK |
| currency | MRO |
| currency | MUR |
| currency | MAD |
| currency | MZN |
| currency | NAD |
| currency | NGN |
| currency | RWF |
| currency | SHP |
| currency | STN |
| currency | RSD |
| currency | SCR |
| currency | SLL |
| currency | SOS |
| currency | ZAR |
| currency | SSP |
| currency | SDG |
| currency | SZL |
| currency | TZS |
| currency | TND |
| currency | UGX |
| currency | AED |
| currency | USD |
| currency | ZMW |
| currency | ZWL |
| transaction_method | CASHIN |
| transaction_method | MERCHANT |
| transaction_method | CASHOUT |
This page was helpful?