このページは現在翻訳中です。

Dispute(チャージバック) API

Dispute(チャージバック) APIからチャージバックを検索、更新 できます。顧客が請求額に疑義がある場合、カード会社を通して Disputeを申し立てることができます。チャージバックの解決に 役立つ文書類は、Document APIを通じてアップロードする ことができます。チャージバックは、open(開始)pending(保留中), won(勝訴), もしくは lost(敗訴)いずれかのステータスとなります。

Attributes

Name Type Description
object string

固定値dispute

id object_id

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

livemode boolean

本番モード (true) あるいはテストモード(false) チャージバックか。

location string

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

admin_message string

チャージバックに関連し管理者からメッセージが追加されました。

amount integer

smallest currency unit(最小の通貨単位)でのチャージバックの金額

charge object_id

チャージバックに関するCHARGE_ID

closed_at datetime

チャージバックが終了した ISO 8601に基づくUTC日時(勝訴または敗訴)。

created_at datetime

ISO 8601 形式 (YYYY-MM-DDThh:mm:ssZ)でチャージバックが作成されたUTC日時。

currency currency

ISO 4217 コードで定義されたチャージバックの通貨。

documents list

このチャージバックに関しアップロードされた documentsList(リスト)。

funding_amount integer

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

funding_currency currency

funding_amountの通貨

message string

チャージバックに対する説明。

metadata object

メタデータをカスタムする (例 {"customer-id": 42}) チャージバック。

reason_code string

チャージバックコード。

reason_message string

チャージバックコードに関するチャージバックのメッセージ。

status string

チャージバックのステータス。open, pending, won または lost のいずれか。(注意:wonlostの紛争は /disputes/closedエンドポイントを使って取得できます)。

transactions array

このチャージバックに関連した取引。

Example

  • JSON Response

チャージバック情報の取得

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

Dispute IDで指定したチャージバックの情報を取得します。

Example

  • チャージバック情報の取得

チャージバック情報の更新

- PATCH https://api.omise.co/disputes/{id}

Dispute IDで指定したチャージバックの情報を更新し、そのデータを取得します。

Request Parameters

Name Type Description
message string

(任意) チャージバックに対する説明。

metadata object

(任意) メタデータをカスタムする (例 {"customer-id": 42}) チャージバック。

Example

  • チャージバック情報の更新

  • Update dispute metadata

チャージバックリストの取得

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

disputeに属するすべての お客様のアカウントオブジェクトの 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

  • チャージバックリストの取得

Accepts the dispute matching `:id`. Only for test mode.

- GET https://api.omise.co/disputes/{id}/accept

Example

  • Accept a dispute

チャージバックリスト(status: 'won' or 'lost')の取得

- GET https://api.omise.co/disputes/closed

チャージバックオブジェクトのステータスが 'won' または 'lost' のリストを取得。ここで返されるリストは、チャージバックの処理が 'won' または 'lost' で終了しているデータです。

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

  • チャージバックリスト(status: 'won' or 'lost')の取得

チャージバックリスト(status: 'open')の取得

- GET https://api.omise.co/disputes/open

チャージバックオブジェクトのステータスが open のリストを取得。

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

  • チャージバックリスト(status: 'open')の取得

チャージバックリスト(status: 'pending')の取得

- GET https://api.omise.co/disputes/pending

チャージバックオブジェクトのステータスが pending のリストを取得。

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

  • チャージバックリスト(status: 'pending')の取得