orderList
Get orders list.
Security: Token Auth
Provide your auth token in the Authorization header when making requests to protected resources.
Example: Authorization: Token 123
Query Parameters
Param name | Type | Description | Required | Default values | Min/Max values |
---|---|---|---|---|---|
cursor | string | The pagination cursor value. | false | ||
datetime_from | string | Start datetime (inclusive) | false | ||
datetime_to | string | End datetime (inclusive) | false | ||
page_size | integer | Number of results to return per page. | false |
Responses
Body
- next: string or null
Full URL to the next page
- previous: string or null
Full URL to the previous page
- results: array[object]
- id: string<uuid>required
Identifier
- external_id: stringrequired
External order ID provided by Partner.
<= 255 characters
- redirect_url: stringrequired
A URL address to redirect to after the order request is processed
- initial_amount: string<decimal>required
Original value of order
Match pattern:^-?\d{0,8}(?:\.\d{0,2})?$
- current_amount: string<decimal>required
Current value of order after refunds
Match pattern:^-?\d{0,8}(?:\.\d{0,2})?$
- refund_amount: string<decimal>required
How much was refunded
Match pattern:^-?\d{0,8}(?:\.\d{0,2})?$
- date_settled: string<date-time>required
When was the original order processed
- status: stringrequired
Order status
Allowed values:new
data_completed
checking
rejected
accepted
canceled
activated
refunded
error
- service: stringrequired
Type of utilized payment service
Allowed values:twisto-pay
pay-in-three
- next_cursor: string or null
GET parameter to pass to the API endpoint to get the next page - e.g. 'cursor=cD0yMDIzLTA2LTA3KzA2JTNBNTMlM0E1OC4zMjIzNjUlMkIwMCUzQTAw'
- previous_cursor: string or null
GET parameter to pass to the API endpoint to get the previous page - e.g. 'cursor=cD0yMDIzLTA2LTA3KzA2JTNBNTMlM0E1OC4zMjIzNjUlMkIwMCUzQTAw'
Response example
{
"next": "string",
"previous": "string",
"results": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"external_id": "string",
"redirect_url": "string",
"initial_amount": "239.00",
"current_amount": "485.00",
"refund_amount": "178.00",
"date_settled": "string",
"status": "canceled",
"service": "twisto-pay"
}
],
"next_cursor": "string",
"previous_cursor": "string"
}