v1

latestOpenAPI 3.1.0MIT2026-08-0659118508.8 KB

Refunds

Shows refund details

Required scope: <code style="background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em">refund:read</code>

get/refund/{id}

Path parameters

idstring uuid required

Resource Identification

Response

idstring uuid

A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.

status'success' | 'pending' | 'failed' | 'waiting'

Indicates the current status of the refund. Possible values include:

waiting: The payment instruction has been given, but the chosen payment method requires confirmation from an external entity before the status of the operation is finalized.
pending: This is the initial state, and it means that the refund is queued.
success: The refund has been completed successfully.
failed: The refund could not be completed due to an error or issue.

This field provides a clear indication of the current state of the refund, helping users understand its progress and outcome.

transaction_keystring

Your internal key identifying this refund.

valuenumber double

The monetary amount requested for the transaction. This field is formatted as a double, and will be rounded to two decimal places (e.g., "100.00").

account_holderstring

Bank account holder name.

emailstring

The email address of the account holder. This field is used for communication purposes, including sending notifications about the refund stat.

phonestring

The contact phone number of the account holder, including the country code indicator (e.g., "+351"). This field is used for communication purposes, such as contacting the account holder for verification

ibanstring

The International Bank Account Number of the account to which the refund will be sent. This field is used to uniquely identify the recipient's bank account across international borders.

Example response

{
  "value": 15.98,
  "email": "customer@example.pt",
  "phone": "+351912345678",
  "iban": "PT50007950088428437201551",
  "reward_redemption_reversal": {
    "value": 2.5
  },
  "capture": {
    "splits": [
      {
        "value": 8.65,
        "clearing_period": "1W",
        "margin_value": 1.25,
        "reward": {
          "value": 1,
          "expiration_date": "2027-04-02"
        },
        "reverts": [
          {
            "value": 12.87,
            "margin_value": 1.25
          }
        ]
      }
    ],
    "value": 10.86,
    "reward_redemption": {
      "value": 2.5
    }
  }
}