CheckoutList

GEThttps://api.twisto.cz/psp/v4/checkouts

GEThttps://api.twisto.pl/psp/v4/checkouts

Get a list of checkouts.

Security: Bearer Auth

Provide your bearer token in the Authorization header when making requests to protected resources.
Example: Authorization: Bearer 123

Query Parameters

Param name	Type	Description	Required	Default values	Min/Max values
dateFrom	`string`	Date limit from when checkout was created	false
dateTo	`string`	Date limit to when checkout was created	false
limit	`integer`	Records limit	false	`200`	`11000`
skip	`integer`	Skip number of records	false		`0`

Responses

Body

count: integer
Example 123
next: string<uri> or null
Example http://api.example.org/accounts/?skip=400&limit=100
previous: string<uri> or null
Example http://api.example.org/accounts/?skip=200&limit=100
items: array[object]
- id: string
  required
- uri: string
  required
- type: string
  Allowed values: standard pay-in-three
  Default: standard
- config: object
  - redirect_uri: string
    required
    <= 1000 characters
- created: string<date-time>
  required
- settled: string<date-time>
- state: string
  required
  Allowed values: created approved completed cancelled error
- deduct_margin: boolean
  required
  Indicates whether margin has already been deducted in the values shown. True means the margin deduction is applied; False means it is not.
- margin_amount: string<decimal>
  required
  Absolute amount of margin deducted for this order (0 if not applicable).
  
  Match pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
- shopper: object
  - first_name: string or null
    <= 40 characters
  - middle_name: string or null
    <= 40 characters
  - last_name: string or null
    Last name, first last name for ES
    
    <= 40 characters
  - last_name2: string or null
    Second last name, ES only
    
    <= 40 characters
  - phone: string or null
    <= 20 characters
  - birth_date: string<date> or null
  - billing_address: object or null
  - statistics: object or null
  - personal_id: string or null
    Unique personal identifier
    
    <= 11 characters
  - email: string
    required
- order: object
  - reference: string
    The reference for this checkout, used in settlement (unique payment reference in your store, random if not specified)
    
    <= 200 characters
  - amount: string<decimal>
    required
    Match pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
  - currency: string
    required
    ISO-4217 currency code
    
    >= 3 characters <= 3 characters
  - items: array[object]
    - name: string
      required
      <= 255 characters
    - amount: string<decimal>
      required
      Match pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
    - quantity: integer
      required
      >= 1
    - reference: string
      <= 200 characters
    - type: string
      required
      Allowed values: sku tax shipping discount store_credit
- merchant_reference: string
  required

Response example

{
  "count": 123,
  "next": "http://api.example.org/accounts/?skip=400&limit=100",
  "previous": "http://api.example.org/accounts/?skip=200&limit=100",
  "items": [
    {
      "id": "string",
      "uri": "string",
      "type": "standard",
      "config": {
        "redirect_uri": "string"
      },
      "created": "string",
      "settled": "string",
      "state": "completed",
      "deduct_margin": true,
      "margin_amount": "46.00",
      "shopper": {
        "first_name": "string",
        "middle_name": "string",
        "last_name": "string",
        "last_name2": "string",
        "phone": "string",
        "birth_date": "2022-12-31",
        "billing_address": {
          "line1": "string",
          "line2": "string",
          "city": "string",
          "state": "string",
          "postal_code": "string",
          "country": "st"
        },
        "statistics": {
          "account_created": "string",
          "last_login": "string",
          "sales_total_count": 350,
          "sales_total_amount": "string",
          "sales_avg_amount": "string",
          "sales_max_amount": "string",
          "refunds_total_amount": "string",
          "currency": "str",
          "has_previous_purchases": true,
          "previous_chargeback": false,
          "fraud_check_result": "string"
        },
        "personal_id": "string",
        "email": "string"
      },
      "order": {
        "reference": "string",
        "amount": "600.00",
        "currency": "str",
        "items": [
          {
            "name": "string",
            "amount": "552.00",
            "quantity": 368,
            "reference": "string",
            "type": "tax"
          }
        ]
      },
      "merchant_reference": "string"
    }
  ]
}