Search Query and Filters

หัวข้อทั้งหมดในหน้านี้

ร้านค้าสามารถค้นหาข้อมูลภายใน scope ต่างๆ โดยใช้ Search API

การใช้งาน

ร้านค้าจะต้องกำหนด scope เพื่อค้นหาข้อมูลตามตัวอย่าง:

curl https://api.omise.co/search \
     -X GET \
     -u $OMISE_SECRET_KEY: \
     -d "scope=charge"

ตัวอย่างจากด้านบนจะแสดงข้อมูลรายการทั้งหมดในบัญชีโดยเรียงลำดับจากรายการที่ล่าสุดก่อน โดยจะแสดงข้อมูล 30 รายการต่อหนึ่งหน้า กรุณาดู Search API เพื่อดูตัวอย่างเพิ่มเติม

เพื่อให้การค้นหาละเอียดขึ้น กรุณาเพิ่มตัวแปรที่เป็น query และ filter เวลาค้นหาข้อมูล หากเพิ่มตัวแปรทั้ง query และ filter พร้อมกัน ระบบจะแสดงข้อมูลจากการกรองของทั้งสองตัวแปร

Queries

เมื่อมีการกำหนดตัวแปร query ในการค้นหาข้อมูล ระบบจะส่งข้อมูลตาม scope ที่กำหนดจาก query string ที่ได้รับมา

curl https://api.omise.co/search \
     -X GET \
     -u $OMISE_SECRET_KEY: \
     -d "scope=charge" \
     -d "query=somchai"

ตัวอย่างด้านบนแสดงผลลัพท์ที่มีค่า somchai จากตัวแปรที่ระบุในการค้นหา

Filters

เมื่อได้กำหนดตัวแปร filters ในการค้นหา ข้อมูลที่ถูกส่งกลับมาจะตรงกับค่าที่ตั้งไว้ใน filter object

curl https://api.omise.co/search \
     -X GET \
     -u $OMISE_SECRET_KEY: \
     -d "scope=charge" \
     -d "filters[amount]=1000" \
     -d "filters[currency]=USD"

ตัวอย่างด้านบนแสดงถึงการค้นหารายการที่มี amount เท่ากับ 1000 USD

เวลาค้นหาข้อมูลที่เป็นจำนวนเงินหรือ amount ให้ใช้หน่วยพื้นฐาน เช่น USD ไม่ใช่ Cents ตัวอย่างเช่น รายการที่สร้างขึ้นด้วย amount=100000 และ currency=USD สามารถค้นหาได้จาก filters[amount]=1000

Booleans

สำหรับการค้นหา Boolean ร้านค้าสามารถใช้คำสั่งอื่นๆ ที่มีความหมายเดียวกับ true และ false ได้ เช่น yes กับ no

curl https://api.omise.co/search \
     -X GET \
     -u $OMISE_SECRET_KEY: \
     -d "scope=charge" \
     -d "filters[captured]=yes"

curl https://api.omise.co/search \
     -X GET \
     -u $OMISE_SECRET_KEY: \
     -d "scope=charge" \
     -d "filters[captured]=on"

curl https://api.omise.co/search \
     -X GET \
     -u $OMISE_SECRET_KEY: \
     -d "scope=charge" \
     -d "filters[captured]=no"

curl https://api.omise.co/search \
     -X GET \
     -u $OMISE_SECRET_KEY: \
     -d "scope=charge" \
     -d "filters[captured]=off"

การระบุช่วงวันที่ในการค้นหา

สำหรับการค้นหาแบบระบุวันที่ ร้านค้าสามารถใส่ตัวเลขหรือระบุวันที่ได้หรือใช้คำระบุช่วงวันที่อย่าง this_month ได้เช่นกัน

curl https://api.omise.co/search \
     -X GET \
     -u $OMISE_SECRET_KEY: \
     -d "scope=charge" \
     -d "filters[amount]=1000..2000"

