Créer un paiement
Les paiements via l'API ne sont faits que de vos équilibres de portefeuilles d'entreprise.
Les paiements peuvent être effectués de différentes manières:
- Vous pouvez choisir de recevoir le paiement dans une crypto-monnaie spécifique et le paiement sera ensuite traité automatiquement dans cette crypto-monnaie spécifique. Pour ce faire, assurez-vous que vous avez suffisamment d'équilibre dans cette monnaie particulière pour couvrir tous les frais associés.
- Alternativement, vous avez la possibilité de spécifier le montant du paiement dans une monnaie fiduciaire. Dans ce cas, le montant sera automatiquement converti en une crypto-monnaie spécifique à partir de votre solde disponible. Par exemple, si vous demandez un paiement de 20 USD en LTC, la valeur équivalente sera déduite de votre solde LTC. Il est important d'avoir suffisamment de fonds dans la crypto-monnaie correspondante pour couvrir tous les frais applicables.
- Une autre possibilité consiste à spécifier le montant du paiement dans une monnaie fiduciaire, qui sera automatiquement convertie en une crypto-monnaie spécifique en utilisant votre solde USDT. Cette option est particulièrement utile lorsque vous avez activé AutoConvert, car les fonds de vos factures sont automatiquement convertis en USDT. Par exemple, si vous souhaitez effectuer un paiement de 20 USD dans le SLD mais que vous avez un solde en USDT, assurez-vous que vous disposez de fonds USDT suffisants pour couvrir tous les frais.
- De plus, vous pouvez choisir de spécifier le montant du paiement dans toute crypto-monnaie de votre préférence. Le paiement sera ensuite traité automatiquement dans cette crypto-monnaie spécifique, en utilisant votre solde USDT disponible. Il est crucial d'avoir suffisamment d'équilibre USDT pour couvrir tous les frais associés.
Demande
Paramètres de requête
Nom | Type de paramètre | Valeur par défaut | Définition |
---|---|---|---|
amount* | string | Montant du paiement | |
currency* | string | Code de devise pour le paiementSi la monnaie est fiat, le paramètre to_currency est requis . | |
order_id* | stringmin:1max:100alpha_dash | Commandez ID dans votre systèmeLe paramètre doit être une chaîne composée de caractères alphabétiques, de nombres, de soulignements et de tirets. Il ne doit contenir aucun espace ou caractères spéciaux.Le Order_id doit être unique dans les paiements du commerçantLorsque nous trouvons un paiement existant avec order_id, nous retournons ses détails, un nouveau paiement ne sera pas créé. | |
address* | string | L'adresse du portefeuille auquel le retrait sera effectué | |
is_subtract* | boolean | Définit où les frais de retrait seront déduitsvrai - de votre équilibreFaux - du montant du paiement, le montant du paiement sera diminué | |
network* | string | Code réseau blockchainNon requis lorsque la devise / to_currency est une crypto-monnaie et n'a qu'un seul réseau, par exemple BTC | |
url_callback | URL à laquelle les webhooks avec statut de paiement seront envoyés | ||
to_currency | Code de crypto-monnaie dans lequel le paiement sera effectué. Il est utilisé lorsque le paramètre currency est Fiat. Voir des exemples ci-dessous | ||
course_source | stringValeurs disponibles• Binance• BinanceP2p• Exmo• Kucoin | Valeur des paramètres du marchand | Le service à partir duquel les taux de change sont pris pour la conversion dans la facture.Le paramètre n'est appliqué que si la devise est FIAT, sinon la valeur par défaut est tirée des paramètres du marchand. |
from_currency | string | null | Permet de convertir automatiquement le montant de retrait et d'utiliser le solde From_Currency. Seul USDT est disponible. |
priority | stringmin: 4max: 11Valeurs disponibles• recommended• economy• high• highest | recommended | Le paramètre de sélection de la priorité de retrait. Le coût des frais de retrait dépend du paramètre sélectionné.Ce paramètre est appliqué uniquement en cas d'utilisation des réseaux BTC, ETH, Polygon et BSC. |
memo | stringmin: 1max: 30 | Identifiant supplémentaire pour TON, utilisé pour spécifier un destinataire ou une cible particulière |
Type de paramètre
stringDéfinition
Montant du paiementType de paramètre
stringDéfinition
Code de devise pour le paiementSi la monnaie est fiat, le paramètre to_currency est requis .Type de paramètre
stringmin:1max:100alpha_dashDéfinition
Commandez ID dans votre systèmeLe paramètre doit être une chaîne composée de caractères alphabétiques, de nombres, de soulignements et de tirets. Il ne doit contenir aucun espace ou caractères spéciaux.Le Order_id doit être unique dans les paiements du commerçantLorsque nous trouvons un paiement existant avec order_id, nous retournons ses détails, un nouveau paiement ne sera pas créé.Type de paramètre
stringDéfinition
L'adresse du portefeuille auquel le retrait sera effectuéType de paramètre
booleanDéfinition
Définit où les frais de retrait seront déduitsvrai - de votre équilibreFaux - du montant du paiement, le montant du paiement sera diminuéType de paramètre
stringDéfinition
Code réseau blockchainNon requis lorsque la devise / to_currency est une crypto-monnaie et n'a qu'un seul réseau, par exemple BTCDéfinition
URL à laquelle les webhooks avec statut de paiement seront envoyésDéfinition
Code de crypto-monnaie dans lequel le paiement sera effectué. Il est utilisé lorsque le paramètre currency est Fiat. Voir des exemples ci-dessousType de paramètre
string
Valeurs disponibles- Binance- BinanceP2p- Exmo- KucoinDéfinition
Le service à partir duquel les taux de change sont pris pour la conversion dans la facture.Le paramètre n'est appliqué que si la devise est FIAT, sinon la valeur par défaut est tirée des paramètres du marchand.Type de paramètre
stringDéfinition
Permet de convertir automatiquement le montant de retrait et d'utiliser le solde From_Currency. Seul USDT est disponible.Type de paramètre
stringmin: 4max: 11
Valeurs disponibles- recommended- economy- high- highestDéfinition
Le paramètre de sélection de la priorité de retrait. Le coût des frais de retrait dépend du paramètre sélectionné.Ce paramètre est appliqué uniquement en cas d'utilisation des réseaux BTC, ETH, Polygon et BSC.Type de paramètre
stringmin: 1max: 30Définition
Identifiant supplémentaire pour TON, utilisé pour spécifier un destinataire ou une cible particulière
* - paramètre obligatoire
Demander un exemple
curl https://api.cryptomus.com/v1/payout \
-X POST \
-H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
-H 'sign: fe99035f86fa436181717b302b95bacff1' \
-H 'Content-Type: application/json' \
-d '{
"amount": "5",
"currency": "USDT",
"network": "TRON",
"order_id": "1",
"address": "TDD97yguPESTpcrJMqU6h2ozZbibv4Vaqm",
"url_callback": "https://your.site/callback",
"is_subtract": "1",
}'
COPIERéponse
Paramètres de réponse
Nom | Définition |
---|---|
uuid | uuid du paiement |
amount | Montant de paiement dans currency |
currency | Code de devise pour le paiement |
network | Le code du réseau de blockchain dans lequel le paiement est effectué |
address | L'adresse du portefeuille auquel le paiement est effectué |
txid | ID de transaction dans la blockchain |
status | Statut de paiement Voir tous les statuts disponibles |
is_final | Si le paiement est finaliséLe processus de paiement est considéré comme finalisé une fois qu'il a été payé avec succès ou s'il a échoué. En cas de défaillance de paiement, les fonds seront retournés à votre solde, vous obligeant à initier à nouveau le processus de paiement. |
balance | Les fonds restants sur l'équilibre du marchand. |
payer_currency | Code de crypto-monnaie dans lequel le paiement sera réellement effectué. L'adresse de paiement recevra la monnaie de paiement. |
payer_amount | Montant dans Payer_Currency du paiement. |
Définition
uuid du paiementDéfinition
Montant de paiement dans currencyDéfinition
Code de devise pour le paiementDéfinition
Le code du réseau de blockchain dans lequel le paiement est effectuéDéfinition
L'adresse du portefeuille auquel le paiement est effectuéDéfinition
ID de transaction dans la blockchainDéfinition
Statut de paiement Voir tous les statuts disponiblesDéfinition
Si le paiement est finaliséLe processus de paiement est considéré comme finalisé une fois qu'il a été payé avec succès ou s'il a échoué. En cas de défaillance de paiement, les fonds seront retournés à votre solde, vous obligeant à initier à nouveau le processus de paiement.Définition
Les fonds restants sur l'équilibre du marchand.Définition
Code de crypto-monnaie dans lequel le paiement sera réellement effectué. L'adresse de paiement recevra la monnaie de paiement.Définition
Montant dans Payer_Currency du paiement.
Exemple de réponse
1{
2 "state": 0,
3 "result": {
4 "uuid": "a7c0caec-a594-4aaa-b1c4-77d511857594",
5 "amount": "3",
6 "currency": "USDT",
7 "network": "TRON",
8 "address": "TJ...",
9 "txid": null,
10 "status": "process",
11 "is_final": false,
12 "balance": 129,
13 "payer_currency": "USD",
14 "payer_amount": 3
15 }
16}
17
COPIEErreurs possibles
Erreurs de validation
code : 422
Exemples de réponses:
1{
2 "state": 1,
3 "errors": {
4 "amount": ["validation.required"]
5 }
6}
COPIESi le paiement est bloqué sur votre marchand ou votre utilisateur, vous recevrez ce message d'erreur. Cela se produit, par exemple, lorsque vous modifiez votre mot de passe et que les paiements sont bloqués pendant 24 heures.
1{
2 "state": 1,
3 "message": "You are forbidden"
4}
COPIESi nous ne prenons pas en charge le code de devise que vous avez fourni dans le paramètre de devise, vous recevrez ce message d'erreur:
1{
2 "state": 1,
3 "message": "The currency was not found"
4}
COPIESi nous ne pouvons pas trouver le service d'exécution de paiement, vous recevrez ce message d'erreur. Vous devez vous assurer que la crypto-monnaie est prise en charge. Vérifiez l'exactitude des valeurs entrées en. Currency, réseau, from_currency, à_currency:
1{
2 "state": 1,
3 "message": "The service was not found"
4}
COPIESi le montant du retrait est trop petit, vous recevrez ce message d'erreur:
1{
2 "state": 1,
3 "message": "The withdrawal amount is too small"
4}
COPIESi vous n'aurez pas de portefeuille marchand actif avec une crypto-monnaie du paiement, vous recevrez cette erreur:
1{
2 "state": 1,
3 "message": "Wallet not found"
4}
COPIESi le montant du paiement, y compris toutes les commissions, est plus que votre solde, vous recevrez ce message d'erreur:
1{
2 "state": 1,
3 "message": "Not enough funds"
4}
COPIESi nous ne trouvons pas le service de paiement de la devise qui a été transmis dans le paramètre de la construction, vous recevrez ce message d'erreur:
1{
2 "state": 1,
3 "message": "Not found service to_currency"
4}
COPIESi accidentellement quelque chose se produit lors de la conversion à_currency, vous recevrez ce message d'erreur:
1{
2 "state": 1,
3 "message": "Error convert to_currency"
4}
COPIESi le montant du paiement est inférieur au montant pris en charge minimum pour la crypto-monnaie, vous recevrez ce message d'erreur:
1{
2 "state": 1,
3 "message": "Minimum amount 0.5 USDT"
4}
COPIESi le montant du paiement est supérieur au montant maximal pris en charge pour la crypto-monnaie, vous recevrez ce message d'erreur:
1{
2 "state": 1,
3 "message": "Maximum amount 10000000 USDT"
4}
COPIESi vous n'avez pas assez de fonds pour effectuer un paiement, vous recevrez ce message d'erreur:
1{
2 "state": 1,
3 "message": "Not enough funds"
4}
COPIESi vous n'avez pas assez de fonds pour convertir le montant du paiement de From_Currency, vous recevrez ce message d'erreur:
1{
2 "state": 1,
3 "message": "Not enough balance for convert USDT to LTC"
4}
COPIESi le travail technique se produit et que le paiement est temporairement indisponible, vous recevrez ce message d'erreur
1{
2 "state": 1,
3 "message": "The terminal was not found"
4}
COPIEErreur interne du serveur
code : 500
Exemples de réponses:
1{
2 "message": "Server error, #1",
3 "code": 500,
4 "error": null
5}
COPIE