Validation d’un retrait vers une carte bancaire

POST /api/withdrawal/validation/bank-card

Valide un retrait vers une carte bancaire externe, sans créer de transaction.

Requête

application/json

Body
Exemple

Corps de la requêteobligatoire

Données de validation d’un retrait vers une carte bancaire.

srcWalletIdstringnullable

ID du portefeuille source.

Exemple : W000000000001

amountnumberobligatoire

Montant.

Valeurs possibles : >= 0

Exemple : 10.25

actionstringobligatoire

Action.

Valeurs possibles : [GIVE, GET]

Exemple : GIVE

notestringnullable

Note.

Valeurs possibles : <= 255 caractères

Exemple : Sandbox transfer note

srcCurrencystringnullable

Devise source.

Valeurs possibles : [USD, EUR, GBP, RUB, UAH, KZT, BRL, TRY, AZN, ARS, AUD, BDT, CAD, CLP, COP, DOP, EGP, HKD, INR, IDR, JPY, MYR, MXN, MAD, NPR, NZD, PKR, PEN, PHP, SGD, ZAR, KRW, LKR, THB, AED, VND, CNY, CNH, BTC, BNB, BNB_BEP20, BNB_BEP2, BNB_ERC20, BCH, DAI, DOGE, DOGE_DOGENT, DOGE_BEP2, DOGE_BEP20, ETH, LTC, USDP, XRP, SHIB, SHIB_BEP20, SHIB_ERC20, USDT, USDT_BEP20, USDT_ERC20, USDT_TRC20, USDT_SOL, USDT_AVAXC, USDT_POL, USDT_OP, USDT_ARB, TRX, TUSD, USDC, USDC_ERC20, USDC_BEP20, USDC_BEP2, ZEC, BUSD, BUSD_BEP20, BUSD_ERC20, BUSD_TRC20, TON, SOL, ADA, AVAX, DOT, LINK, NEAR, POL, DASH, USDT_TON, USDC_ARB, USDC_OP, USDC_POL, USDC_AVAXC, USDC_SOL]

Exemple : USD

destCurrencystringobligatoire

Devise de destination.

Exemple : USD

cardNumberstringobligatoire

Numéro de carte.

Exemple : 411111******1111

receiverInfo object

Schéma Merchant Receiver Info.

firstNamestring

Prénom.

Valeurs possibles : <= 30 caractères

Exemple : Leo

lastNamestring

Nom.

Valeurs possibles : <= 30 caractères

Exemple : Peo

emailstring

E-mail.

Valeurs possibles : <= 50 caractères

Exemple : [email protected]

dateOfBirthstring

Date de naissance.

Exemple : 30/01/1991

companyNamestring

Nom de l’entreprise.

Valeurs possibles : >= 3 caractères and <= 100 caractères

Exemple : PotterCompany

{
  "srcWalletId": "W000000000001",
  "amount": 10.25,
  "action": "GIVE",
  "note": "Sandbox transfer note",
  "srcCurrency": "USD",
  "destCurrency": "USD",
  "cardNumber": "411111******1111",
  "receiverInfo": {
    "status": "success"
  }
}

Réponses

Requête incorrecte. La requête est mal formée ou contient des paramètres non valides.

application/json

Schéma
Exemple

Schéma

statusstringobligatoire

Statut de la réponse.

Valeurs possibles : [error]

Exemple : error

data objectobligatoire

Données de la réponse d’erreur.

errors object[]obligatoire

Liste des erreurs renvoyées pour la requête.

Array [

errorMessagestringobligatoire

Code d’erreur stable et lisible par machine.

Exemple : disabled

errorTypestringobligatoire

Catégorie de l’erreur.

Exemple : FORM

errorIdstringobligatoire

Identifiant court et unique de l’erreur pour le support et les journaux.

Exemple : errTest1234

errorDescriptionstringobligatoire

Description lisible de l’erreur.

Exemple : REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API

errorFieldstringnullable

Champ de la requête lié à l’erreur, le cas échéant.

Exemple : null

paramsobject[]obligatoire

Paramètres supplémentaires de l’erreur.

requestParamsobjectobligatoire

Paramètres de la requête enregistrés pour le diagnostic.

]

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "disabled",
        "errorType": "FORM",
        "errorId": "errTest1234",
        "errorDescription": "REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

