v1

latestOpenAPI 3.0.22026-07-2667277423.4 KB

Payments

Payment: Refund Request

A "Refund Request" requests that a payment be refunded manually. This can be used for payment methods that do not support refunds, such as konbini. To support non-refundable payment methods, a bank account must be specified so that we know where to send the funds. Since it is a manual process, the refund will be carried out at a later date, and there's a possibility of it being rejected.

post/payments/{id}/refund_request

Path parameters

idstring required

A unique 25-character alphanumeric resource identifier.

A unique identifier for the payment.

Request body

amountinteger required

The payment amount before tax, greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).

customer_namestring required

Customer's name in half-width katakana, as registered at the bank.

bank_namestring required

Name of the customer's bank.

bank_codestring

Optional 4-digit Zengin bank code.

branch_namestring

Name of the customer's bank branch.

branch_numberstring required

3-digit branch number.

account_type'normal' | 'checking' | 'savings' required

Type of the customer's bank account.

account_numberinteger required

7-digit bank account number to deposit the refund into.

include_payment_method_feeboolean required

Whether the refund should include the original payment method fee.

descriptionstring

Optional description or reason for this refund request.

Example request

{
  "amount": 1000,
  "platform_details": {
    "submerchants": [
      {
        "submerchant_id": "submerc1od2nc89s6u5hh6x4g",
        "amount": 900,
        "platform_fee": 100
      }
    ]
  }
}