GET /v2/checkout/count

Servers

Query parameters

Name Type Required Description
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.

CriteriaDescriptionOperator Used
amountnumber==, !=, =in=, =out=, =gt=, =ge=, =lt=, =le=
created_atdate==, !=, =in=, =out=, =gt=, =ge=, =lt=, =le=
currency_codestring==, !=, =in=, =out=, =regex=
customerstring==, !=, =in=, =out=, =regex=
idstring==, !=, =in=, =out=, =regex=
merchant_referencestring==, !=, =in=, =out=, =regex=
entity_idstring==, !=, =in=, =out=, =regex=
updated_atdate==, !=, =in=, =out=, =gt=, =ge=, =lt=, =le=
expiry_timedate==, !=, =in=, =out=, =gt=, =ge=, =lt=, =le=
statusstring==, !=, =in=, =out=, =regex=
notification_methods.email.email_addressstring==, !=, =in=, =out=, =regex=
configurations.card.token_details.reuse_tokenstring==, !=, =in=, =out=, =regex=
payment_method_usedstring==, !=, =in=, =out=, =regex=
interaction_typestring==, !=, =in=, =out=, =regex=
theme_idstring==, !=, =in=, =out=, =regex=
transaction_idstring==, !=, =in=, =out=, =regex=
created_bystring==, !=, =in=, =out=, =regex=

Note:

OperatorDescription
==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: Parenthesis can be used to determine the precedence of the operator.

Example for count checkout:

  • /v2/checkout/count?search=
    entity_id==a6b45428-0296-4394-8ddd-0b50b5b20aa9&
    amount==324

  • /v2/checkout/count?search=
    entity_id==a6b45428-0296-4394-8ddd-0b50b5b20aa9&
    status==COMPLETED

  • /v2/checkout/count?search=
    entity_id==a6b45428-0296-4394-8ddd-0b50b5b20aa9&
    amount=in=(100,200)

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.