Create refund

決済の全額あるいは一部の返金処理を行います。

Authorization

AuthorizationBearer <token>

API呼出すの認証は、秘密鍵を認証トークンとして扱い、Bearer 認証経由で行われます。秘密鍵は、全ての API リクエスト操作が可能となる重要なキーなので、取扱いにご注意ください。

In: header

Path Parameters

id*string

Charge ID

Request Body

application/json

返金の詳細情報

amount*integer

返金額。全額返金、及び amount の指定で任意の金額で返金ができます。

currency?string

通貨コード (ISO_4217)

Default"JPY"

metadata?

返金メタデータ

reason?string

返金理由

Response Body

application/json;charset=utf-8

curl -X POST "https://api.elepay.io/charges/string/refunds" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 0
  }'

curl -X POST "https://api.elepay.io/charges/string/refunds" \  -H "Content-Type: application/json" \  -d '{    "amount": 0  }'

{
  "id": "string",
  "object": "refund",
  "chargeId": "string",
  "liveMode": true,
  "amount": 0,
  "currency": "string",
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "reason": "string",
  "status": "pending",
  "refundedTime": 0,
  "createTime": 0
}