InitPaymentModelDTO

Le InitPaymentModelDTO définit la structure de l'objet de transfert de données (DTO) utilisé pour initier une demande de paiement dans l'API NoWallet.
Il est utilisé par les marchands pour initier un processus de paiement en spécifiant les détails essentiels de la transaction, les informations du client et les préférences de paiement.

Exemple de Réponse JSON

La section JSON fournit un exemple de structure qu'un marchand enverrait lors de l'initialisation d'une transaction de paiement.
Les champs clés incluent :

• transaction_id : Un identifiant unique pour la transaction.
• additional_infos : Informations sur le client telles que l'email, le nom et le numéro de téléphone.
• amount : Le montant à traiter.
• callback_url : L'URL où le marchand recevra le résultat du paiement.
• return_url : L'URL où le client sera redirigé après le paiement.
• country_code : Le code pays pour la transaction.
• operators_code : Les codes des opérateurs de mobile money pour la transaction.
• method : Le type de transaction (par exemple, CASHIN, CASHOUT, MERCHANT).
• tunnel : Le mode de transaction (par exemple, API, CHECKOUTPAGE).
• operator_otp : Le code OTP de l'opérateur si nécessaire.

Cet exemple aide les développeurs à visualiser le format attendu et les composants clés d'une demande valide d'initialisation de paiement.

Exemple de Payload

Voici un exemple de payload valide pour le InitPaymentModelDTO :

{
  "transaction_id": "ca3a65bb-9008-443d-8d4b-61c3b0006438",
  "additional_infos": {
    "customer_email": "[email protected]",
    "customer_lastname": "Doe",
    "customer_firstname": "John",
    "customer_phone": "+237691234567"
  },
  "amount": 200,
  "callback_url": "https://example.com/callback",
  "return_url": "https://example.com/return",
  "country_code": "CM",
  "operators_code": ["OM"],
  "method": "MERCHANT",
  "tunnel": "CHECKOUTPAGE",
  "operator_otp": "123456"
}

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
transaction_id	string	true	aucune	Un identifiant généré par le marchand.
additional_infos	object	true	aucune	Informations sur le client telles que l'email, le nom et le numéro de téléphone.
amount	number	true	aucune	Montant de la transaction.
callback_url	string	true	aucune	URL où le marchand recevra le résultat final du paiement. L'URL doit être valide et utiliser uniquement la méthode HTTP POST.
return_url	string	true	aucune	URL où le client sera redirigé après le paiement. L'URL doit être valide.
country_code	string	true	aucune	Code pays de la transaction. Le code pays doit être un code ISO 3166-1 alpha-2 ou alpha-3 valide.
operators_code	array	true	aucune	Code de l'opérateur de mobile money pour la transaction. Le code opérateur doit être un tableau contenant des codes valides. Consultez notre documentation pour une liste des codes opérateurs valides.
method	string	true	aucune	Type de transaction à effectuer. Les méthodes possibles sont : CASHIN (PAYOUT), CASHOUT (CASHOUT), MERCHANT (PAYIN).
tunnel	string	true	aucune	Mode de transaction à utiliser. Les tunnels possibles sont : CHECKOUTPAGE (interface de paiement pour finaliser la transaction), API (mode API pour effectuer directement la transaction).
operator_otp	string	false	aucune	Code OTP de l'opérateur si nécessaire pour vérification par le marchand.

Cette section aide les développeurs à remplir correctement chaque champ pour garantir la création fluide des transactions de paiement.

Valeurs Énumérées

La section Valeurs Énumérées spécifie les valeurs acceptables pour les propriétés method et tunnel :

Propriété	Valeur
method	CASHIN
method	MERCHANT
method	CASHOUT
tunnel	API
tunnel	CHECKOUTPAGE

Cela garantit que seules les valeurs prises en charge sont utilisées, maintenant ainsi la cohérence et évitant les transactions invalides.

Cette page vous a-t-elle été utile ?