dLocal China
Search…
⌃K

退款

此服务允许您对已经完成支付的付款进行退款的创建和查询。
退款是对信用卡 付款 的资金进行退回,资金会从您的账户中扣除并退回给持卡人。
对于其他付款方式,将向客户进行银行转账退款。
我们可能会收取一笔退款操作费。
post
https://api.dlocal.com/
refunds
创建退款
如果下列任意参数缺失或者无效,dLocal都会向买家发送一封邮件(向发起付款请求时提供的邮箱中发送)向买家询问其账户信息。
参数:beneficiary_name ,bank , bank_account , bank_account_type , bank_branch

请求示例

$ curl -X POST \
-H 'X-Date: 2018-02-20T15:44:42.310Z' \
-H 'X-Login: sak223k2wdksdl2' \
-H 'X-Trans-Key: fm12O7G9' \
-H 'X-Version: 2.1' \
-H 'User-Agent: MerchantTest / 1.0 ' \
-H 'Content-Type: application/json' \
-H 'Authorization: V2-HMAC-SHA256, Signature: 1bd227f9d892a7f4581b998c21e353b1686a6bdad5940e7bb6aa596c96e0a6ec' \
https://api.dlocal.com/refunds

请求 Body 示例

{
"payment_id" : "PAY4334346343",
"amount": 100.00,
"currency": "USD",
"notification_url": "http://some.url"
}

退款异步通知消息

如果退款响应中的状态为Pending, 那么退款异步通知消息将会以POST的方法发送到您提供的 Notification URL 中,此通知包含以下参数:

退款对象

参数
类型
描述
id
String
退款ID。
payment_id
String
付款ID。
amount
Positive Float
申请退款金额。
amount_refunded
Positive Float
已退款金额。
currency
String
退款的货币种类代码。
status
String
退款状态。
status_code
String
退款 状态码
status_detail
String
退款状态描述。
created_date
String
退款发起日期。
notification_URL
String
接收dLocal 付款状态发生改变时的消息的邮箱。
description
String
退款的描述。
bank
String
买家的银行名称。
bank_account
String
用户的银行账户编号。
bank_account_type
String
银行账户的类型:C: 代表Current accounts ; S: 代表Saving accounts; I: 代表 International Accounts。
bank_branch
String
用户的银行分行名称。
order_id
String
商户系统中的订单号

POST示例

POST: {refund.notification_url}
{
"id" : "REF42342",
"payment_id" : "PAY245235",
"amount" : 100.00,
"amount_refunded" : 100.00,
"currency" : "USD",
"status" : "SUCCESS",
"status_code" : "200",
"status_detail" : "The refund was paid.",
"created_date" : "2018-02-15T15:14:52-00:00",
"order_id" : "SALE-124635123"
}
get
https://api.dlocal.com/refunds/
{refund_id}
查询退款

请求示例

$ curl \
-H 'X-Date: 2018-02-20T15:44:42.310Z' \
-H 'X-Login: sak223k2wdksdl2' \
-H 'X-Trans-Key: fm12O7G9' \
-H 'Authorization: V2-HMAC-SHA256, Signature: 1bd227f9d892a7f4581b998c21e353b1686a6bdad5940e7bb6aa596c96e0a6ec' \
https://api.dlocal.com/refunds/REF42342
get
https://api.dlocal.com/refunds/
{refund_id}/status
查询退款状态

退款状态码

状态
状态码
描述
PENDING
100
退款请求处理中。
SUCCESS
200
退款已完成。
REJECTED
300
退款被拒绝。
CANCELLED
400
退款取消。

错误

所有的错误都会已相应的HTTP状态码进行返回,格式为 4XX 或 5XX 。所有错误的类型如下:
参数
类型
描述
code
Integer
错误代码。
message
String
错误详情描述。
param
String
以防有一个参数发生错误。
错误示例
{
"code": 5012,
"message": "Insufficient funds."
}

HTTP 错误

HTTP 状态码
错误码
错误描述
403 Forbidden
3001
Invalid Credentials.
3002
Unregistered IP address.
3003
Merchant has no authorization to use this API.
404 Not Found
4000
Payment not found.
4001
Refund not found.
400 Bad Request
5000
Invalid request.
5001
Invalid parameter: [parameter_name]
5002
Invalid transaction status.
5003
Country not supported.
5004
Currency not allowed for this country.
5005
User unauthorized due to cadastral situation.
5006
User limit exceeded.
5007
Amount exceeded.
5010
Request timeout.
5011
Order refund id is duplicated.
5012
Insufficient funds.
5017
Invalid API Version
5018
Chargeback in place for this transaction.
5020
Refund period exceeded.
429 Too many requests
6000
Too many requests to the API.
500 Internal Server Error
7000
The input is correct, but dLocal fails to process the payment. Rare case.

退款流程图