Récupération d’une commande de paiement

GET /api/orders

Renvoie les informations d’une commande de paiement SCI à partir de l’ID de commande du marchand et, éventuellement, du nom SCI.

Requête

Paramètres Query

orderId stringobligatoire

Valeurs possibles : <= 64 caractères

Identifiant de la commande du marchand.

Exemple : test-order-001

sciName string

Nom de l’intégration SCI, facultatif.

Exemple : sandbox-sci

Réponses

application/json

Schéma
Exemple

Schéma

orderIdstring

ID de la commande.

Exemple : ORDER_123456

sciNamestring

Nom SCI.

Exemple : test-value

paymentStatusstring

Statut du paiement.

Valeurs possibles : [PENDING, COMPLETED, CANCELED, REFUNDED]

Exemple : COMPLETED

paymentMethodstring

Moyen de paiement.

Valeurs possibles : [INTERNAL_OTHERS, CRYPTO_INVOICE]

Exemple : CRYPTO_INVOICE

paymentCreateddate-time

Date de création du paiement.

transaction object

Schéma Payment Order Transaction Dto.

iduuid

ID.

Exemple : 11111111-1111-4111-8111-111111111111

statusstring

Statut.

Valeurs possibles : [PENDING, COMPLETED, CANCELED, REFUNDED]

Exemple : COMPLETED

senderAmountnumber

Montant de l’expéditeur.

Exemple : 10.25

senderCurrencystring

Devise de l’expéditeur.

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

receiverAmountnumber

Montant du destinataire.

Exemple : 10.25

receiverCurrencystring

Devise du destinataire.

Exemple : USD

createddate-time

Date de création.

completeddate-time

Date de finalisation.

canceleddate-time

Date d’annulation.

notestring

Note.

Exemple : Sandbox transfer note

srcWalletIdstring

ID du portefeuille source.

Exemple : USD880390848110

buyerEmailstring

E-mail de l’acheteur.

Exemple : [email protected]

invoice object

Schéma Payment Order Invoice Dto.

createddate-time

Date de création.

receiveddate-time

Date de réception.

completeddate-time

Date de finalisation.

refundRequesteddate-time

Date de la demande de remboursement.

refundeddate-time

Date de remboursement.

externalStatusstring

Statut externe.

Valeurs possibles : [NEW, EXPIRED, PAYMENT_RECEIVED, UNDERPAYMENT_RECEIVED, OVERPAYMENT_RECEIVED, EXPIRED_PAYMENT_RECEIVED, EXPIRED_UNDERPAYMENT_RECEIVED, EXPIRED_OVERPAYMENT_RECEIVED, EXPIRED_PAYMENT_REFUND_REQUESTED, UNDERPAYMENT_REFUND_REQUESTED, EXPIRED_UNDERPAYMENT_REFUND_REQUESTED, OVERPAYMENT_REFUND_REQUESTED, FULL_OVERPAYMENT_REFUND_REQUESTED, EXPIRED_PAYMENT_REFUNDED, UNDERPAYMENT_REFUNDED, OVERPAYMENT_REFUNDED, FULL_OVERPAYMENT_REFUNDED, EXPIRED_PAYMENT_REFUND_CONFIRMATION_REQUIRED, UNDERPAYMENT_REFUND_CONFIRMATION_REQUIRED, EXPIRED_UNDERPAYMENT_REFUND_CONFIRMATION_REQUIRED, OVERPAYMENT_REFUND_CONFIRMATION_REQUIRED, FULL_OVERPAYMENT_REFUND_CONFIRMATION_REQUIRED, CLOSED]

Exemple : NEW

invoiceStatusstring

Statut de la facture.

Valeurs possibles : [NEW, RECEIVED, EXCHANGING, COMPLETED, REFUND_CONFIRMATION, REFUND_REQUESTED, REFUNDED, CLOSED]

Exemple : NEW

penaltiesstring[]

Pénalités.

Valeurs possibles : [EXPIRED, UNDERPAYMENT, OVERPAYMENT]

Exemple : ["EXPIRED"]

refundTypestring

Type de remboursement.

Valeurs possibles : [FULL_REFUND, PARTIAL_REFUND]

Exemple : FULL_REFUND

cryptoCurrencyAddressstring

Adresse crypto.

Exemple : USD

initialSenderAmountnumber

Montant initial de l’expéditeur.

Exemple : 10.25

actualReceivedAmountnumber

Montant effectivement reçu.

Exemple : 10.25

senderCurrencystring

Devise de l’expéditeur.

Exemple : USD

cryptoCurrencyTransactionIdstring

ID de la transaction crypto.

Exemple : 11111111-1111-4111-8111-111111111111

refundAddressstring

Adresse de remboursement.

Exemple : test-value

{
  "orderId": "ORDER_123456",
  "sciName": "test-value",
  "paymentStatus": "CREATED",
  "paymentMethod": "CRYPTO_INVOICE",
  "paymentCreated": "2026-01-15T10:30:00",
  "transaction": {
    "status": "success"
  },
  "invoice": {
    "status": "success"
  }
}

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": {}
      }
    ]
  }
}

Récupération d’une commande de paiement

/api/orders

Requête​

Paramètres Query

Réponses​

Requête

Réponses