batchRetrieve

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

Get a batch by its identifier.

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

Responses

Body

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})?$

Response example

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "settlement_date": "2022-12-31",
  "amount": "827.00",
  "order_amount": "227.00",
  "refund_amount": "90.00",
  "status": "exported",
  "deduct_margin": true,
  "margin_amount": "646.00"
}