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

検索クエリとフィルタ

検索APIには様々なデータが検索できる queryfilters があります。 query は検索テキストを含めた汎用データ(スコープ内)を返すためのものです。filters は指定されたキー及び検索テキストから特定のデータのみを返します。

スコープ:課金

クエリ

検索テキストはフィールド名を含まずに次のフィールドで検索されます。

Field Description
id 課金オブジェクトのID。例: chrg_235k46kl6ljl
card_brand 該当課金のカードブランド。例: VisaMasterCardJCB
card_id 該当課金のカードID。例: card_235k46kl6ljl
card_name 該当課金のカード名義
currency 該当課金の通貨。例: thbjpy
customer_description 該当課金の顧客についての説明
customer_email 顧客のメールアドレス
customer_id 該当課金の顧客ID。例: cust_235k46kl6ljl
description 課金についての説明

フィルタ

検索テキストにはキーと値が含まれることを想定しています。

Key Value
amount 通常通貨単位で課金された金額。例: JPY 1,0001000 として表示。
authorized 課金がオーソライズされている場合は true 、まだの場合は false
capture 課金がオートキャプチャーの場合は true 、後日に実売上化する場合は false
captured 課金が実売上化された場合は true 、仮売上化された場合は false
card_last_digits カード番号の下4桁
created (任意:デフォルトは 1970-01-01T00:00:00Z、iso8601フォーマットの日付を指定します。) ここに指定したタイムスタンプ以降に作成されたデータを取得。例:2014-10-20T00:00:00Z
customer_present 課金が「Customer」を使用して作成された場合は true 、そうでなければ false
failure_code 課金失敗時に返されるエラーコード。
failure_message 課金失敗時に返されるエラーメッセージ。
refunded 返金がされた場合は true 、そうでなければ false
refund_amount 返金した金額。例: JPY 500500 として表示。 。
reversed 課金の取消が行われていれば true 、そうでなければ false
status 課金のステータス。例: successfulpendingreversedfailed

スコープ:チャージバック

クエリ

検索テキストはフィールド名を含まずに次のフィールドで検索されます。

Field Description
id チャージバックのID。例: dspt_235k46kl6ljl
card_id 該当チャージバックのカードID。
card_name 該当チャージバックのカード名義。
message チャージバックに関するメッセージ。

フィルタ

検索テキストにはキーと値が含まれることが想定されます。

Key Value
card_last_digits 該当チャージバックのカード番号下4桁
created (任意:デフォルトは 1970-01-01T00:00:00Z、 iso8601フォーマットの日付を指定します。) ここに指定したタイムスタンプ以降に作成されたデータを取得。例: 2014-10-20T00:00:00Z
status チャージバックのステータス。例 openpendingwonlost

スコープ:受取口座(レシピエント)

クエリ

検索テキストはフィールド名を含まずに次のフィールドで検索されます。

Field Description
id 受取口座のID。例: recp_235k46kl6ljl
description 受取口座についての説明。
email 受取口座のメールアドレス。
name 受取口座の名義。
failure_code 受取口座が承認できない場合に返却されたエラーコード。

フィルタ

検索テキストにはキーと値が含まれることを想定しています。

Key Value
kind 受取口座の種類。例: individual(個人)corporation(法人)

スコープ:顧客(カスタマー)

クエリ

検索テキストはフィールド名を含まずに次のフィールドで検索されます。

Field Description
id 顧客のID。例: cust_235k46kl6ljl
description 顧客についての説明。
email 顧客のメールアドレス。

フィルタ

検索テキストにはキーと値が含まれることを想定しています。

Key Value
created (任意:デフォルトは 1970-01-01T00:00:00Z、iso8601フォーマットの日付を指定します。) ここに指定したタイムスタンプ以降に作成されたデータを取得。例: 2014-10-20T00:00:00Z