BatchRetrieve
GEThttps://api.twisto.cz/psp/smi/batch/{batchUuid}
GEThttps://api.twisto.pl/psp/smi/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 name | Type | Description | Required | Default values | Min/Max values |
---|---|---|---|---|---|
batchUuid | string | Batch identifier | true |
Responses
Body
- id: string<uuid>required
- state: stringrequired
"exported"
once funds transfer initiated,"paid"
once funds transfer confirmedAllowed 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})?$
- deduct_margin: boolean or null
Indicate if is margin deducted
- margin_amount: string<decimal> or nullrequired
Amount of the deducted margin
Match pattern:^-?\d{0,8}(?:\.\d{0,2})?$
Response example
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"state": "paid",
"settlement_date": "2022-12-31",
"amount": "118.00",
"order_amount": "443.00",
"refund_amount": "15.00",
"deduct_margin": true,
"margin_amount": "87.00"
}