BatchList
GEThttps://api.twisto.cz/psp/v4/batch
GEThttps://api.twisto.pl/psp/v4/batch
Get a list of batches.
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 |
---|---|---|---|---|---|
limit | integer | Records limit | false | 200 | 1 1000 |
reference | string | Payment identifier used in relevant batches | false | ||
settlement_date | string | Date when batch was processed | false | ||
skip | integer | Skip number of records | false | 0 |
Responses
Body
- count: integerExample
123
- next: string<uri> or nullExample
http://api.example.org/accounts/?skip=400&limit=100
- previous: string<uri> or nullExample
http://api.example.org/accounts/?skip=200&limit=100
- items: array[object]
- id: string<uuid>required
- state: stringrequired
"exported"
once funds transfer initiated,"paid"
once funds transfer confirmedAllowed values:exported
paid
- settlement_date: string<date>required
Date when batch was processed/created
- amount: string<decimal>required
The current value of order minus refunds
Match pattern:^-?\d{0,8}(?:\.\d{0,2})?$
- order_amount: string<decimal>required
The value of the whole order
Match pattern:^-?\d{0,8}(?:\.\d{0,2})?$
- refund_amount: string<decimal>required
How much was refunded back
Match pattern:^-?\d{0,8}(?:\.\d{0,2})?$
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": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"state": "paid",
"settlement_date": "2022-12-31",
"amount": "859.00",
"order_amount": "648.00",
"refund_amount": "526.00"
}
]
}