Skip to main content
GET
/
payments
Get payments
curl --request GET \
  --url https://sandbox.hellgate.io/payments \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "54ba1fdb-7e4e-402b-aebb-66f9d5345cf8",
      "amount": {
        "requested": 1000,
        "authorized": 1000
      },
      "created_at": "2023-10-10T00:00:00Z",
      "currency_code": "EUR",
      "flow_matrix_rule": "e-commerce flow",
      "reference": "Order #12345",
      "status": "authorized",
      "source": {
        "type": "card",
        "cardholder_name": "Bob Holder",
        "expiry_month": 12,
        "expiry_year": 2030,
        "masked_account_number": "424242XXXXXX4242",
        "pan_type": "FPAN"
      },
      "use_case": "ONE_OFF"
    }
  ],
  "pagination": {
    "current_page": 1,
    "page_size": 50,
    "total_items": 1,
    "total_pages": 1
  }
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
limit
integer
default:50

The desired amount of records per page.

Required range: 1 <= x <= 500
​
page
integer

The desired number of the page to return.

Required range: x >= 1
​
from
string<YYYY-MM-DD>

Return only payments created from this date.

​
to
string<YYYY-MM-DD>

Return only payments created up to this date.

​
currency_code
string

Return only payments with the specified currencies.

Currencies are in ISO 4217 and use a list formats, e.g.:

  • currency_code=EUR
  • currency_code=EUR,USD
​
status
string

Return only payments with the specified status.

Status are given as a list, e.g.:

  • status=authorized
  • status=authorized,captured.

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
}