Refund(課金の払い戻し)

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

Attributes

Name Type Description
object string

固定値refund

id string

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

livemode boolean

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

location string

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

acquirer_reference_number string

加盟店が行った返金の参照番号です。この情報は、VisaおよびMastercardに向けた決済レポートの一部として送信されます。

amount integer

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

charge object_id_expandable

返金に紐づくCharge ID

created_at string

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

currency string

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

funding_amount integer

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

funding_currency string

funding_amountの通貨

merchant_name string

返金を実行したサブマーチャントの名前です。

注: このフィールドは、加盟店がプラットフォーム向けソリューションを導入している場合にのみ適用されます。プラットフォーム向けソリューションのご利用については、サポートまでお問い合わせください。

merchant_uid string

返金を実行したサブマーチャントのIDです。

注: このフィールドは、加盟店がプラットフォーム向けソリューションを導入している場合にのみ適用されます。プラットフォーム向けソリューションのご利用については、サポートまでお問い合わせください。

metadata object

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

status string

返金のステータス。

terminal string

Original charge point of sale within a branch.

transaction object_id_expandable

返金されたTRANSACTION_ID

voided boolean

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

Example

  • JSON Response

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

- 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

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

Example

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

  • Create a refund while adding metadata

払い戻しリストの取得

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

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

Request Parameters

Name Type Description
from string

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

limit integer

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

offset integer

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

order string

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

to string

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

Example

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

払い戻しリストの取得

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

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

Request Parameters

Name Type Description
from string

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

limit integer

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

offset integer

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

order string

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

to string

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

Example

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

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

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

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

Example

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

Omiseは、お客様のウェブサイト全般における利便性を向上するためにクッキーを利用し、お客様のアクセス、閲覧履歴に関する情報を収集します。 当社のウェブサイトを閲覧し続けることにより、お客様は当社のプライバシーポリシーに同意することとします。 詳細はこちら