CheckoutCreate
POSThttps://api.twisto.cz/psp/v4/checkouts
POSThttps://api.twisto.pl/psp/v4/checkouts
Create a checkout - customer is then redirected to our gateway to finish the order
Security: Bearer Auth
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: Authorization: Bearer 123
Request body
- type: stringAllowed values:
standard
pay-in-three
Default:standard
- config: object
- redirect_uri: stringrequired
<= 1000 characters
- 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: stringrequired
- 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>requiredMatch pattern:
^-?\d{0,8}(?:\.\d{0,2})?$
- currency: stringrequired
ISO-4217 currency code
>= 3 characters
<= 3 characters
- items: array[object]
- name: stringrequired
<= 255 characters
- amount: string<decimal>requiredMatch pattern:
^-?\d{0,8}(?:\.\d{0,2})?$
- quantity: integerrequired
>= 1
- reference: string
<= 200 characters
- type: stringrequiredAllowed values:
sku
tax
shipping
discount
store_credit
- merchant_reference: stringrequired
Request Body example
{
"type": "pay-in-three",
"config": {
"redirect_uri": "string"
},
"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": 798,
"sales_total_amount": "string",
"sales_avg_amount": "string",
"sales_max_amount": "string",
"refunds_total_amount": "string",
"currency": "str",
"has_previous_purchases": true,
"previous_chargeback": true,
"fraud_check_result": "string"
},
"personal_id": "string",
"email": "string"
},
"order": {
"reference": "string",
"amount": "241.00",
"currency": "str",
"items": [
{
"name": "string",
"amount": "951.00",
"quantity": 180,
"reference": "string",
"type": "shipping"
}
]
},
"merchant_reference": "string"
}
Responses
Body
- id: stringrequired
- uri: stringrequired
- type: stringAllowed values:
standard
pay-in-three
Default:standard
- config: object
- redirect_uri: stringrequired
<= 1000 characters
- created: string<date-time>required
- settled: string<date-time>
- state: stringrequiredAllowed values:
created
approved
completed
cancelled
error
- 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: stringrequired
- 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>requiredMatch pattern:
^-?\d{0,8}(?:\.\d{0,2})?$
- currency: stringrequired
ISO-4217 currency code
>= 3 characters
<= 3 characters
- items: array[object]
- name: stringrequired
<= 255 characters
- amount: string<decimal>requiredMatch pattern:
^-?\d{0,8}(?:\.\d{0,2})?$
- quantity: integerrequired
>= 1
- reference: string
<= 200 characters
- type: stringrequiredAllowed values:
sku
tax
shipping
discount
store_credit
- merchant_reference: stringrequired
Response example
{
"id": "string",
"uri": "string",
"type": "standard",
"config": {
"redirect_uri": "string"
},
"created": "string",
"settled": "string",
"state": "cancelled",
"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": 255,
"sales_total_amount": "string",
"sales_avg_amount": "string",
"sales_max_amount": "string",
"refunds_total_amount": "string",
"currency": "str",
"has_previous_purchases": false,
"previous_chargeback": true,
"fraud_check_result": "string"
},
"personal_id": "string",
"email": "string"
},
"order": {
"reference": "string",
"amount": "487.00",
"currency": "str",
"items": [
{
"name": "string",
"amount": "251.00",
"quantity": 55,
"reference": "string",
"type": "discount"
}
]
},
"merchant_reference": "string"
}