List checkouts

Lists created checkout resources according to the applied checkout_reference.

Query Parameters

• checkout_reference string

  Filters the list of checkout resources by the unique ID of the checkout.

Responses

• 200
• 401

---

OK

application/json

• Schema
• Example (from schema)

---

Schema array

• allOf

[
  {
    "checkout_reference": "string",
    "amount": 0,
    "currency": "BGN",
    "pay_to_email": "[email protected]",
    "merchant_code": "string",
    "description": "string",
    "return_url": "string",
    "id": "string",
    "status": "PENDING",
    "date": "2023-05-24",
    "valid_until": "2023-05-24",
    "customer_id": "string",
    "mandate": {
      "type": "string",
      "status": "string",
      "merchant_code": "string"
    },
    "transactions": [
      {
        "id": "string",
        "transaction_code": "string",
        "amount": 0,
        "currency": "BGN",
        "timestamp": "2023-05-24",
        "status": "SUCCESSFUL",
        "payment_type": "ECOM",
        "installments_count": 0,
        "merchant_code": "string",
        "vat_amount": 0,
        "tip_amount": 0,
        "entry_mode": "CUSTOMER_ENTRY",
        "auth_code": "string",
        "internal_id": 0
      }
    ],
    "transaction_code": "string",
    "transaction_id": "string",
    "merchant_name": "string",
    "redirect_url": "string",
    "payment_instrument": {
      "token": "string"
    }
  }
]

Unauthorized

application/json

• Schema
• Example (from schema)
• Invalid_ Token
• Not_ Authorized_ Token
• Missing_ Token

---

Schema

• message string

  Short description of the error.

• error_code string

  Platform code for the error.

{
  "message": "string",
  "error_code": "string"
}

{
  "error_message": "invalid access token",
  "error_code": "NOT_AUTHORIZED"
}

{
  "error_message": "NOT_AUTHORIZED",
  "error_code": "NOT_AUTHORIZED"
}

{
  "message": "access token required",
  "error_code": "NOT_AUTHORIZED"
}