ChargeList
GEThttps://api.twisto.cz/psp/v4/charges
GEThttps://api.twisto.pl/psp/v4/charges
Get list of charges.
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 charge was created | false | ||
dateTo | string | Date limit to when charge was created | false | ||
limit | integer | Records limit | false | 200 | 1 1000 |
skip | integer | Skip number of records | false | 0 | |
state | string | false |
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: stringrequired
External ID of the charge
- reference: string
Order payment reference
- amount: string<decimal>required
Total amount
Match pattern:^-?\d{0,8}(?:\.\d{0,2})?$
- currency: stringrequired
ISO-4217 currency code
>= 3 characters
<= 3 characters
- captured_amount: string<decimal>required
Captured amount
Match pattern:^-?\d{0,8}(?:\.\d{0,2})?$
- refunded_amount: string<decimal>required
Refunded amount
Match pattern:^-?\d{0,8}(?:\.\d{0,2})?$
- created_date: string<date-time>required
Date when the order was created
- receipt_number: stringrequired
Invoice external ID
- product: stringrequired
Type of service
Allowed values:Twisto
Pay in three
- state: stringrequiredAllowed values:
rejected
authorised
captured
cancelled
refunded
error
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",
"reference": "string",
"amount": "812.00",
"currency": "str",
"captured_amount": "646.00",
"refunded_amount": "299.00",
"created_date": "string",
"receipt_number": "string",
"product": "Pay in three",
"state": "captured"
}
]
}