Creando un pago

post

https://api.cryptomus.com/v1/payout

COPIAR

Los pagos a través de API solo se realizan desde los saldos de las billeteras de su negocio.

Los pagos se pueden hacer de diferentes maneras:

Puede elegir recibir el pago en una criptomoneda específica y el pago se procesará automáticamente en esa criptomoneda específica. Para hacerlo, asegúrese de tener suficiente equilibrio en esa moneda particular para cubrir todas las tarifas asociadas.
Alternativamente, tiene la opción de especificar el monto de pago en una moneda fiduciaria. En este caso, la cantidad se convertirá automáticamente a una criptomoneda específica desde su saldo disponible. Por ejemplo, si solicita un pago de 20 USD en LTC, el valor equivalente se deducirá de su saldo LTC. Es importante tener suficientes fondos en la criptomoneda correspondiente para cubrir todas las tarifas aplicables.
Otra posibilidad es especificar el monto de pago en una moneda fiduciaria, que se convertirá automáticamente en una criptomoneda específica utilizando su saldo de USDT. Esta opción es particularmente útil cuando tiene Autoconvert habilitado, ya que los fondos de sus facturas se convierten automáticamente en USDT. Por ejemplo, si desea realizar un pago de 20 USD en LTC pero solo tiene un saldo en USDT, asegúrese de tener suficientes fondos de USDT para cubrir todas las tarifas.
Además, puede optar por especificar el monto de pago en cualquier criptomoneda de su preferencia. El pago se procesará automáticamente en esa criptomoneda específica, utilizando su saldo de USDT disponible. Es crucial tener suficiente equilibrio de USDT para cubrir todas las tarifas asociadas.

Pedido

Parámetros de consulta

Nombre	Tipo de parámetro	Valor por defecto	Definición
amount*	string		Cantidad a pagar
currency*	string		Código de moneda para el pagoIf moneda si fiat, se requiere el parámetro to_currency .
order_id*	stringmin:1max:100alpha_dash		ID de pedido en su sistemaEl parámetro debe ser una cadena que consiste en caracteres alfabéticos, números, subrayadores y guiones. No debe contener espacios o caracteres especiales.El orden_id debe ser único dentro de los pagos comercialesCuando encontramos un pago existente con order_id , devolvemos sus detalles, no se creará un nuevo pago.
address*	string		La dirección de la billetera a la que se realizará el retiro
is_subtract*	boolean		Define dónde se deducirá la tarifa de retiroVerdadero - De tu equilibrioFalso: por el monto del pago, el monto del pago disminuirá
network*	string		Código de red blockchainNo es necesario cuando la moneda/to_currency es una criptomoneda y solo tiene una red, por ejemplo BTC
url_callback			URL a la que se enviarán los webhooks con el estado de pago
to_currency			Código de criptomonedas en el que se realizará el pago. Se usa cuando el parámetro currency es fiat. Ver ejemplos a continuación
course_source	stringValores disponibles• Binance• BinanceP2p• Exmo• Kucoin	Valor de la configuración del comerciante	El servicio del que se toman los tipos de cambio para la conversión en la factura.El parámetro se aplica solo si la moneda es fiat, de lo contrario el valor predeterminado se toma de la configuración del comerciante.
from_currency	string	null	Permite convertir automáticamente el monto del retiro y usar el saldo de civilency from_currency. Solo USDT está disponible.
priority	stringmin: 4max: 11Valores disponibles• recommended• economy• high• highest	recommended	El parámetro para seleccionar la prioridad de retiro. El costo de la tarifa de retiro depende del parámetro seleccionado.Este parámetro se aplica solo en el caso de usar las redes BTC, ETH, Polygon y BSC.
memo	stringmin: 1max: 30		Identificador adicional para TON, utilizado para especificar un destinatario o objetivo particular

Tipo de parámetro

string

Definición

Cantidad a pagar

Tipo de parámetro

string

Definición

Código de moneda para el pagoIf moneda si fiat, se requiere el parámetro to_currency .

Tipo de parámetro

stringmin:1max:100alpha_dash

Definición

ID de pedido en su sistemaEl parámetro debe ser una cadena que consiste en caracteres alfabéticos, números, subrayadores y guiones. No debe contener espacios o caracteres especiales.El orden_id debe ser único dentro de los pagos comercialesCuando encontramos un pago existente con order_id , devolvemos sus detalles, no se creará un nuevo pago.

Tipo de parámetro

string

Definición

La dirección de la billetera a la que se realizará el retiro

Tipo de parámetro

boolean

Definición

Define dónde se deducirá la tarifa de retiroVerdadero - De tu equilibrioFalso: por el monto del pago, el monto del pago disminuirá

Tipo de parámetro

string

Definición

Código de red blockchainNo es necesario cuando la moneda/to_currency es una criptomoneda y solo tiene una red, por ejemplo BTC

Definición

URL a la que se enviarán los webhooks con el estado de pago

Definición

Código de criptomonedas en el que se realizará el pago. Se usa cuando el parámetro currency es fiat. Ver ejemplos a continuación

Tipo de parámetro

string
Valores disponibles- Binance- BinanceP2p- Exmo- Kucoin

Definición

El servicio del que se toman los tipos de cambio para la conversión en la factura.El parámetro se aplica solo si la moneda es fiat, de lo contrario el valor predeterminado se toma de la configuración del comerciante.

Tipo de parámetro

string

Definición

Permite convertir automáticamente el monto del retiro y usar el saldo de civilency from_currency. Solo USDT está disponible.

