创建付款

post

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

复制

通过API的支出仅由您的商业钱包余额进行。

支出可以用不同的方式进行：

您可以选择在特定的加密货币中接收支出，然后将在该特定的加密货币中自动处理支出。为此，请确保您在该特定货币上有足够的平衡来支付所有相关费用。
另外，您可以选择以法定货币指定支付金额。在这种情况下，金额将自动从可用余额中自动转换为特定的加密货币。例如，如果您要求在LTC中支付20美元，则等效价值将从您的LTC余额中扣除。重要的是要在相应的加密货币中获得足够的资金来支付所有适用的费用。
另一种可能性是用法定货币指定支付金额，该金额将使用您的USDT余额自动转换为特定的加密货币。当您启用自动转换时，此选项特别有用，因为发票的资金会自动转换为USDT。例如，如果您想在LTC中支付20美元的支出，但仅在USDT中有余额，请确保您有足够的资金来支付所有费用。
此外，您可以选择在您的偏好的任何加密货币中指定支付金额。然后将使用您可用的USDT余额在该特定的加密货币中自动处理支出。拥有足够的USDT余额来支付所有相关费用至关重要。

要求

查询参数

姓名	参数类型	默认值	定义
amount*	string		支付金额
currency*	string		支付的货币代码如果货币，则需要 to_currency参数。
order_id*	stringmin:1max:100alpha_dash		在您的系统中订购ID该参数应是由字母字符，数字，下划线和破折号组成的字符串。它不应包含任何空间或特殊字符。 order_id 必须在商家支出中是唯一的当我们找到使用 order_id 的现有支出时，我们返回其详细信息，将不会创建新的支出。
address*	string		将撤离的钱包的地址
is_subtract*	boolean		定义扣除提款费用的位置是的 - 从你的平衡中错误 - 从支出金额中，支付金额将减少
network*	string		区块链网络代码当货币/to_currency 是加密货币时，不需要一个网络，例如BTC
url_callback			将发送具有支出状态的Webhooks的URL
to_currency			加密货币代码将在其中进行支出。当参数为fiat时，使用它。请参见下面的示例
course_source	string可用值• Binance• BinanceP2p• Exmo• Kucoin	商人设置的价值	从发票中采取汇率进行转换的服务。仅在货币为fiat时才应用参数，否则默认值是从商家的设置中获取的。
from_currency	string	null	允许自动转换提款金额并使用_Currency余额。只有USDT可用。
priority	stringmin: 4max: 11可用值• recommended• economy• high• highest	recommended	用于选择提款优先级的参数。提款费用取决于所选参数。仅在使用BTC，ETH，Polygon和BSC网络的情况下应用此参数。
memo	stringmin: 1max: 30		TON的其他标识符，用于指定特定的收件人或目标

参数类型

string

定义

支付金额

参数类型

string

定义

支付的货币代码如果货币，则需要 to_currency参数。

参数类型

stringmin:1max:100alpha_dash

定义

在您的系统中订购ID该参数应是由字母字符，数字，下划线和破折号组成的字符串。它不应包含任何空间或特殊字符。 order_id 必须在商家支出中是唯一的当我们找到使用 order_id 的现有支出时，我们返回其详细信息，将不会创建新的支出。

参数类型

string

定义

将撤离的钱包的地址

参数类型

boolean

定义

定义扣除提款费用的位置是的 - 从你的平衡中错误 - 从支出金额中，支付金额将减少

参数类型

string

定义

区块链网络代码当货币/to_currency 是加密货币时，不需要一个网络，例如BTC

定义

将发送具有支出状态的Webhooks的URL

定义

加密货币代码将在其中进行支出。当参数为fiat时，使用它。请参见下面的示例

参数类型

string
可用值- Binance- BinanceP2p- Exmo- Kucoin

定义

从发票中采取汇率进行转换的服务。仅在货币为fiat时才应用参数，否则默认值是从商家的设置中获取的。

参数类型

string

定义

允许自动转换提款金额并使用_Currency余额。只有USDT可用。

参数类型

stringmin: 4max: 11
可用值- recommended- economy- high- highest

定义

用于选择提款优先级的参数。提款费用取决于所选参数。仅在使用BTC，ETH，Polygon和BSC网络的情况下应用此参数。

参数类型

stringmin: 1max: 30

定义

TON的其他标识符，用于指定特定的收件人或目标

* - 强制性参数

请求示例


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

复制

响应参数

姓名	定义
uuid	支付的UUID
amount	支付金额currency
currency	支付的货币代码
network	付款的区块链网络的代码
address	付款的钱包的地址
txid	区块链中的事务ID
status	支付状态查看所有可用状态
is_final	支出是否最终确定支付过程一旦成功付款或失败，就可以将其视为最终确定。如果发生支付失败，则资金将退还给您的余额，要求您再次启动支出流程。
balance	其余的资金在商人的余额上。
payer_currency	加密货币代码实际上是在其中支付。支付地址将获得支出货币。
payer_amount	支付的付费数付费中的金额。

: 定义
支付的UUID
: 定义
支付金额currency
: 定义
支付的货币代码
: 定义
付款的区块链网络的代码
: 定义
付款的钱包的地址
: 定义
区块链中的事务ID
: 定义
支付状态查看所有可用状态
: 定义
支出是否最终确定支付过程一旦成功付款或失败，就可以将其视为最终确定。如果发生支付失败，则资金将退还给您的余额，要求您再次启动支出流程。
: 定义
其余的资金在商人的余额上。
: 定义
加密货币代码实际上是在其中支付。支付地址将获得支出货币。
: 定义
支付的付费数付费中的金额。

响应示例


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

复制

可能的错误

验证错误

代码 : 422

示例响应：


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

复制

如果支付在您的商人或用户上被阻止，您将收到此错误消息。例如，当您更改密码和支出被阻止24小时时，会发生这种情况。


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

复制

如果我们不支持您在货币参数中提供的货币代码，则将收到此错误消息：


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

复制

如果我们找不到执行支出的服务，您将收到此错误消息。您必须确保支持加密货币。检查以货币，网络，from_currency，to_currency的方式检查输入值的正确性：


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

复制

如果提款金额太小，您将收到此错误消息：


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

复制

如果您将没有带有加密货币的活跃商店钱包，您将收到此错误：


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

复制

如果支付金额（包括所有佣金）超过您的余额，则将收到此错误消息：


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

复制

如果我们找不到通过to_currency参数传递的货币的支付服务，您将收到此错误消息：


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

复制

如果转换为to_currency时会发生任何事情，您将收到此错误消息：


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

复制

如果支付金额少于加密货币的最低支持金额，您将收到此错误消息：


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

复制

如果支付金额大于加密货币的最大支持金额，则将收到此错误消息：


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

复制

如果您没有足够的资金来支付支出，则将收到此错误消息：


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

复制

如果您没有足够的资金来从_Currency转换支付金额，则将收到此错误消息：


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

复制

如果发生技术工作并且支出暂时不可用，您将收到此错误消息


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

复制

内部服务器错误

代码 : 500

示例响应：


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

复制

创建付款

要求

查询参数

请求示例

回复

响应参数

响应示例

可能的错误

验证错误

内部服务器错误