Skip to main content
GET
/
payments
/
{id}
/
refunds
Get refunds
curl --request GET \
  --url https://sandbox.hellgate.io/payments/{id}/refunds \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 1,
      "currency_code": "<string>",
      "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reference": "<string>",
      "status": "processing",
      "created_at": "2023-11-07T05:31:56Z",
      "failure_details": [
        {
          "classifier": "<string>",
          "message": "<string>",
          "source": "processor"
        }
      ],
      "splits": [
        {
          "type": "<string>",
          "merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "amount": 123,
          "reference": "<string>"
        }
      ],
      "metadata": {
        "my_key_one": "my_value_one",
        "my_key_two": "my_value_two"
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "page_size": 1,
    "total_items": 1,
    "total_pages": 1
  }
}

Documentation Index

Fetch the complete documentation index at: https://developer.hellgate.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
id
string<uuid>
required

The ID of the payment on Commerce.

Response

Success response

​
data
object[]
​
pagination
object

The meta-data describing lists of data from the Commerce API. The pages are indexed from 1 up to the total_pages.

Example:
{
  "current_page": 1,
  "page_size": 1,
  "total_items": 1,
  "total_pages": 1
}