InitPaymentResponseModelDto
Le InitPaymentResponseModelDto est un objet de transfert de données (DTO) utilisé dans l'API NoWallet pour représenter la réponse reçue après l'initialisation d'un paiement.
Ce modèle contient des informations essentielles sur la transaction de paiement, notamment le pays, la devise, la signature, les opérateurs disponibles et autorisés, ainsi que l'URL de paiement.
Exemple de Réponse JSON
La section JSON fournit un exemple de réponse que le serveur retourne après la création d'une transaction de paiement.
Elle inclut plusieurs champs importants :
- country : Le code du pays où la transaction a lieu.
- currency : Le code de la devise utilisée pour la transaction.
- signature : La signature générée par l'API pour la transaction.
- available_operator et authorized_operator : Listes des opérateurs disponibles et autorisés pour la transaction.
- payment_url : L'URL de paiement pour la transaction initiée par le commerçant.
Cet exemple sert de référence rapide pour comprendre la structure et le contenu attendus.
Exemple de Payload
Voici un exemple de payload valide pour le InitPaymentResponseModelDto :
{
"country": "CM",
"currency": "XAF",
"signature": "EXAMPLE-XXXXX-XXXXX",
"available_operator": ["MTN", "OM"],
"authorized_operator": ["MTN", "OM"],
"payment_url": "https://example.com/payment"
}
Propriétés
Le tableau des propriétés détaille chaque champ inclus dans le payload de la requête :
- Name : Le nom du champ dans le payload,
- Type : Le type de données attendu (par exemple,
string,array), - Required : Indique si le champ est obligatoire ou non,
- Restrictions : Toute restriction ou condition particulière pour le champ,
- Description : Une brève explication de ce que le champ représente et comment il doit être utilisé.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| country | string | true | aucune | Code du pays de la transaction, basé sur les normes ISO 3166-1 alpha-2 ou alpha-3. |
| currency | string | true | aucune | Code de la devise de la transaction, basé sur les normes ISO 4217. |
| signature | string | true | aucune | Signature générée par ClaPay pour la transaction. |
| available_operator | array | true | aucune | Liste des opérateurs disponibles pour cette transaction. |
| authorized_operator | array | true | aucune | Liste des opérateurs autorisés pour cette transaction. |
| payment_url | string | true | aucune | URL de paiement de la transaction initiée par le commerçant. |
Cette section aide les développeurs à comprendre pleinement la signification et la gestion correcte de chaque élément de données retourné par l'API.
Valeurs Énumérées
La section Valeurs Énumérées liste toutes les valeurs possibles pour la propriété country.
Chaque valeur correspond à un code pays standardisé, basé sur les normes ISO 3166-1 alpha-2 ou alpha-3.
| Propriété | Valeur |
|---|---|
| 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 |
Cela garantit que seuls des codes pays valides et reconnus sont utilisés pour identifier le pays d'origine d'une transaction.
Cette page vous a-t-elle été utile ?