batchList

GEThttps://api.twisto.pl/psp/v2/batch/

Get a list of batches.

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
cursor	`string`	The pagination cursor value.	false
page_size	`integer`	Number of results to return per page.	false
payment_identifier	`string`	Payment identifier used in relevant batches	false
settlement_date	`string`	Date when batch was processed	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
- settlement_date: string<date>
  required
  Date when batch was processed
- 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})?$
- status: string
  required
  The status of the Batch.
  
  Allowed values: processing ready_for_payment paid exported error
- deduct_margin: boolean or null
  Indicate if is margin deducted
- margin_amount: string<decimal> or null
  required
  Amount of the deducted margin
  
  Match pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
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",
      "settlement_date": "2022-12-31",
      "amount": "211.00",
      "order_amount": "656.00",
      "refund_amount": "785.00",
      "status": "ready_for_payment",
      "deduct_margin": true,
      "margin_amount": "801.00"
    }
  ],
  "next_cursor": "string",
  "previous_cursor": "string"
}