退款 - EasyPay API

请求参数

Header 参数

Authorization

string

可选

默认值:

Bearer {{access_token}}

Body 参数application/json

request_id

string

商户订单 ID

必需

payment_id

string | null

可选

payment_id payment_request_id 二选一

payment_request_id

string | null

可选

payment_id payment_request_id 二选一

account_id

string

账户 ID

必需

notify_url

string | null

退款通知地址

可选

refund

object

必需

amount

integer <int64>

退款金额

必需

reason

string

退款原因

必需

metadata

object | null

附加参数

可选

额外字段

object

附加参数

可选

示例

{
  "request_id": "string",
  "payment_id": "string",
  "payment_request_id": "string",
  "account_id": "string",
  "notify_url": "string",
  "refund": {
    "amount": 0,
    "reason": "string"
  },
  "metadata": {
    "property1": {},
    "property2": {}
  }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://demo-api.easypayx.com/v3/acquiring/refunds' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "request_id": "string",
    "payment_id": "string",
    "payment_request_id": "string",
    "account_id": "string",
    "notify_url": "string",
    "refund": {
        "amount": 0,
        "reason": "string"
    },
    "metadata": {
        "property1": {},
        "property2": {}
    }
}'

返回响应

🟢200OK

application/json

Body

data

object (RefundResponse)

可选

id

string

退款 ID

必需

request_id

string

退款幂等参数

必需

payment_id

string

支付 ID

必需

payment_request_id

string

支付幂等参数

必需

account_id

string

账户 ID

必需

payment_type

enum<string>

必需

支付方式（微信、支付宝、钱包）

枚举值:

WECHAT_PAY

notify_url

string | null

退款通知地址

可选

refund

object

必需

settlement

object

必需

payer

object

必需

status

enum<string>

退款状态

必需

枚举值:

INITPENDINGSUCCESSFAILED

create_time

string <date-time>

创建时间

必需

complete_time

string <date-time> | null

退款完成时间

可选

示例

{
  "data": {
    "id": "string",
    "request_id": "string",
    "payment_id": "string",
    "payment_request_id": "string",
    "account_id": "string",
    "payment_type": "WECHAT_PAY",
    "notify_url": "string",
    "refund": {
      "amount": 0,
      "currency": "string",
      "reason": "string"
    },
    "settlement": {
      "currency": "string",
      "exchange_rate": "string"
    },
    "payer": {
      "amount": 0,
      "currency": "string"
    },
    "status": "INIT",
    "create_time": "2019-08-24T14:15:22Z",
    "complete_time": "2019-08-24T14:15:22Z"
  }
}

🟠400Bad Request

🟠404Not Found

🟠409Conflict

🔴500Internal Server Error

🔴503Service Unavailable