Consumer Level Lending
post

/utils/search

Search through checkout data to find relevant information.

Authorization

apiKey - Authorization

Request Body

Paging

This endpoint will produce up to 50 checkouts per one page, to access the next page perform the request by providing page parameter with the nextPage parameter received in the response, or provide previousPage to acquire previous page.

Parameters

sort=date orders the results by checkout creation date, this is used as the default sort.

sort=balance orders the results by itinerary amount.

sort=reference orders the results by your merchant reference.

order consumes asc or desc, the deault value is asc.

search.checkout.token consumes one checkout token provided to you by this API, either full or partial token is accepted.

search.checkout.reference consumes one merchant reference provided by you to this API at the point of checkout creation, either full or partial reference is accepted.

search.checkout.metaData consumes a one dimensional object with a key and a value check examples below.

search.checkout.date.from filter results by flight itinerary where departure date of a flight is equal or higher than provided (Accepts YYYY-MM-DD).

search.checkout.date.to filter results by flight itinerary where arrival date of a flight is equal or lower than provided (Accepts YYYY-MM-DD)

search.hotel.name search by name used in the hotel itinerary, either full or partial name is accepted.

search.checkout.jurisdiction search checkouts by country code.

search.checkout.currency search checkouts by currency code.

search.checkout.reference consumes one reference provided by you to this API, either full or partial reference is accepted.

search.applicant.email search by customer email address used within the application.

search.applicant.name search by customer full name used within the application, either full or partial reference is accepted.

search.balance.from search checkouts by itinerary balance equal or higher than provided, accepts finance type only.

search.balance.to search checkouts by itinerary balance equal or smaller than provided, accepts finance type only.

search.flight.number search by flight number used within the flight itinerary.

search.flight.airport search by airport IATA code used within the flight itinerary.

search.flight.country search by country code used within the flight itinerary.

search.flight.date.from filter results by flight itinerary where departure date of a flight is equal or higher than provided (Accepts YYYY-MM-DD).

search.flight.date.to filter results by flight itinerary where arrival date of a flight is equal or lower than provided (Accepts YYYY-MM-DD)search.hotel.name search by name used in the hotel itinerary, either full or partial name is accepted.

search.hotel.country search by country code used in the hotel itinerary.

search.hotel.date.from filter results by hotel itinerary where check-in date is equal or higher than provided (Accepts YYYY-MM-DD).

search.hotel.date.to filter results by hotel itinerary where check-out date is equal or lower than provided (Accepts YYYY-MM-DD).

search.rent.name search by name used in the rental itinerary, either full or partial name is accepted.

search.rent.country search by country code used in the rental itinerary.

search.rent.date.from filter results by rental itinerary where period start date is equal or higher than provided (Accepts YYYY-MM-DD).

search.rent.date.to filter results by rental itinerary where period end date is equal or lower than provided (Accepts YYYY-MM-DD).

1 Example
Schema
object
page
integer
sort
string
1 validation
order
string
1 validation
search
object

Responses

Parameters

page.previous provides the page number to use in order to load the previous page.

page.next provides the page number to use in order to load the next page.

page.total provides the number of pages this form of results has

meta.count.total shows the total count of checkouts your merchant user has.

meta.count.results shows the total count matched using the filters provided.

meta.sort shows the sort key used.

meta.order shows the order in which the sorting occured (asc|desc).

results array of results

Schema
object
page
object
meta
object
results
array[object]

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
Authorization