Retrieve refund details

/v2/payments/refunds/{id}

Returns the details of a refund by its identifier (id). This endpoint is used to check the refund processing result, as the standard refund endpoint only creates the refund and returns the initial Created status.

Request

HTTP Method: GET Endpoint: /v2/payments/refunds/{id}

Headers: Authorization: {tokenType} {access_token}

Path Parameters

Parameter
Type
Required
Description

id

string (GUID)

Yes

Unique refund identifier

Request Example

GET /v2/payments/refunds/eaed443e-988f-4b59-89da-e76501977fab
Authorization: Bearer {access_token}

Response Parameters

Parameter
Type
Description

result.id

string (GUID)

Unique refund identifier

result.paymentId

string (GUID)

Identifier of the payment for which the refund was initiated

result.refundType

string

Refund type. It can be full or partial

result.amount

number

Refund amount

result.currency

string

Refund currency

result.refundReason

string

Refund reason

result.executedAt

string (date-time)

Date and time when the refund was created or processed

result.status

string

Current refund status. Possible statuses are listed in the Refund Statuses section

ok

boolean

Indicates whether the request was processed successfully

errors

array / null

List of errors, if any

Response Example (JSON)

Refund Statuses

Status
Description

Created

Refund was successfully created

Requested

Refund request was sent for processing

Accepted

Refund was successfully completed

Rejected

Refund was rejected

Manual

Refund could not be processed automatically; please contact support for manual processing

Last updated