Search Query and Filters

The Search API has query and filters that returns different aspects of searching data. query is for returning any generic data (within scope) which has the serching text involved, while filters only returns specific data from the given key and the searched text.

Scope: Charge

Query

The searching text is expected to search through these fields without including any field names.

Field Description
id ID of the charge object. E.g. chrg_235k46kl6ljl
card_bank bank of the card attached to that charge.
card_brand brand of the card attached to that charge. E.g. Visa, MasterCard or JCB
card_id ID of the card attached to that charge. E.g. card_235k46kl6ljl
card_name name of the card attached to that charge.
currency a currency made in the charge. E.g. thb or jpy
customer_description a description of the customer attached to the charge.
customer_email an e-mail of the customer attached to the charge.
customer_id ID of the customer attached to the charge. E.g. cust_235k46kl6ljl
description a charge's description

Filters

The searching text is expected to have the key and value included.

Key Value
amount an amount charged in normal currency unit E.g. THB 1,000 is 1000
authorized if the charge is authorized or not. E.g. true or false
capture if the charge is auto-captured or not. E.g. true or false
captured if the charge has been captured or not. E.g. true or false
card_last_digits last 4 digits of the card attached to the charge
created (optional, default: 1970-01-01T00:00:00Z, format: iso8601) The UTC date and time limiting the beginning of returned records. E.g.: 2014-10-20T00:00:00Z
customer_present if the charge has customer attached. E.g. true or false
failure_code a charge's failure_code when it failed to create
failure_message a charge's failure_message when it failed to create
refunded if the charge has been refunded. E.g. true or false
refund_amount refund amount attached to the charge. E.g. THB 500 is 500
reversed if the charge has been reversed. E.g. true or false
status charge's status. E.g. successful, pending, reversed or failed
source_of_fund charge's source of fund. E.g. card or offsite
voided if the charge has been voided refunded. E.g. true or false

Scope: Dispute

Query

The searching text is expected to search through these fields without including any field names.

Field Description
id ID of the dispute object. E.g. dspt_235k46kl6ljl
card_id card id attached to the dispute
card_name card name attached to the dispute
message dispute message

Filters

The searching text is expected to have the key and value included.

Key Value
card_last_digits last 4 digits of the card attached to the dispute
created (optional, default: 1970-01-01T00:00:00Z, format: iso8601) The UTC date and time limiting the beginning of returned records. E.g.: 2014-10-20T00:00:00Z
status dispute status E.g. open, pending, won or lost

Scope: Recipient

Query

The searching text is expected to search through these fields without including any field names.

Field Description
id ID of the recipient object. E.g. recp_235k46kl6ljl
description a recipient's description.
email a recipient's e-mail.
name a recipient's name.
failure_code a failure_code that returns when merchant failed to verify a recipient

Filters

The searching text is expected to have the key and value included.

Key Value
kind type of the recipient E.g. individual or corporation

Scope: Customer

Query

The searching text is expected to search through these fields without including any field names.

Field Description
id ID of the customer object. E.g. cust_235k46kl6ljl
description a customer's description.
email a customer's e-mail.

Filters

The searching text is expected to have the key and value included.

Key Value
created (optional, default: 1970-01-01T00:00:00Z, format: iso8601) The UTC date and time limiting the beginning of returned records. E.g.: 2014-10-20T00:00:00Z