orderRefund

POSThttps://api.twisto.pl/psp/v2/order/{orderUuid}/refund/

Refund order.

Order can only be refunded if the order status is "activated".
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
orderUuid	`string`	Order identifier	true

Request body

amount: string<decimal>
required
How much money is to be refunded?

Match pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
destination_account_number: string
required
Target account number for refund transaction

<= 34 characters
payment_identifier: string
required
Unique payment identifier used to distinguish returns in the batch settlement

<= 140 characters
external_id: string
required
External ID provided by the PSP

<= 255 characters

Request Body example

{
  "amount": "292.00",
  "destination_account_number": "string",
  "payment_identifier": "string",
  "external_id": "string"
}

Responses

Body

id: string<uuid>
required
Identifier
external_id: string
required
External order ID provided by Partner.

<= 255 characters
redirect_url: string
required
A URL address to redirect to after the order request is processed
initial_amount: string<decimal>
required
Original value of order

Match pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
current_amount: string<decimal>
required
Current value of order after refunds

Match pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
refund_amount: string<decimal>
required
How much was refunded

Match pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
date_settled: string<date-time>
required
When was the original order processed
status: string
required
Order status

Allowed values: new data_completed checking rejected accepted canceled activated refunded error
service: string
required
Type of utilized payment service

Allowed values: twisto-pay pay-in-three

Response example

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "external_id": "string",
  "redirect_url": "string",
  "initial_amount": "649.00",
  "current_amount": "109.00",
  "refund_amount": "729.00",
  "date_settled": "string",
  "status": "canceled",
  "service": "twisto-pay"
}