Dispute(チャージバック) API

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

Attribute

Name Type Description
object string

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

id object_id

DisputeのID。

livemode boolean

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

location string

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

admin_message string

The admin message associated with the dispute.。

amount integer

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

charge object_id

Disputeに対するChargeのID。

closed_at datetime

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

created datetime

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

currency string

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

documents list

このチャージバックに関しアップロードされたドキュメントリスト。

message string

Disputeに対する説明。

metadata object

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

reason_code string

チャージバックコード。

reason_message string

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

status string

Disputeのステータス。open, pending, won または lost のいずれか。

transaction object_id

このチャージバックのTRANSACTION_ID。

Example

  • Json Response

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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)。

order string

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

to datetime

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

Example

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

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

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

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

Example

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

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

- PATCH https://api.omise.co/disputes/DISPUTE_ID

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

Request Parameter

Name Type Description
message string

チャージバックのmessageへ更新するテキスト。

metadata object

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

Example

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