Url
Cette méthode d'intégration du paiement consiste à créer la commande du client depuis votre application(site web, application web ou mobile) en utilisant nos routes API. Enfin, vous redirigez votre client vers l'URL de paiement de GobiPay pour finaliser le paiement.
Dans votre dashboard, vous avez les clés publiques et privées de votre boutique. La clé publique est utilisée pour la création de la commande.
- Create order
Création de la commande
La route API appelée permet de créer une commande liée à une boutique. Elle nécessite la clé publique propre à la boutique, qui doit être renseignée dans le header de la requête API. La clé à utiliser dépend du mode test ou live
//Exemple
[
'X-STORE-PUBLIC-KEY' => 'store-public-key'
]
Route :
/gobipay/orders/
Method : POST
Body :
body de la requête
{
"description": "La description de ma commande",
"total": 0,
"order_type": "global",
"customer_fullname": "John Doe",
"customer_email": "john@doe.com",
"notified_for_partial_payment": true,
"items": {},
"success_redirect_url": "http://successurl.com",
"failed_redirect_url": "http://failedurl.com",
"cancel_redirection_url": "http://cancelurl.com",
"minimum_payment_amount ": 100
}
$request = array(
'method' => 'POST',
'body' => json_encode(
array(
'total' => '',
'description' => '',
'currency' => '',
'customer_email' =>'' ,
'customer_fullname' => '',
'notified_for_partial_payment' => false,
'order_type' => 'global',
'items' => []
),
),
'timeout' => '2500',
'headers' => array(
'Content-Type' => 'application/json',
'X-STORE-PUBLIC-KEY' => '',
'X-STORE-SECRET-KEY' => ''
),
);
Attribut | Type | Description | Default value / Ex | Required |
---|---|---|---|---|
items | Array | Objet contenant les éléments de la commande du client. Vous avez le choix libre de rensigner les données que vous souhaitez dans l'objet items | {} / (Ex: [{ price: '250', quantity: '2',name: 'produit' }] ) | No |
notified_for_partial_payment | Boolean | Indique s'il s'agit d'un paiement partiel ou non pour la commande | false | No |
order_type | String | Mettez 'item' si vous renseignez l'attribut items et 'global' si vous ne le renseignez pas. | global | No |
customer_fullname | String | Nom et prénom du client | Ex : John Doe | No |
customer_email | String | Email du client | Ex: johndoe@gmail.com | No |
total | Number | Montant total de la commande | Yes | |
success_redirect_url | String | Votre URL de redirection en cas d'un paiement effectué avec succès | No | |
failed_redirect_url | String | Votre URL de redirection en cas d'un paiement échoué | No | |
cancel_redirection_url | String | Votre URL de redirection en cas d'un paiement abandonné | No |
Response:
Retour Api
{
"description": null,
"currency": "XOF",
"mode": "test",
"uuid": "764ade76-9d36-484d-9293-e16ce259ad51",
"status": 0,
"total_paid_by_client": 0,
"customer_amount_due": 47800,
"total_paid_to_merchand": null,
"tax_type": "global",
"is_partially_paid": false,
"nb_partial_payments": 0,
"customer_fullname": null,
"customer_email": null,
"store_slug": "st_411576036609",
}
- Redirection sur page de paiement
Vous pouvez rediriger votre client vers notre page de paiement en utilisant l'URL ci-dessous: Url :
https://pay.gobiworld.com/payment/?store=store_slug&order=order_uuid
//Exemple :
https://pay.gobiworld.com/payment/?store=st_411576036609&order=388ab9df-91c0-4642-bebe-54234ba1016a
Paramètre de l'url
Remplacez
store_slug
par le slug de votre boutiqueRemplacez
order_uuid
par le uuid de la commande.
Ces deux attributs se trouvent dans l'objet retourné par l'api lorsque la commande est créée.
Paiement sur l'url de redirection
Une fois sur le lien de paiement le client aura une interface comme celle ci-dessous.
GobiPay proposé deux types de paiement:
- Paiement partiel (
Multiple payment
) :Où le client peut payer la commande en plusieurs tranches et, si possible, avec plusieurs moyens de paiement - Le Paiement total (
Full payment
) : avec cette option, le client paie la totalité de la commande en une seule fois.
Le lien de paiement peut être partagé via les réseaux sociaux pour permettre un paiement multiples et par plusieurs personnes. Un QR code est également disponible pour rediriger vers la page de paiement.
- Le client peut renseigner ou non ses informations en déroulant le menu
informations du cilent
Renseignez les informations pour continuer le processus de paiement.
Suivez les instructions à cette étapes pour effectuer le paiement.
Lorsque le paiement est effectué avec succès, l'interface ci-dessous apparaît.