List on-ramp references

All filters are optional and combined. Unlike the other collections, this one pages with pageNumber/pageSize and returns {data, pageNumber, pageSize, count}, where count is the total number of matches.

GET /onramp/references

List on-ramp references

cURL

curl --request GET \
  --url https://api.zeam.money/gw/v1/onramp/references \
  --header 'Authorization: Bearer <token>' \
  --header 'x-zeam-auth: <api-key>'

200

{
  "data": [
    {
      "reference": "<string>",
      "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customerId": "<string>",
      "settlementAccount": "<string>",
      "isActive": true,
      "created": "2023-11-07T05:31:56Z"
    }
  ],
  "pageNumber": 123,
  "pageSize": 123,
  "count": 123
}

Authorizations

Authorization · string · header · required

Access token issued by POST /v1/auth/token.

x-zeam-auth · string · header · required

Application secret (the apiKey issued at registration), required on every request.

Query Parameters

customerId · string

settlementAccount · string

connectorId · string<uuid>

pageNumber · integer · default: 1

Required range: x >= 1

pageSize · integer · default: 20

Required range: 1 <= x <= 100

Response

200

application/json

A page of references.

data · object[]

Show child attributes

pageNumber · integer

pageSize · integer

count · integer