List transactions - Hellgate Cloud Platform

GET

refunds

{id}

transactions

List transactions

curl --request GET \
  --url https://sandbox.hellgate.io/refunds/{id}/transactions \
  --header 'X-API-Key: <api-key>'

{
  "data": [
    {
      "id": "54ba1fdb-7e4e-402b-aebb-66f9d5345cf8",
      "type": "refund",
      "status": "succeeded",
      "started_at": "2021-01-01T00:00:00Z",
      "finished_at": "2021-01-01T00:00:00Z",
      "processor": {
        "name": "Starfish Bank",
        "transaction_id": "ch_1H9zvz2eZvKYlo2C5J1J9zvz",
        "merchant_id": "acct_1H9zvz2eZvKYlo2C",
        "network_transaction_reference": "1234567890"
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "page_size": 50,
    "total_items": 1,
    "total_pages": 1
  }
}

Authorizations

X-API-Key

string

header

required

Path Parameters

string<uuid>

required

The ID of the refund on Commerce.

Query Parameters

limit

integer

default:50

The desired amount of records per page.

Required range: 0 <= x <= 500

page

integer

The desired number of the page to return.

Required range: x >= 0

Response

Success response

data

object[]

Show child attributes

pagination

object

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

Show child attributes

Example:

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

Payment notificationThe notification is used to inform a listener about changes to a payment. The listener must respond with an HTTP status code 200 to acknowledge and accept the notification. If a different status code is returned, Commerce will attempt to resend the notification, following a retry policy until the notification is successfully acknowledged or the maximum retry limit is reached.

⌘I

List transactions

curl --request GET \
  --url https://sandbox.hellgate.io/refunds/{id}/transactions \
  --header 'X-API-Key: <api-key>'

{
  "data": [
    {
      "id": "54ba1fdb-7e4e-402b-aebb-66f9d5345cf8",
      "type": "refund",
      "status": "succeeded",
      "started_at": "2021-01-01T00:00:00Z",
      "finished_at": "2021-01-01T00:00:00Z",
      "processor": {
        "name": "Starfish Bank",
        "transaction_id": "ch_1H9zvz2eZvKYlo2C5J1J9zvz",
        "merchant_id": "acct_1H9zvz2eZvKYlo2C",
        "network_transaction_reference": "1234567890"
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "page_size": 50,
    "total_items": 1,
    "total_pages": 1
  }
}