Logoelepay
Charge

Revoke charge

決済を取消します。

POST
/charges/{id}/revoke

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Charge ID

Response Body

application/json;charset=utf-8

curl -X POST "https://api.elepay.io/charges/string/revoke"
{
  "id": "string",
  "appId": "string",
  "object": "charge",
  "liveMode": true,
  "amount": 0,
  "authorizeAmount": 0,
  "currency": "JPY",
  "authorize": true,
  "paymentMethod": "alipay",
  "resource": "web",
  "orderNo": "string",
  "description": "string",
  "extra": {
    "property1": "string",
    "property2": "string"
  },
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "cardInfo": {
    "brand": "string",
    "last4": "string",
    "expMonth": 0,
    "expYear": 0,
    "name": "string",
    "wallet": "string",
    "walletApp": "string",
    "repaymentType": "string",
    "approvalCode": "string",
    "threeDSecure": true,
    "threeDSecureVersion": "string",
    "threeDSecureDetail": "string",
    "businessType": "string",
    "konbiniScanTime": 0,
    "konbiniType": "string",
    "receivedAmount": 0,
    "receivedTime": 0,
    "bankUserCode": "string",
    "bankUserName": "string",
    "bankName": "string",
    "bankBranchName": "string",
    "bankAccountNo": "string"
  },
  "voucherNo": "string",
  "clientIp": "string",
  "paid": true,
  "refunded": true,
  "disputed": true,
  "refunds": {
    "amount": 0,
    "totalCount": 0,
    "data": [
      {
        "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
      }
    ]
  },
  "status": "pending",
  "codeContent": "string",
  "credential": "string",
  "paidTime": 0,
  "refundTime": 0,
  "expiryTime": 0,
  "settleTime": 0,
  "createTime": 0
}