Skip to main content
GET
Retrieves a refund

Authorizations

x-digest-key
string
header
required

Your public API key

Headers

x-digest-timestamp
string
required

Current Unix timestamp

x-digest-key
string
required

Your public api key

x-digest-signature
string
required

Digest Auth Signature

Path Parameters

id
string
required

The ID of the refund to retrieve

Response

On success the endpoint will return a JSON object with detailed refund information.

amount
object
status
string

The status of the refund. Available values are open, failed, refunded

description
string | null

Description of the refund.

settlement_Id
string | null

Settlement ID related to the refund.

metadata
object | null

Additional metadata related to the refund.

refund_id
string | null

Refund identifier.

payment
object