batchEntryList

GEThttps://api.twisto.pl/psp/v2/batch/{batchUuid}/entry/

Get a list of batch entries.

Security: Token Auth

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

Path Parameters

Param name	Type	Description	Required	Default values	Min/Max values
batchUuid	`string`	Batch identifier	true

Query Parameters

Param name	Type	Description	Required	Default values	Min/Max values
cursor	`string`	The pagination cursor value.	false
page_size	`integer`	Number of results to return per page.	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
  Identifier
- type: string
  required
  Type of batch entry: any of "order" or "refund"
  
  Allowed values: order refund
- destination_account_number: string or null
  required
  Destination bank account number
- payment_identifier: string or null
  required
  Payment identifier used in relevant batches
- order_id: string<uuid>
  required
  Order's ID used by the Twisto API
- order_external_id: string
  required
  Order's ID provided by the PSP
- order_refund_id: string<uuid>
  required
  Refund's ID used by the Twisto API
- order_refund_external_id: string or null
  required
  Refund's ID provided by the PSP
- eshop_id: integer
  required
  E-shop's ID used by the Twisto API
- eshop_external_id: string
  required
  E-shop's ID provided by the PSP
- date_created: string<date-time>
  required
  When was the entry created
- amount: string<decimal>
  required
  The current value of order minus refunds
  
  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",
      "type": "refund",
      "destination_account_number": "string",
      "payment_identifier": "string",
      "order_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "order_external_id": "string",
      "order_refund_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "order_refund_external_id": "string",
      "eshop_id": 462,
      "eshop_external_id": "string",
      "date_created": "string",
      "amount": "780.00"
    }
  ],
  "next_cursor": "string",
  "previous_cursor": "string"
}