Criando um pagamento
Os pagamentos através da API são feitos apenas com saldos de carteiras comerciais.
Os pagamentos podem ser feitos de maneiras diferentes:
- Você pode optar por receber o pagamento em uma criptomoeda específica e o pagamento será processado automaticamente nessa criptomoeda específica. Para fazer isso, verifique se você tem um equilíbrio suficiente nessa moeda específica para cobrir todas as taxas associadas.
- Como alternativa, você tem a opção de especificar o valor de pagamento em uma moeda fiduciária. Nesse caso, o valor será convertido automaticamente para uma criptomoeda específica a partir do seu saldo disponível. Por exemplo, se você solicitar um pagamento de 20 USD no LTC, o valor equivalente será deduzido do seu saldo LTC. É importante ter fundos suficientes na criptomoeda correspondente para cobrir todas as taxas aplicáveis.
- Outra possibilidade é especificar o valor de pagamento em uma moeda fiduciária, que será automaticamente convertida em uma criptomoeda específica usando seu saldo do USDT. Essa opção é particularmente útil quando você possui o AutoConvert ativado, pois os fundos de suas faturas são automaticamente convertidos para USDT. Por exemplo, se você deseja fazer um pagamento de 20 dólares no LTC, mas só possui um saldo no USDT, verifique se você possui fundos USDT suficientes para cobrir todas as taxas.
- Além disso, você pode optar por especificar o valor de pagamento em qualquer criptomoeda de sua preferência. O pagamento será processado automaticamente nessa criptomoeda específica, utilizando o saldo do USDT disponível. É crucial ter saldo USDT suficiente para cobrir todas as taxas associadas.
Solicitar
Parâmetros de consulta
Nome | Tipo de parâmetro | Valor padrão | Definição |
---|---|---|---|
amount* | string | Montante de pagamento | |
currency* | string | Código da moeda para o pagamentoSe a moeda, se for fiat, o parâmetro to_currency é necessário . | |
order_id* | stringmin:1max:100alpha_dash | Pedido ID em seu sistemaO parâmetro deve ser uma sequência que consiste em caracteres alfabéticos, números, sublinhados e traços. Não deve conter espaços ou caracteres especiais.O order_id deve ser único dentro dos pagamentos do comercianteQuando encontrarmos um pagamento existente com order_id , retornamos seus detalhes, um novo pagamento não será criado. | |
address* | string | O endereço da carteira para o qual a retirada será feita | |
is_subtract* | boolean | Define onde a taxa de retirada será deduzidaVerdadeiro - do seu equilíbrioFALSO - A partir do valor do pagamento, o valor do pagamento será reduzido | |
network* | string | Código de rede blockchainNão é necessário quando a moeda /to_currency é uma criptomoeda e possui apenas uma rede, por exemplo, BTC | |
url_callback | URL para quais webhooks com status de pagamento serão enviados | ||
to_currency | Código de criptomoeda no qual o pagamento será feito. É usado quando o parâmetro currency é fiduciário. Veja os exemplos abaixo | ||
course_source | stringValores disponíveis• Binance• BinanceP2p• Exmo• Kucoin | Valor das configurações do comerciante | O serviço a partir do qual as taxas de câmbio são tomadas para conversão na fatura.O parâmetro é aplicado apenas se a moeda for fiduciária, caso contrário, o valor padrão será retirado das configurações do comerciante. |
from_currency | string | null | Permite converter automaticamente a quantidade de retirada e usar o saldo de sobrecurrency. Somente USDT está disponível. |
priority | stringmin: 4max: 11Valores disponíveis• recommended• economy• high• highest | recommended | O parâmetro para selecionar a prioridade de retirada. O custo da taxa de retirada depende do parâmetro selecionado.Este parâmetro é aplicado apenas no caso de usar as redes BTC, ETH, Polygon e BSC. |
memo | stringmin: 1max: 30 | Identificador adicional para TON, usado para especificar um destinatário ou alvo específico |
Tipo de parâmetro
stringDefinição
Montante de pagamentoTipo de parâmetro
stringDefinição
Código da moeda para o pagamentoSe a moeda, se for fiat, o parâmetro to_currency é necessário .Tipo de parâmetro
stringmin:1max:100alpha_dashDefinição
Pedido ID em seu sistemaO parâmetro deve ser uma sequência que consiste em caracteres alfabéticos, números, sublinhados e traços. Não deve conter espaços ou caracteres especiais.O order_id deve ser único dentro dos pagamentos do comercianteQuando encontrarmos um pagamento existente com order_id , retornamos seus detalhes, um novo pagamento não será criado.Tipo de parâmetro
stringDefinição
O endereço da carteira para o qual a retirada será feitaTipo de parâmetro
booleanDefinição
Define onde a taxa de retirada será deduzidaVerdadeiro - do seu equilíbrioFALSO - A partir do valor do pagamento, o valor do pagamento será reduzidoTipo de parâmetro
stringDefinição
Código de rede blockchainNão é necessário quando a moeda /to_currency é uma criptomoeda e possui apenas uma rede, por exemplo, BTCDefinição
URL para quais webhooks com status de pagamento serão enviadosDefinição
Código de criptomoeda no qual o pagamento será feito. É usado quando o parâmetro currency é fiduciário. Veja os exemplos abaixoTipo de parâmetro
string
Valores disponíveis- Binance- BinanceP2p- Exmo- KucoinDefinição
O serviço a partir do qual as taxas de câmbio são tomadas para conversão na fatura.O parâmetro é aplicado apenas se a moeda for fiduciária, caso contrário, o valor padrão será retirado das configurações do comerciante.Tipo de parâmetro
stringDefinição
Permite converter automaticamente a quantidade de retirada e usar o saldo de sobrecurrency. Somente USDT está disponível.Tipo de parâmetro
stringmin: 4max: 11
Valores disponíveis- recommended- economy- high- highestDefinição
O parâmetro para selecionar a prioridade de retirada. O custo da taxa de retirada depende do parâmetro selecionado.Este parâmetro é aplicado apenas no caso de usar as redes BTC, ETH, Polygon e BSC.Tipo de parâmetro
stringmin: 1max: 30Definição
Identificador adicional para TON, usado para especificar um destinatário ou alvo específico
* - parâmetro obrigatório
Exemplo de solicitação
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",
}'
CÓPIA DEResposta
Parâmetros de resposta
Nome | Definição |
---|---|
uuid | uuid do pagamento |
amount | Valor de pagamento em currency |
currency | Código da moeda para o pagamento |
network | O código da rede blockchain na qual o pagamento é feito |
address | O endereço da carteira com o qual o pagamento é feito |
txid | ID da transação no blockchain |
status | Status de pagamento Veja todos os status disponíveis |
is_final | Se o pagamento é finalizadoO processo de pagamento é considerado finalizado depois de pagar com sucesso ou se tiver falhado. No caso de uma falha de pagamento, os fundos serão devolvidos ao seu saldo, exigindo que você inicie o processo de pagamento novamente. |
balance | Os restantes fundos no equilíbrio do comerciante. |
payer_currency | Código de criptomoeda no qual o pagamento será realmente feito. O endereço de pagamento receberá a moeda de pagamento. |
payer_amount | Valor em pager_currency do pagamento. |
Definição
uuid do pagamentoDefinição
Valor de pagamento em currencyDefinição
Código da moeda para o pagamentoDefinição
O código da rede blockchain na qual o pagamento é feitoDefinição
O endereço da carteira com o qual o pagamento é feitoDefinição
ID da transação no blockchainDefinição
Status de pagamento Veja todos os status disponíveisDefinição
Se o pagamento é finalizadoO processo de pagamento é considerado finalizado depois de pagar com sucesso ou se tiver falhado. No caso de uma falha de pagamento, os fundos serão devolvidos ao seu saldo, exigindo que você inicie o processo de pagamento novamente.Definição
Os restantes fundos no equilíbrio do comerciante.Definição
Código de criptomoeda no qual o pagamento será realmente feito. O endereço de pagamento receberá a moeda de pagamento.Definição
Valor em pager_currency do pagamento.
Exemplo de resposta
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
CÓPIA DEPossíveis erros
Erros de validação
código : 422
Exemplo de respostas:
1{
2 "state": 1,
3 "errors": {
4 "amount": ["validation.required"]
5 }
6}
CÓPIA DESe o pagamento estiver bloqueado em seu comerciante ou usuário, você receberá esta mensagem de erro. Isso acontece, por exemplo, quando você altera sua senha e os pagamentos estão bloqueados por 24 horas.
1{
2 "state": 1,
3 "message": "You are forbidden"
4}
CÓPIA DESe não suportarmos o código da moeda que você forneceu no parâmetro de moeda, você receberá esta mensagem de erro:
1{
2 "state": 1,
3 "message": "The currency was not found"
4}
CÓPIA DESe não conseguirmos encontrar o serviço para executar o pagamento, você receberá esta mensagem de erro. Você precisa garantir que a criptomoeda seja suportada. Verifique a correção dos valores inseridos em moeda, rede, de_currency, to_currency:
1{
2 "state": 1,
3 "message": "The service was not found"
4}
CÓPIA DESe o valor da retirada for muito pequeno, você receberá esta mensagem de erro:
1{
2 "state": 1,
3 "message": "The withdrawal amount is too small"
4}
CÓPIA DESe você não tiver uma carteira de comerciante ativa com uma criptomoeda do pagamento, receberá este erro:
1{
2 "state": 1,
3 "message": "Wallet not found"
4}
CÓPIA DESe o valor do pagamento, incluindo todas as comissões, for mais do que o seu saldo, você receberá esta mensagem de erro:
1{
2 "state": 1,
3 "message": "Not enough funds"
4}
CÓPIA DESe não encontrarmos o serviço de pagamento da moeda que foi aprovada no parâmetro to_currency, você receberá esta mensagem de erro:
1{
2 "state": 1,
3 "message": "Not found service to_currency"
4}
CÓPIA DESe acidentalmente algo acontecer ao se converter para acurrency, você receberá esta mensagem de erro:
1{
2 "state": 1,
3 "message": "Error convert to_currency"
4}
CÓPIA DESe o valor do pagamento for menor que o valor mínimo suportado para a criptomoeda, você receberá esta mensagem de erro:
1{
2 "state": 1,
3 "message": "Minimum amount 0.5 USDT"
4}
CÓPIA DESe o valor do pagamento for maior que o valor máximo suportado para a criptomoeda, você receberá esta mensagem de erro:
1{
2 "state": 1,
3 "message": "Maximum amount 10000000 USDT"
4}
CÓPIA DESe você não tiver fundos suficientes para fazer um pagamento, receberá esta mensagem de erro:
1{
2 "state": 1,
3 "message": "Not enough funds"
4}
CÓPIA DESe você não tiver fundos suficientes para converter o valor de pagamento de From_Currency, você receberá esta mensagem de erro:
1{
2 "state": 1,
3 "message": "Not enough balance for convert USDT to LTC"
4}
CÓPIA DESe ocorrer um trabalho técnico e o pagamento estiver temporariamente indisponível, você receberá esta mensagem de erro
1{
2 "state": 1,
3 "message": "The terminal was not found"
4}
CÓPIA DEErro do Servidor Interno
código : 500
Exemplo de respostas:
1{
2 "message": "Server error, #1",
3 "code": 500,
4 "error": null
5}
CÓPIA DE