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 nameTypeDescriptionRequiredDefault valuesMin/Max values
limitintegerRecords limitfalse20011000
referencestringPayment identifier used in relevant batchesfalse
settlement_datestringDate when batch was processedfalse
skipintegerSkip number of recordsfalse0

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<uuid>
      required
    • state: string
      required

      "exported" once funds transfer initiated, "paid" once funds transfer confirmed

      Allowed 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" } ] }