curl https://api.omise.co/search \
     -X GET \
     -u $OMISE_SECRET_KEY: \
     -d "scope=charge" \
     -d "filters[created]=2019/01/01..2019/12/31"

curl https://api.omise.co/search \
     -X GET \
     -u $OMISE_SECRET_KEY: \
     -d "scope=charge" \
     -d "filters[created]=this_month"

ตัวอย่างแรกได้แสดงถึงการค้นหารายการที่มียอดระหว่าง 1000 ถึง 2000 (USD, THB, JPY, etc.) ตัวอย่างที่สองแสดงถึงการค้นหารายการทั้งหมดที่เกิดขึ้นทั้งหมดภายในปี 2019 ตัวอย่างที่สามแสดงถึงการค้นหารายการทั้งหมดที่ถูกสร้างขึ้นภายในเดือนนี้

การขยายข้อมูลจาก ID

ใน API ของ Opn Payments สามารถใช้ ID อ้างอิงเพื่อค้นหาข้อมูลเต็มแทนตัวเลขได้ โดยใช้ตัวแปร expand

curl https://api.omise.co/search \
     -X GET \
     -u $OMISE_SECRET_KEY: \
     -d "scope=refund" \
     -d "expand=true"

การดาวน์โหลดข้อมูลจากการค้นหา

ข้อมูลบางชนิดสามารถดาวน์โหลดออกมาเป็นไฟล์ได้ เช่น ข้อมูลรายการ ลูกค้า การปฏิเสธรายการ ผู้รับเงิน การคืนเงิน และการโอนเงิน

เมื่อทำการค้นหาโดยกำหนดค่าให้ export=true และค่าของ filter_type เป็น monthly_captured monthly_created หรือ monthly_date ผลลัพท์ที่ตอบกลับมาจะแนบตัวแปร export ที่มีค่า ID ของข้อมูลที่ถูกดาวน์โหลดล่าสุด

หากไม่ได้กำหนดค่าของ filter_date ระบบจะค้นหาข้อมูลจากเดือนปัจจุบัน

curl https://api.omise.co/search \
     -X GET \
     -u $OMISE_SECRET_KEY: \
     -d "scope=refund" \
     -d "export=true" \
     -d "filter_type=monthly_created"

Queries และ Filters ที่รองรับ

charge

ใช้ scope=charge เพื่อค้นหา charge Query และ filter ด้านล่างนี้สามารถใช้ได้เฉพาะในกรอบการค้นหานี้เท่านั้น

Filters

ค้นหาข้อมูลแบบเจาะจงได้โดยการใส่ตัวแปรด้านล่างใน filters

Key Description
amount Charge amount in main unit of charge currency. For example, use 1000 for 1000 THB.
authorized Whether charge has been authorized.
capture Whether charge is set to be automatically captured (paid).
captured Whether charge has been captured (paid).
captured_at UTC datetime of charge capture (payment) in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).
credit_card_brand Card brand (e.g. Visa, Mastercard).
card_last_digits Last four (4) digits of card number.
created UTC datetime of charge creation in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).
currency Currency for charge as three-letter ISO 4217 code.
disputed Whether charge is disputed.
failure_code Failure code if status == failed. See testing for possible codes.
fraud Whether charge is confirmed to be fraudulent.
is_installment Whether charge is installment.
refunded Charge amount refunded.
refund_amount Amount for refund in common currency unit. For example, use 1000 for 1000 THB.
scheduled Whether charge is scheduled.
source_of_fund Payment mode. One of card, offsite, or offline.
source_type Payment source type
status Charge status. One of failed, expired, pending, reversed or successful.
voided Whether, in the case of a refund, charge was voided instead. Charges are voided if refund is processed before settlement time.
installment_terms Installment term in months. See installments for allowed values (type=installment_*).

Queries

ค้นหาค่าของตัวแปรได้โดยระบุใน query string

Key Description
id The charge identifier matching /chrg(_test)?_[0-9a-z]+/.
card_bank Card bank name. Note: derived from issuer identification number (IIN); may not be accurate.
card_name Card owner name.
description Charge description.
failure_message Message describing the failure if status == failed.
metadata Custom metadata (e.g. {"answer": 42}) for charge.

