Skip to main content
GET
/
refunds
/
{id}
Get refund details
curl --request GET \
  --url https://sandbox.hellgate.io/refunds/{id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "54ba1fdb-7e4e-402b-aebb-66f9d5345cf8",
  "amount": 1000,
  "currency_code": "EUR",
  "created_at": "2023-10-10T00:00:00Z",
  "payment_id": "cdc60e91-1d1a-4641-8ada-84bdbbe189f5",
  "reference": "Refund order #12345",
  "status": "processing"
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
id
string<uuid>
required

The ID of the refund on Commerce.

Response

Success response

​
id
string<uuid>
required
​
amount
integer
required

The amount given in minor units (e.g. use 700 for 7€). Some currencies do not support minor units (e.g. Japanese Yen). In this case send in the full value, .i.e. 100 for 100 JPY.

Required range: x >= 0
​
currency_code
string
required

The three letter currency code. See: ISO-4217

​
payment_id
string<uuid>
required
​
reference
string
required

A description of the refund for later reference

Maximum string length: 80
​
status
enum<string>
required
Available options:
processing,
completed,
failed
​
created_at
string<date-time>

The date-time the refund was created (following ISO 8601)

​
failure_details
object[]

The reasons why a refund failed during processing in Commerce.

This can be due to processing errors on the side of the processor, as well as errors in the processing of the underlying flow.

In case the failure is due to a processing problem, the transaction history of the payment can give more information on the exact failure details.

​
splits
object[]

An array of split instructions.

Data in this array is only processed on a Commerce account in the platform operating model. If you are in doubt, please reach out to your account representative.

TypeDescription
sellerSending the given amount to the seller referenced by the merchant_id in the payload. The seller needs to be onboarded to the account and linked to the processor in order to receive funds from a payment split.
commissionAn already existing Commerce token can be used as source for the payment.
Minimum array length: 1
​
metadata
object

Metadata consisting of entries, each of which each includes a key and an associated value:

  • Maximum 20 key-value pairs.
  • Maximum 20 characters per key.
  • Maximum 80 characters per value.
Example:
{
  "my_key_one": "my_value_one",
  "my_key_two": "my_value_two"
}