BatchRetrieve

GEThttps://api.twisto.cz/psp/v4/batch/{batchUuid}
GEThttps://api.twisto.pl/psp/v4/batch/{batchUuid}

Get a batch by its identifier.

Security: Bearer Auth

Provide your bearer token in the Authorization header when making requests to protected resources.
Example: Authorization: Bearer 123

Path Parameters

Param nameTypeDescriptionRequiredDefault valuesMin/Max values
batchUuidstringBatch identifiertrue

Responses

Body

  • 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

{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "state": "exported", "settlement_date": "2022-12-31", "amount": "885.00", "order_amount": "823.00", "refund_amount": "856.00" }