Search API

Attribute

Name Type Description
object string

The string search.

location string

Path to retrieve a search.

scope string

Searching scope which was sent to the request.

query string

Searching text which was sent to the request.

filters Json

Searching text with specific key which was sent to the request.

page integer

"(optional, default: 1) Specific page number sent to the request.

total_pages integer

Total pages from search result.

data Array

Searching result.

Retrieve a search data

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

Returns a list of search results.

Request Parameter

Name Type Description
order string

(optional, default: chronological) The order of the list returned. I.e.: chronological (from earliest to latest), reverse_chronological (from latest to earliest).

scope string

A scope you are searching for I.e. charge, dispute, recipient, customer, refund, transfer, and link.

query string

Searching text within the scope. see more in availble search fields.

filters string

Searching text with specific key within the scope, see more in list of filter keys.

page integer

"(optional, default: 1) Specific number of searching page.

Example

  • Retrieve a search with query and filters