退款

post
https://api.cryptomus.com/v1/payment/refund
复制

要求

查询参数

姓名参数类型定义
address*string应向退款的地址
is_subtract*boolean是从商人的余额还是从退款金额中获取佣金 true - 从商人余额中夺取佣金 false - 减少可退款金额
uuid*uuidrequired_without: order_id发票UUID
order_id*stringmin:1max:128alpha_dashrequired_without: uuid发票订单ID

参数类型

string

定义

应向退款的地址

参数类型

boolean

定义

是从商人的余额还是从退款金额中获取佣金 true - 从商人余额中夺取佣金 false - 减少可退款金额

参数类型

uuidrequired_without: order_id

定义

发票UUID

参数类型

stringmin:1max:128alpha_dashrequired_without: uuid

定义

发票订单ID

* - 强制性参数

发票由 order_id 或者 uuid，如果两者都通过，则帐户将由UUID确定

请求示例


curl https://api.cryptomus.com/v1/payment/refund \
    -X POST \
    -H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
    -H 'sign: fe99035f86fa436181717b302b95bacff1' \
    -H 'Content-Type: application/json' \
    -d '{
            "uuid": "8b03432e-385b-4670-8d06-064591096795",
            "address": "TDD97yguPESTpcrJMqU6h2ozZbibv4Vaqm", 
            "is_subtract": "true"
        }'
复制

回复

响应示例


1{
2  "state": 0,
3  "result": []
4}
复制

可能的错误

验证错误

代码 : 422

示例响应：

如果您提供的带有uuid或order_id的发票不存在：


1{
2    "state": 1,
3    "message": "Payment was not found"
4}
复制

如果您不会传递 uuid 和 order_id ，您将收到此消息。这意味着至少需要一个参数。


1{
2	"state": 1,
3	"errors": {
4		"uuid": ["validation.required_without"],
5		"order_id": ["validation.required_without"]
6	}
7}
复制

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


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

如果不存在连接到发票的商店钱包：


1{
2    "state": 1,
3    "message": "Undefined merchant wallet"
4}
复制

如果发票未完成或未付款。


1{
2    "state": 1,
3    "message": "Refunds are made only for completed payments"
4}
复制

如果要退款的金额超过发票付款的金额：


1{
2    "state": 1,
3    "message": "The refund amount should not be more than the amount paid"
4}
复制

如果发生技术工作并且付款暂时不可用，则可以收到此错误消息：


1{
2    "state": 1,
3    "message": "Server error"
4}
复制