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 searching text involved, while filters only returns specific data from the given key and the searched text.

Resources

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
metadata a charge's metadata E.g. ( { "invoice_id" : "123456"} ) You can search by metadata's value ( 123456 )

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
captured_at The date and time at which the charge was captured. ISO 8601 format.
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
refunded_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
safe if the charge is safe or not. E.g. true or false
source_of_fund charge's source of fund. E.g. card or offsite or offline
voided if the charge has been voided refunded. E.g. true or false

Scope: Refund

Query

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

Field Description
id ID of the refund object. E.g. rfnd_235k46kl6ljl
card_bank bank of the card attached to that refund.
card_brand brand of the card attached to that refund. E.g. Visa, MasterCard or JCB
card_id ID of the card attached to that refund. E.g. card_235k46kl6ljl
card_name name of the card attached to that refund.
charge_description The charge description as received.
currency a currency made in the refund. E.g. thb or jpy
metadata a refund's metadata E.g. ( { "invoice_id" : "123456"} ) You can search by metadata's value ( 123456 )

Filters

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

Key Value
amount an amount refund in normal currency unit E.g. THB 1,000 is 1000
card_first_digits first 6 digits of the card attached to the refund
card_last_digits last 4 digits of the card attached to the refund
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 charge's status. E.g. successful, pending, reversed or failed
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_brand brand of the card attached to that dispute. E.g. Visa, MasterCard or JCB
card_id card id attached to the dispute.
card_name card name attached to the dispute.
message dispute message.
metadata a dispute's metadata E.g. ( { "invoice_id" : "123456"} ) You can search by metadata's value ( 123456 )
reason_code dispute's reason code.
reason_message dispute's reason message.

Filters

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

Key Value
amount an amount disputed in normal currency unit E.g. THB 1,000 is 1000
card_first_digits first 6 digits of the card attached to the dispute.
card_last_digits last 4 digits of the card attached to the dispute.
closed_at The date and time at which the dispute was closed. ISO 8601 format.
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
currency a currency made in the dispute. E.g. thb or jpy
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
bank_name a recipient's bank name.
bank_brand brand of the bank attached to that recipient. E.g. Kasikorn, or Bangkok
description a recipient's description.
email a recipient's e-mail.
id ID of the recipient object. E.g. recp_235k46kl6ljl
name a recipient's name.
failure_code a failure_code that returns when merchant failed to verify a recipient.
metadata a recipient's metadata E.g. ( { "custom" : "123456"} ) You can search by metadata's value ( 123456 )

Filters

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

Key Value
active if the recipient has been activated. E.g. true or false
activated_at The date and time at which the recipient was activated. ISO 8601 format.
bank_last_digits a recipient's bank last digits.
deleted if the recipient has been deleted. E.g. true or false
type 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

Query

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

Field Description
id ID of the link object. E.g. link_235k46kl6ljl
currency a currency made in the refund. E.g. thb or jpy
description The link description.
link_reference The link reference.
title The link title.

Filters

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

Key Value
amount an amount link in normal currency unit E.g. THB 1,000 is 1000
created Creation date of the link in ISO 8601 format.
multiple Whether the link is set to be used multiple times or not.
used Whether the link was used or not.
used_at Date and time of the link was used in format ISO 8601 format.

Scope: Transfer

Query

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

Field Description
id ID of the link object. E.g. trsf_235k46kl6ljl
bank_name a transfer's bank name.
bank_brand brand of the bank attached to that transfer. E.g. Kasikorn, or Bangkok
currency a currency made in the refund. E.g. thb or jpy
failure_code a tranfer's failure code
failure_message a transfer's failure message
metadata a transfer's metadata E.g. { "custom" : "123456” } You can search by metadata's value 123456
recipient_email a transfer's recipient email
recipient_id a transfer's recipient ID
recipient_name a transfer's recipient name
transaction_id a transfer's transaction ID. E.g. trxn_123456790

Filters

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

Key Value
amount an amount transfer in normal currency unit E.g. THB 1,000 is 1000
created Creation date of the link in ISO 8601 format.
deleted if the transfer has been deleted. E.g. true or false
fee an fee transfer E.g. THB 1,000 is 1000
paid Whether the transfer was paided or not. E.g. true or false
paid_at Date and time of the transfer was paided in format ISO 8601 format.
sent Whether the transfer was sent or not. E.g. true or false
sent_at Date and time of the transfer was sent in format ISO 8601 format.