charge_schedule

ใช้ scope=charge_schedule เพื่อค้นหา charge schedule Query และ filter ด้านล่างนี้สามารถใช้ได้เฉพาะในกรอบการค้นหานี้เท่านั้น

Filters

ค้นหาข้อมูลแบบเจาะจงได้โดยการใส่ตัวแปรด้านล่างใน filters

Key Description
status One of:
  • active: The schedule is running.
  • expiring: The schedule's next occurrence is its last.
  • expired: The schedule has reached its last occurrence and is not running anymore.
  • deleted: The schedule has been deleted and is not running anymore.
  • suspended: The schedule could not be completed and was stopped.
.
active Whether scheduled charge is active or not. Includes schedules where status==active or status==expiring
amount Scheduled charge amount in main unit of charge currency. For example, use 1000 for 1000 THB.
created UTC datetime of schedule creation in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).
card_last_digits Last four (4) digits of card number.

Queries

ค้นหาค่าของตัวแปรได้โดยระบุใน query string

Key Description
recurrence_id The schedule identifier matching /schd(_test)?_[0-9a-z]+/.
currency Currency for scheduled charge as three-letter ISO 4217 code.
description Scheduled charge description.
customer_email Customer email address.
card_brand Card brand (e.g. Visa, Mastercard).
card_bank Card bank name. Note: derived from issuer identification number (IIN); may not be accurate.
card_name Card owner name.

customer

ใช้ scope=customer เพื่อค้นหา customer Query และ filter ด้านล่างนี้สามารถใช้ได้เฉพาะในกรอบการค้นหานี้เท่านั้น

Filters

ค้นหาข้อมูลแบบเจาะจงได้โดยการใส่ตัวแปรด้านล่างใน filters

Key Description
created UTC datetime of customer creation in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

Queries

ค้นหาค่าของตัวแปรได้โดยระบุใน query string

Key Description
id The customer identifier matching /cust(_test)?_[0-9a-z]+/.
description Customer description.
email Customer email address.
metadata Custom metadata (e.g. {"answer": 42}) for customer.

dispute

ใช้ scope=dispute เพื่อค้นหา dispute Query และ filter ด้านล่างนี้สามารถใช้ได้เฉพาะในกรอบการค้นหานี้เท่านั้น

Filters

ค้นหาข้อมูลแบบเจาะจงได้โดยการใส่ตัวแปรด้านล่างใน filters

Key Description
amount Dispute amount in smallest unit of dispute currency.
card_first_digits First six (6) digits of the card number: the issuer identification number (IIN).
card_last_digits Last four (4) digits of card number.
charge_id The charge identifier matching /chrg(_test)?_[0-9a-z]+/.
closed_at UTC datetime of dispute closure (i.e. status changed to won or lost) of the dispute in ISO 8601 format.
created UTC datetime of dispute creation in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).
currency Currency for dispute as three-letter ISO 4217 code.
fraud Whether dispute is related to a fraudulent charge.
status The dispute status. One of open, pending, won or lost. (note: won and lost disputes are retrievable using the /disputes/closed endpoint).

Queries

ค้นหาค่าของตัวแปรได้โดยระบุใน query string

Key Description
id The dispute identifier matching /dspt(_test)?_[0-9a-z]+/.
card_brand Card brand (e.g. Visa, Mastercard).
card_id The card identifier matching /card(_test)?_[0-9a-z]+/.
card_name Card owner name.
metadata Custom metadata (e.g. {"answer": 42}) for dispute.
message Explanation for dispute.
reason_code Dispute reason code.
reason_message Dispute message associated with the dispute reason code.

ใช้ scope=link เพื่อค้นหา link Query และ filter ด้านล่างนี้สามารถใช้ได้เฉพาะในกรอบการค้นหานี้เท่านั้น

Filters

ค้นหาข้อมูลแบบเจาะจงได้โดยการใส่ตัวแปรด้านล่างใน filters

