Refund(課金の払い戻し)

Refunds(課金の払い戻し)は、過去に作成した課金オブジェクトの払い戻し処理を行います。 払い戻された金銭は課金請求をしたクレジットカードに対して行われます。 一部金額を払い戻すこともできます。一度行った払い戻しは、一部払い戻しであっても取り消せません。

Attributes

Name Type Description
object string

固定値refund

id object_id

/rfnd(_test)?_[0-9a-z]+/に一致するREFUND_ID

livemode boolean

本番モード (true) あるいはテストモード(false) の返金。

location string

現在のrefundオブジェクトを取得するためのAPIパス。

amount integer

smallest currency unit(最小通貨単位)での返金額。

charge object_id

返金に紐づくCharge ID

created_at datetime

ISO 8601 形式 (YYYY-MM-DDThh:mm:ssZ)で返金が作成されたUTC日時。

currency currency

3文字で表示される返金用通貨ISO 4217 コード。

funding_amount integer

funding_currencycurrency != funding_currencyの場合)と両替後に加盟店に支払われる金額を[最小通貨単位](/currency-and-amount)で表したもの。

funding_currency currency

funding_amountの通貨

metadata object

返金のためのカスタムメタデータ(例:{"customer-id": 42}) 。

transaction object_id

返金されたTRANSACTION_ID

voided boolean

返金が無効化されているかどうか。

Deprecated Attribute

Name Type Description
status string

返金のステータス。

Example

  • JSON Response

払い戻しリストの取得

- GET https://api.omise.co/refunds

refundに属するすべての お客様のアカウントオブジェクトの list を返します。

Request Parameters

Name Type Description
from datetime

(任意, default: 1970-01-01T00:00:00Z) ISO 8601 形式(YYYY-MM-DDThh:mm:ssZ)で返されたレコードの最新のUTC日時。

limit integer

(任意, default: 20, maximum: 100) 返されるレコードの数。

offset integer

(任意, default: 0) 返される最初のレコードのオフセット(先頭からスキップするレコードの数)。

order string

(任意, default: chronological) listのオーダーがchronological (古い順) or reverse_chronological (新しい順)で返されます。エントリがない場合は nullとなります。

to datetime

(任意, default: current UTC datetime) ISO 8601形式 (YYYY-MM-DDThh:mm:ssZ)で返されたレコードの最新のUTC日付と時刻。

Example

  • 課金の払い戻しリストの取得

払い戻しリストの取得

- GET https://api.omise.co/charges/{id}/refunds

refundに属するすべての お客様のアカウントオブジェクトの list を返します。

Request Parameters

Name Type Description
from datetime

(任意, default: 1970-01-01T00:00:00Z) ISO 8601 形式(YYYY-MM-DDThh:mm:ssZ)で返されたレコードの最新のUTC日時。

limit integer

(任意, default: 20, maximum: 100) 返されるレコードの数。

offset integer

(任意, default: 0) 返される最初のレコードのオフセット(先頭からスキップするレコードの数)。

order string

(任意, default: chronological) listのオーダーがchronological (古い順) or reverse_chronological (新しい順)で返されます。エントリがない場合は nullとなります。

to datetime

(任意, default: current UTC datetime) ISO 8601形式 (YYYY-MM-DDThh:mm:ssZ)で返されたレコードの最新のUTC日付と時刻。

Example

  • 特定の課金に関する払い戻し情報のリスト

新しい課金の払い戻しを作成

- POST https://api.omise.co/charges/{id}/refunds

新しい課金の払い戻しを作成し、そのRefundオブジェクトを返します。

Request Parameters

Name Type Description
amount integer

(必須) smallest currency unit(最小通貨単位)での返金額。

metadata object

(任意) 返金のためのカスタムメタデータ(例:{"customer-id": 42}) 。

void boolean

(任意) 任意:デフォルトはfalse、void のみを実施させるためのフラグ。もし void ができない場合、refund を行わない。

Example

  • 新しい課金の払い戻しを作成

  • Create a refund while adding metadata

課金の払い戻し情報の取得

- GET https://api.omise.co/charges/{id}/refunds/{refund_id}

課金IDで指定したChargeオブジェクトにひも付くRefundオブジェクトを取得します。

Example

  • 課金の払い戻し情報の取得