Withdraw

Il s'agit du processus de retrait de solde de votre compte de boutique. Avant toute opération, il est important de savoir que vous ne pouvez pas retirer plus que ce que vous avez sur votre compte. Le processus de retrait se déroule selon les étapes suivantes :

• 1. Get Platform

Withdraw Platform

Cette route retourne la liste de toutes les plateformes qui sont supportées par GobiPay pour un PayOut (retrait)

Method : GET

Route :

   /gobipay/addons/plateform_money/get-list/

Response api Get Platform

• 2. Get Argument

Get Platform Arguments

À chaque plateforme sont associés des arguments (champs requis). Lorsque vous choisissez une plateforme, vous faites appel à ses arguments via la route ci-dessous pour obtenir les champs à renseigner.

identifier : est retourné au niveau de chaque platforme sur la route de Get Platform.

Method : GET

Route :

/plateforms-money/${identifier}/arguments/

Response api Get Argument

• 3. Init withdraw

Init withdraw

Il s'agit de la première étape du retrait de solde disponible de votre compte vers une plateforme que vous selectionnez.

Renseignez les clés de la boutique dans le header de la requête lorsque vous appelez ce route: La clé à renseigner dependend du mode test ou live.

//Exemple
[
'X-STORE-PUBLIC-KEY'  => 'store-public-key'
'X-STORE-SECRET-KEY' => 'store-secret-key'
'X-STORE-USE-MODE' => 'test'
]

Method : POST

Route :

  /api/gobipay/withdraw/init/

Body :

Body de la requête

{
 "to_plateform_money": "string",
 "amount": 0,
 "is_direct_convert": true,
 "args": [
  {
   "name": "string",
   "value": "string",
   "type": "string"
  }
 ],
 "extra_infos": {
  "store_slug": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "merchant_type": "string",
  "email": "user@example.com"
 }
}

Curl

Python

Php

JavaScript

Attribut	Type	Description	Default value	Required
is_direct_convert	Boolean	Mettez true	true	Oui
store_slug	String	Slug de la boutique		Yes
merchant_type	String	Mettez withdraw		Yes
args	Array of Object	Tableau d'objet contenant les arguments de la plateforme		Yes
to_plateform_money	String	La plateforme vers laquelle vous faites le retrait		Yes
amount	Number	Le montant que vous voulez retirer		Yes

• 4. Finalize withdraw

Finalize withdraw

Cette route api permet de finaliser la transaction. Elle a besoin des clés privées de la boutique dans le header de la requête. Elle prend en paramètre l'attribut *identifier* de la transaction. Cet attribut est retourné par l’api qui initialise la transaction.

Renseignez les clés de la boutique dans le header de la requête lorsque vous appelez ce route: La clé à renseigner dependend du mode test ou live.

//Exemple
[
'X-STORE-PUBLIC-KEY'  => 'store-public-key'
'X-STORE-SECRET-KEY' => 'store-secret-key'
'X-STORE-USE-MODE' => 'test'
]

Method : POST

Route :

/gobipay/withdraw/{identifier}/cash-out/

Body :

Body de la requête

{}

Curl

Python

Php

JavaScript

Response api Finalize withdraw