Key Description
amount Link amount in main unit of link currency. For example, use 1000 for 1000 THB.
created UTC datetime of link creation in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).
currency Currency for link as three-letter ISO 4217 code.
multiple Whether link is able to be used more than once.
used Whether single-use link (multiple=false) was used.
used_at UTC datetime of the usage of the link in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). Single-use links only.

Queries

ค้นหาค่าของตัวแปรได้โดยระบุใน query string

Key Description
id The link identifier matching /link(_test)?_[0-9a-z]+/.
description Link description.
link_reference URI of link.
title Link title.

receipt

ใช้ scope=receipt เพื่อค้นหา receipt Query และ filter ด้านล่างนี้สามารถใช้ได้เฉพาะในกรอบการค้นหานี้เท่านั้น

Filters

ค้นหาข้อมูลแบบเจาะจงได้โดยการใส่ตัวแปรด้านล่างใน filters

Key Description
created UTC datetime of receipt creation in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

Queries

ค้นหาค่าของตัวแปรได้โดยระบุใน query string

Key Description
id The receipt identifier matching /rcpt(_test)?_[0-9a-z]+/.

recipient

ใช้ scope=recipient เพื่อค้นหา recipient Query และ filter ด้านล่างนี้สามารถใช้ได้เฉพาะในกรอบการค้นหานี้เท่านั้น

Filters

ค้นหาข้อมูลแบบเจาะจงได้โดยการใส่ตัวแปรด้านล่างใน filters

Key Description
active Whether recipient is active.
activated_at UTC datetime of the activation of the recipient in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).
bank_last_digits Last four (4) digits of bank account number.
created UTC datetime of recipient creation in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).
deleted Whether recipient is deleted.
failure_code Recipient creation failure code. One of name_mismatch, account_not_found, or bank_not_found.
type Recipient type. One of individual or corporation.
verified Whether recipient is verified.
verified_at UTC datetime of the verification of the recipient in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

Queries

ค้นหาค่าของตัวแปรได้โดยระบุใน query string

Key Description
id The recipient identifier matching /recp(_test)?_[0-9a-z]+/.
bank_name Bank account holder name. For Japanese bank accounts, see notes on entering bank account holder names.
bank_brand Bank account brand (Thailand and Singapore only).
description Recipient description.
email Recipient email address.
metadata Custom metadata (e.g. {"answer": 42}) for recipient.
name Recipient name.
tax_id Recipient tax ID.

refund

ใช้ scope=refund เพื่อค้นหา refund Query และ filter ด้านล่างนี้สามารถใช้ได้เฉพาะในกรอบการค้นหานี้เท่านั้น

Filters

ค้นหาข้อมูลแบบเจาะจงได้โดยการใส่ตัวแปรด้านล่างใน filters

Key Description
amount Refund amount in smallest unit of charge currency.
card_first_digits First 6 digits of the card number: the issuer identification number (IIN).
card_last_digits Last four (4) digits of card number.
charge_id The charge identifier matching /chrg(_test)?_[0-9a-z]+/.
created UTC datetime of refund creation in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).
status Status of the refund.
voided Whether refunded charge was voided instead. Charges are voided if refund is processed before settlement time.

Queries

ค้นหาค่าของตัวแปรได้โดยระบุใน query string

Key Description
id The refund identifier matching /rfnd(_test)?_[0-9a-z]+/.
card_bank Card bank name. Note: derived from issuer identification number (IIN); may not be accurate.
card_brand Card brand (e.g. Visa, Mastercard).
card_id The card identifier matching /card(_test)?_[0-9a-z]+/.
card_name Card owner name.
charge_description Charge description.
currency Currency for refund as three-letter ISO 4217 code.
metadata Custom metadata (e.g. {"answer": 42}) for refund.

transfer

ใช้ scope=transfer เพื่อค้นหา transfer Query และ filter ด้านล่างนี้สามารถใช้ได้เฉพาะในกรอบการค้นหานี้เท่านั้น

Filters