Tipo de parámetro

stringmin: 4max: 11
Valores disponibles- recommended- economy- high- highest

Definición

El parámetro para seleccionar la prioridad de retiro. El costo de la tarifa de retiro depende del parámetro seleccionado.Este parámetro se aplica solo en el caso de usar las redes BTC, ETH, Polygon y BSC.

Tipo de parámetro

stringmin: 1max: 30

Definición

Identificador adicional para TON, utilizado para especificar un destinatario o objetivo particular

* - parámetro obligatorio

Ejemplo de solicitud


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",
}'

COPIAR

Respuesta

Parámetros de respuesta

Nombre	Definición
uuid	uuid del pago
amount	Monto de pago en currency
currency	Código de moneda para el pago
network	El código de la red blockchain en la que se realiza el pago
address	La dirección de la billetera a la que se realiza el pago
txid	ID de transacción en la cadena de bloques
status	Estado de pago Ver todos los estados disponibles
is_final	Si el pago está finalizadoEl proceso de pago se considera finalizado una vez que se ha pagado con éxito o si ha fallado. En el caso de una falla de pago, los fondos serán devueltos a su saldo, lo que requiere que inicie el proceso de pago nuevamente.
balance	Los fondos restantes en el saldo del comerciante.
payer_currency	Código de criptomonedas en el que se realizará realmente el pago. La dirección de pago recibirá la moneda de pago.
payer_amount	Cantidad en payer_currency del pago.

: Definición
uuid del pago
: Definición
Monto de pago en currency
: Definición
Código de moneda para el pago
: Definición
El código de la red blockchain en la que se realiza el pago
: Definición
La dirección de la billetera a la que se realiza el pago
: Definición
ID de transacción en la cadena de bloques
: Definición
Estado de pago Ver todos los estados disponibles
: Definición
Si el pago está finalizadoEl proceso de pago se considera finalizado una vez que se ha pagado con éxito o si ha fallado. En el caso de una falla de pago, los fondos serán devueltos a su saldo, lo que requiere que inicie el proceso de pago nuevamente.
: Definición
Los fondos restantes en el saldo del comerciante.
: Definición
Código de criptomonedas en el que se realizará realmente el pago. La dirección de pago recibirá la moneda de pago.
: Definición
Cantidad en payer_currency del pago.

Ejemplo de respuesta


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

COPIAR

Posibles errores

Errores de validación

código : 422

Respuestas de ejemplo:


1{
2	"state": 1,
3	"errors": {
4		"amount": ["validation.required"]
5	}
6}

COPIAR

Si el pago está bloqueado en su comerciante o usuario, recibirá este mensaje de error. Esto sucede, por ejemplo, cuando cambia su contraseña y los pagos están bloqueados durante 24 horas.


1{
2    "state": 1,
3    "message": "You are forbidden"
4}

COPIAR

Si no admitimos el código de divisas que proporcionó en el parámetro de división, recibirá este mensaje de error:


1{
2    "state": 1,
3    "message": "The currency was not found"
4}

COPIAR

Si no podemos encontrar el servicio para ejecutar el pago, recibirá este mensaje de error. Debe asegurarse de que la criptomoneda sea compatible. Verifique la corrección de los valores ingresados en. Moneda, Red, From_Currency, To_Currency:


1{
2    "state": 1,
3    "message": "The service was not found"
4}

COPIAR

Si el monto del retiro es demasiado pequeño, recibirá este mensaje de error:


1{
2    "state": 1,
3    "message": "The withdrawal amount is too small"
4}

COPIAR

Si no tendrá una billetera comercial activa con una criptomoneda del pago, recibirá este error:


1{
2    "state": 1,
3    "message": "Wallet not found"
4}

COPIAR

Si el monto de pago, incluidas todas las comisiones, es más que su saldo, recibirá este mensaje de error:


1{
2    "state": 1,
3    "message": "Not enough funds"
4}

COPIAR

Si no encontramos el servicio de pago de la moneda que se aprobó en el parámetro To_Currency, recibirá este mensaje de error:


1{
2    "state": 1,
3    "message": "Not found service to_currency"
4}

COPIAR

Si accidentalmente sucede algo al convertir a To_Currency, recibirá este mensaje de error:


1{
2    "state": 1,
3    "message": "Error convert to_currency"
4}

COPIAR

Si el monto del pago es menor que el monto mínimo compatible con la criptomoneda, recibirá este mensaje de error:


1{
2    "state": 1,
3    "message": "Minimum amount 0.5 USDT"
4}

COPIAR

Si el monto de pago es mayor que el monto máximo compatible para la criptomoneda, recibirá este mensaje de error:


1{
2    "state": 1,
3    "message": "Maximum amount 10000000 USDT"
4}

COPIAR

Si no tiene suficientes fondos para hacer un pago, recibirá este mensaje de error:


1{
2    "state": 1,
3    "message": "Not enough funds"
4}

COPIAR

Si no tiene fondos suficientes para convertir el monto del pago de desde__currency, recibirá este mensaje de error:


1{
2    "state": 1,
3    "message": "Not enough balance for convert USDT to LTC"
4}

COPIAR

Si se produce un trabajo técnico y el pago no está disponible temporalmente, recibirá este mensaje de error


1{
2    "state": 1,
3    "message": "The terminal was not found"
4}

COPIAR

Error Interno del Servidor

código : 500

Respuestas de ejemplo:


1{
2	"message": "Server error, #1",
3	"code": 500,
4	"error": null
5}

COPIAR