StatePaymentResponseDto
Ce document présente le StatePaymentResponseDto, une structure de données clé utilisée dans l’API NoWallet pour récupérer des informations détaillées sur l’état actuel d’une transaction.
Il aide les commerçants à suivre le flux de paiement, vérifier les soldes, les frais, les statuts des transactions, et d’autres détails opérationnels.
Exemple de réponse JSON
L’extrait JSON illustre une structure de réponse typique pour une requête d’état de paiement.
Il inclut plusieurs champs tels que :
- status : Le statut actuel de la transaction.
- transaction_id : Un identifiant unique de la transaction.
- additional_infos : Informations du client comme l’e-mail, le nom et le numéro de téléphone.
- amount : Le montant de la transaction.
- currency : La devise utilisée pour la transaction.
- fee_percent : Le pourcentage des frais appliqués à la transaction.
- fee_value : La valeur des frais de la transaction.
- balance : Le solde du commerçant après la transaction.
- balance_before : Le solde du commerçant avant la transaction.
- balance_after : Le solde du commerçant après la transaction.
- transaction_method : La méthode utilisée pour la transaction.
- transaction_phone_number : Le numéro de téléphone associé à la transaction.
- transaction_dialcode : L’indicatif téléphonique du numéro de téléphone utilisé.
- signature : La signature générée pour la transaction.
- transaction_date : La date de la transaction.
- transaction_country_code : Le code pays de la transaction.
- transaction_service_name : Le nom du service utilisé pour la transaction.
- transaction_observation : Toute observation liée à la transaction.
Exemple de charge utile
Voici un exemple de charge utile valide pour le 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": ""
}
Propriétés
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| status | string | true | aucune | Statut de la transaction |
| transaction_id | string | true | aucune | Identifiant de la transaction |
| additional_infos | object | true | aucune | Informations du client comme email, lastname, firstname, phone |
| amount | number | true | aucune | Montant de la transaction |
| currency | string | true | aucune | Devise de la transaction |
| fee_percent | number | true | aucune | Pourcentage des frais appliqués à la transaction |
| fee_value | number | true | aucune | Valeur des frais de la transaction |
| balance | number | true | aucune | Solde du commerçant après la transaction |
| balance_before | number | true | aucune | Solde du commerçant avant la transaction |
| balance_after | number | true | aucune | Solde du commerçant après la transaction |
| transaction_method | string | true | aucune | Type de transaction (CASHIN, CASHOUT, MERCHANT) |
| transaction_phone_number | string | true | aucune | Numéro de téléphone du client |
| transaction_dialcode | string | true | aucune | Indicatif téléphonique du numéro de téléphone du client |
| signature | string | true | aucune | Signature générée par ClaPay pour la transaction |
| transaction_date | string | true | aucune | Date de la transaction |
| transaction_country_code | string | true | aucune | Code pays de la transaction |
| transaction_service_name | string | true | aucune | Nom du service utilisé pour la transaction |
| transaction_observation | string | true | aucune | Note d'observation de la transaction s'il y a un problème |
Valeurs Énumérées
Certaines champs utilisent des valeurs prédéfinies :
| Propriété | Valeur |
|---|---|
| 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 |
Cette page vous a-t-elle été utile ?