ค้นหาข้อมูลแบบเจาะจงได้โดยการใส่ตัวแปรด้านล่างใน filters

Key Description
amount Transfer amount in smallest unit of transfer currency.
created UTC datetime of transfer creation in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).
currency Currency for transfer as three-letter ISO 4217 code.
fee Omise transfer fee.
paid Whether transfer was paid.
paid_at UTC datetime of the transfer payment in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).
sent Whether transfer was sent.
sent_at UTC datetime of the transfer send event in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

Queries

ค้นหาค่าของตัวแปรได้โดยระบุใน query string

Key Description
id The transfer identifier matching /trsf(_test)?_[0-9a-z]+/.
bank_name Bank account holder name. For Japanese bank accounts, see notes on entering bank account holder names.
bank_brand Bank account brand (Thailand and Singapore only).
failure_code Failure code for transfer. One of insufficient_balance, invalid_recipient, transfers_suspended, transfer_deleted, transfer_sent, or transfer_failed.
failure_message Message describing the failure if failure_code exists.
metadata Custom metadata (e.g. {"answer": 42}) for transfer.
recipient_email Recipient email address.
recipient_id Recipient identifier to which the transfer was sent.
recipient_name Name of recipient to which transfer was sent.
transaction_id The transaction identifier matching /trxn(_test)?_[0-9a-z]+/.

transfer_schedule

ใช้ scope=transfer_schedule เพื่อค้นหา transfer schedule Query และ filter ด้านล่างนี้สามารถใช้ได้เฉพาะในกรอบการค้นหานี้เท่านั้น

Filters

ค้นหาข้อมูลแบบเจาะจงได้โดยการใส่ตัวแปรด้านล่างใน filters

Key Description
status One of:
  • active: The schedule is running.
  • expiring: The schedule's next occurrence is its last.
  • expired: The schedule has reached its last occurrence and is not running anymore.
  • deleted: The schedule has been deleted and is not running anymore.
  • suspended: The schedule could not be completed and was stopped.
.
active Whether scheduled transfer is active or not. Includes schedules where status==active or status==expiring
created UTC datetime of schedule creation in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

Queries

ค้นหาค่าของตัวแปรได้โดยระบุใน query string

Key Description
recurrence_id The schedule identifier matching /schd(_test)?_[0-9a-z]+/.
recipient_name Name of recipient of scheduled transfer.

transaction

ใช้ scope=transaction เพื่อค้นหา transaction Query และ filter ด้านล่างนี้สามารถใช้ได้เฉพาะในกรอบการค้นหานี้เท่านั้น

Filters

ค้นหาข้อมูลแบบเจาะจงได้โดยการใส่ตัวแปรด้านล่างใน filters

Key Description
amount Transaction amount in smallest unit of transaction currency.
created UTC datetime of transaction creation in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).
currency Currency for transaction as three-letter ISO 4217 code.
hold_until UTC datetime of when transaction amount becomes part of available balance in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ) (also searchable as transferable_at)
kind Kind of transaction. One of balance_lost, balance_recovered, charge_captured, charge_captured_platform_fee, dispute_started, dispute_won, dispute_overturned_loss, dispute_overturned_win, invoice_paid, receipt_adjusted, refund_paid, refund_processed, refund_voided, transfer_failed, transfer_sent, transfer_waived.

Queries

ค้นหาค่าของตัวแปรได้โดยระบุใน query string

Key Description
id The transaction identifier matching /trxn(_test)?_[0-9a-z]+/.
record_id Origin for transaction. One of charge identifier, refund identifier, transfer identifier, dispute identifier, or receipt identifier.
เว็ปไซต์นี้มีการใช้คุกกี้เพื่อวิเคราะห์การใช้และปรับการใช้งานให้เหมาะกับท่าน เมื่อกดยอมรับหรือยังคงเข้าชมเว็บไซต์ต่อ เราถือว่าท่านยินยอมในการใช้งานคุกกี้ของเว็บไซต์ อ่านนโยบายความเป็นส่วนตัว