GET /v2/checkout

Servers

https://emea.gsc.verifone.cloud/oidc/checkout-service
https://us.gsc.verifone.cloud/oidc/checkout-service
https://nz.gsc.verifone.cloud/oidc/checkout-service
https://cst.test-gsc.vfims.com/oidc/checkout-service
https://uscst-gb.gsc.vficloud.net/oidc/checkout-service

Query parameters

Name Type Required Description

order_criteria

String

The ordering sequence of the selected checkouts If not selected then a default order is based on created Date Time. The value of order_criteria can be one of the following:

amount
currency_code
created_at
updated_at

page_number

Number

A filter query in RSQL format to retrieve customers based on page number. If not selected then a default pageNumber is 1.

search

String

Yes

RSQl Query is composed of one or more expressions, combined to each other with following logical operators:

A filter query in RSQL format to retrieve themes. The returned themes are limited to those that can be retrieved by the user.

Criteria	Description	Operator Used
amount	number	==, !=, =in=, =out=, =gt=, =ge=, =lt=, =le=
created_at	date	==, !=, =in=, =out=, =gt=, =ge=, =lt=, =le=
currency_code	string	==, !=, =in=, =out=, =regex=
customer	string	==, !=, =in=, =out=, =regex=
id	string	==, !=, =in=, =out=, =regex=
merchant_reference	string	==, !=, =in=, =out=, =regex=
entity_id	string	==, !=, =in=, =out=, =regex=
updated_at	date	==, !=, =in=, =out=, =gt=, =ge=, =lt=, =le=
expiry_time	date	==, !=, =in=, =out=, =gt=, =ge=, =lt=, =le=
status	string	==, !=, =in=, =out=, =regex=
notification_methods.email.email_address	string	==, !=, =in=, =out=, =regex=
configurations.card.token_details.reuse_token	string	==, !=, =in=, =out=, =regex=
payment_method_used	string	==, !=, =in=, =out=, =regex=
interaction_type	string	==, !=, =in=, =out=, =regex=
theme_id	string	==, !=, =in=, =out=, =regex=
transaction_id	string	==, !=, =in=, =out=, =regex=
created_by	string	==, !=, =in=, =out=, =regex=

Note:

Operator	Description
==	equal
!=	not equal
=lt=	less than
=le=	less than and equal to
=gt=	greater than
=ge=	greater than and equal to
=regex=	pattern matching
=in=	multiple arguments search
=out=	exclude
;	Logical AND
,	Logical OR

Note: Logical AND ( ; ) has higher precedence than Logical OR ( , ), whereas a parenthesis () can be used to override the precedence of an operator.

Example for list checkout:

/v2/checkout?search=
id==123;
(amount==999,
currency_code==USD);
status==Authorized&
order_by=ASC&
order_criteria=amount&
page_size=1&
page_number=2
/v2/checkout?search=
id==12345,
merchant_reference==1234554321;
amount==3224&
order_by=DESC&
order_criteria=created_at&
page_size=10&
page_number=1
/v2/checkout?search=
amount=in=(100,200);
interaction_type!=PAYMENT_LINK&
order_by=ASC&
order_criteria=currency_code&
page_size=1&
page_number=2

page_size

Number

A filter query in RSQL format to retrieve customers based on page size. If not selected then a default pageSize is 50

order_by

String

The ordering sequence of the selected customers If not selected then Descending order is the default order.

Possible values:

"DESC"
"ASC"

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.