Retrieve all checkouts

GET /v2/checkouts

Returns a list of checkout sessions associated with the authenticated merchant. Supports filtering by order, amount, currency, status, creation/expiration date, and sorting options. No request body is required — all filters are passed as query parameters.

Request

HTTP Method: GET Endpoint:

/v2/checkouts

Headers:

Authorization: {tokenType} {access_token}
Content-Type: application/json

Query Parameters

Name
Type
Description

id

string (UUID)

Filter by checkout ID.

orderId

string

Filter by merchant order ID.

status

string

Filter by checkout status (e.g., Created, Completed).

minAmount

number

Minimum checkout amount.

maxAmount

number

Maximum checkout amount.

currency

string

Currency code (ISO 4217).

language

string

Checkout language (e.g., ro, ru, en).

createdAtFrom

string (date-time)

Return records created after this timestamp.

createdAtTo

string (date-time)

Return records created before this timestamp.

expiresAtFrom

string (date-time)

Return records expiring after this timestamp.

expiresAtTo

string (date-time)

Return records expiring before this timestamp.

count

integer

Number of items to return per page.

offset

integer

Pagination offset.

sortBy

string

Field to sort results by (e.g., createdAt, amount).

order

string

Sort direction (asc or desc).

Query example

GET /checkouts?status=Completed&currency=MDL&count=10&offset=0&sortBy=createdAt&order=desc HTTP/1.1

Response

Response Parameters

Name
Type
Description

result

object

Operation result container.

result.items

array<object>

List of checkout sessions.

result.count

integer

Number of items returned.

result.totalCount

integer

Total number of items available.

ok

boolean

Indicates successful request execution.

errors

array

List of validation or processing errors, if any.


result.items[] object

Name
Type
Description

id

string (UUID)

Checkout identifier.

createdAt

string (date-time)

Checkout creation timestamp.

merchantId

string (UUID)

Merchant identifier.

paymentIntentId

string (UUID)

Payment intent identifier.

status

string

Checkout status.

redirectUrl

string (uri)

Redirect URL (if applicable).

amount

number

Total checkout amount.

currency

string

ISO 4217 currency code (e.g., MDL).

order

object

Order summary.

expiresAt

string (date-time)

Expiration timestamp.

paymentMethods

array<object>

Available payment methods for this checkout.

paymentIntent

object

Embedded payment intent (if present).


result.items[].order object

Name
Type
Description

id

string

Order identifier.

description

string

Order description.

amount

number

Order amount.


result.items[].paymentMethods[] object

Name
Type
Description

paymentMethodKey

string

Internal key (e.g., MiaQr, Card).

displayOrder

integer

Display order index.


Example Successful Response

{
  "result": {
    "items": [
      {
        "id": "5d526a22-9354-4721-99da-fa58fb53216e",
        "createdAt": "2024-01-12T01:10:10+03:00",
        "merchantId": "b6d34b50-3713-4ca2-aa6d-e6c14a5c3c25",
        "paymentIntentId": "00000000-0000-0000-0000-000000000000",
        "status": "PaymentMethodSelected",
        "redirectUrl": null,
        "amount": 50.61,
        "currency": "MDL",
        "order": {
          "id": "123",
          "description": "Order description",
          "amount": 50.61
        },
        "expiresAt": "2025-01-12T01:10:10+03:00",
        "paymentMethods": [
          {
            "paymentMethodKey": "MiaQr",
            "displayOrder": 3
          }
        ],
        "paymentIntent": null
      },
      {
        "id": "5d526a22-9354-4721-99da-fa58fb53216e",
        "createdAt": "2024-01-12T01:10:10+03:00",
        "merchantId": "b6d34b50-3713-4ca2-aa6d-e6c14a5c3c25",
        "paymentIntentId": "00000000-0000-0000-0000-000000000000",
        "status": "PaymentMethodSelected",
        "redirectUrl": null,
        "amount": 50.61,
        "currency": "MDL",
        "order": {
          "id": "123",
          "description": "Order description",
          "amount": 50.61
        },
        "expiresAt": "2025-01-12T01:10:10+03:00",
        "paymentMethods": [
          {
            "paymentMethodKey": "MiaQr",
            "displayOrder": 3
          }
        ],
        "paymentIntent": null
      }
    ],
    "count": 2,
    "totalCount": 20
  },
  "ok": true,
  "errors": null
}

Notes

  • merchantId is inferred from authentication and cannot be filtered explicitly.

  • All query parameters are optional; absence returns all checkouts.

  • Pagination is controlled via count and offset.

Last updated