ChargeRetrieve
GEThttps://api.twisto.cz/psp/v4/charges/{chargeId}
GEThttps://api.twisto.pl/psp/v4/charges/{chargeId}
Get a charge 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 |
---|---|---|---|---|---|
chargeId | string | true |
Responses
Body
- id: stringrequired
External ID of the charge
- reference: string
Order payment reference
- amount: string<decimal>required
Total amount
Match pattern:^-?\d{0,8}(?:\.\d{0,2})?$
- currency: stringrequired
ISO-4217 currency code
>= 3 characters
<= 3 characters
- captured_amount: string<decimal>required
Captured amount
Match pattern:^-?\d{0,8}(?:\.\d{0,2})?$
- refunded_amount: string<decimal>required
Refunded amount
Match pattern:^-?\d{0,8}(?:\.\d{0,2})?$
- created_date: string<date-time>required
Date when the order was created
- receipt_number: stringrequired
Invoice external ID
- product: stringrequired
Type of service
Allowed values:Twisto
Pay in three
- state: stringrequiredAllowed values:
rejected
authorised
captured
cancelled
refunded
error
Response example
{
"id": "string",
"reference": "string",
"amount": "513.00",
"currency": "str",
"captured_amount": "792.00",
"refunded_amount": "725.00",
"created_date": "string",
"receipt_number": "string",
"product": "Pay in three",
"state": "rejected"
}