Payment: Refund Request

post

https://komoju.com/api/v1/payments/{id}/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

length between 25 and 25

A unique identifier for the payment.

Body Params

amount

int32

required

≥ 0

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

customer_name

string

required

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

bank_name

string

required

Name of the customer's bank.

bank_code

string

Optional 4-digit Zengin bank code.

branch_name

string

Name of the customer's bank branch.

branch_number

string

required

3-digit branch number.

account_type

string

enum

required

Type of the customer's bank account.

Allowed:

account_number

int32

required

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

include_payment_method_fee

boolean

required

Whether the refund should include the original payment method fee.

description

string

Optional description or reason for this refund request.

platform_details

object

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

403Invalid authorization

404Payment does not exist

503Maintenance