Non autorisé. Les en-têtes d’authentification du marchand sont absents ou non valides.

application/json

Schéma
Exemple

Schéma

statusstringobligatoire

Statut de la réponse.

Valeurs possibles : [error]

Exemple : error

data objectobligatoire

Données de la réponse d’erreur.

errors object[]obligatoire

Liste des erreurs renvoyées pour la requête.

Array [

errorMessagestringobligatoire

Code d’erreur stable et lisible par machine.

Exemple : userDoesNotExistException

errorTypestringobligatoire

Catégorie de l’erreur.

Exemple : GENERAL

errorIdstringobligatoire

Identifiant court et unique de l’erreur pour le support et les journaux.

Exemple : errTest1234

errorDescriptionstringobligatoire

Description lisible de l’erreur.

Exemple : NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]

errorFieldstringnullable

Champ de la requête lié à l’erreur, le cas échéant.

Exemple : null

paramsobject[]obligatoire

Paramètres supplémentaires de l’erreur.

requestParamsobjectobligatoire

Paramètres de la requête enregistrés pour le diagnostic.

]

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "userDoesNotExistException",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

Introuvable. La ressource demandée n’existe pas.

application/json

Schéma
Exemple

Schéma

statusstringobligatoire

Statut de la réponse.

Valeurs possibles : [error]

Exemple : error

data objectobligatoire

Données de la réponse d’erreur.

errors object[]obligatoire

Liste des erreurs renvoyées pour la requête.

Array [

errorMessagestringobligatoire

Code d’erreur stable et lisible par machine.

Exemple : resourceNotFound

errorTypestringobligatoire

Catégorie de l’erreur.

Exemple : GENERAL

errorIdstringobligatoire

Identifiant court et unique de l’erreur pour le support et les journaux.

Exemple : errTest1234

errorDescriptionstringobligatoire

Description lisible de l’erreur.

Exemple : Resource not found

errorFieldstringnullable

Champ de la requête lié à l’erreur, le cas échéant.

Exemple : null

paramsobject[]obligatoire

Paramètres supplémentaires de l’erreur.

requestParamsobjectobligatoire

Paramètres de la requête enregistrés pour le diagnostic.

]

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "resourceNotFound",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "Resource not found",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

Erreur interne du serveur. Erreur inattendue, contactez le support

application/json

Schéma
Exemple

Schéma

statusstringobligatoire

Statut de la réponse.

Valeurs possibles : [error]

Exemple : error

data objectobligatoire

Données de la réponse d’erreur.

errors object[]obligatoire

Liste des erreurs renvoyées pour la requête.

Array [

errorMessagestringobligatoire

Code d’erreur stable et lisible par machine.

Exemple : internalServerError

errorTypestringobligatoire

Catégorie de l’erreur.

Exemple : GENERAL

errorIdstringobligatoire

Identifiant court et unique de l’erreur pour le support et les journaux.

Exemple : errTest1234

errorDescriptionstringobligatoire

Description lisible de l’erreur.

Exemple : Internal server error

errorFieldstringnullable

Champ de la requête lié à l’erreur, le cas échéant.

Exemple : null

paramsobject[]obligatoire

Paramètres supplémentaires de l’erreur.

requestParamsobjectobligatoire

Paramètres de la requête enregistrés pour le diagnostic.

]

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "internalServerError",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "Internal server error",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

Validation d’un retrait vers une carte bancaire

/api/withdrawal/validation/bank-card

Requête​

Corps de la requêteobligatoire

Réponses​

Requête

Réponses