Refund(課金の払い戻し)

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

Attribute

Name Type Description
object string

refund と返ることで、このJSONレスポンスがRefundの内容に関連することを示す。

id object_id

RefundのID、/rfnd(_test)?_[0-9a-z]+/形式の一意なオブジェクトを示す文字列。

location string

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

amount integer

指定された通貨において最小単位、かつ正の整数で表される金額。(例:100サターンは1タイバーツ) サポート通過コード一覧

charge object_id

Refundにひも付くCharge ID。

created datetime

ISO 8601 形式(YYYY-MM-DDThh:mm:ssZ)でrefund作成の協定世界時(UTC)。

currency string

小文字3桁の国際識別コードで、ISO 4217規格 によって定義された通貨(サポート通貨コード一覧)。

metadata object

メタデータをカスタムする (例 {"customer-id": 42}) refund。

transaction object_id

払い戻しされた Transaction ID。

voided boolean

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

Example

  • Json Response

払い戻しリストの取得

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

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

Request Parameter

Name Type Description
offset integer

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

limit integer

(optional, default: 20, maximum: 100) 返されたレコード数。

from datetime

(optional, default: 1970-01-01T00:00:00Z) ISO 8601 形式の返されたレコードの最初のUTC日付と時刻(YYYY-MM-DDThh:mm:ssZ)。

to datetime

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

order string

(optional, default: chronological) chronological(最初のものから最新のもの)または reverse_chronological (最新のものから最初のもの)のリストのオーダーが返されます。

Example

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

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

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

特定の課金情報に紐づく払い戻し情報を表示することができます。リストについては、ページネーションとリストを参照してください。

Request Parameter

Name Type Description
offset integer

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

limit integer

(optional, default: 20, maximum: 100) 返されたレコード数。

from datetime

(optional, default: 1970-01-01T00:00:00Z) ISO 8601 形式の返されたレコードの最初のUTC日付と時刻(YYYY-MM-DDThh:mm:ssZ)。

to datetime

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

order string

(optional, default: chronological) chronological(最初のものから最新のもの)または reverse_chronological (最新のものから最初のもの)のリストのオーダーが返されます。

Example

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

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

- POST https://api.omise.co/charges/CHARGE_ID/refunds

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

Request Parameter

Name Type Description
amount integer

0以上の符号なし整数を金額として指定、通貨ごとのamountの最小・最大値

void boolean

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

metadata object

メタデータをカスタムする (例 {"customer-id": 42}) refund。

Example

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

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

- GET https://api.omise.co/charges/CHARGE_ID/refunds/REFUND_ID

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

Example

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