Sign in
Refunds

Create a refund

Creates a new refund.

post/refunds

Request body

orderIdstring required

The ID of the order.

amountstring required

Amount to be refunded.

notestring

Seller's note to buyer about the refund.

Response

OK

idstring

The ID of the refund.

type'full' | 'partial'

The type of the refund.

status'pending' | 'failed' | 'succeeded'

Current status of the refund.

orderIdstring

The order ID related with the refund.

dateCreatedstring

The date and time for the creation of the refund request. yyyy-MM-ddTHH:mm:ssZ format is used (e.g., 2022-07-21T13:24:51+0300).

dateRefundedstring

The date and time for the actual refund transaction submitted to the payment provider. yyyy-MM-ddTHH:mm:ssZ format is used (e.g., 2022-07-21T13:24:51+0300).

currency'TRY' | 'USD' | 'EUR'

Currency of the refund.

totalstring

Total amount of the refund.

notestring

Seller's note to buyer about the refund.

Changes

No recorded changes to this endpoint across all 1 revision of this API.