APG PayAPG Paydocs

Reference data

Get bin group

GET/bin-groups/{binGroupId}
Request
GEThttps://api.tst.au.apgpay.dev/bin-groups/{binGroupId}
curl -X GET https://api.tst.au.apgpay.dev/bin-groups/{binGroupId} \
  -H "Authorization: Bearer $API_KEY"

Read one BIN group with its ranges.

Permissions

Required permission
referenceData:query

Requires the `query` action on `referenceData` for the supplied runtime context

Path parameters

binGroupIdstring
required

Responses

The response is a tagged shape: type is always "BingViewAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.

Discriminated by type
type = "BingViewAttributes"
binGroupIdBingIdrequired

Identifier of a BIN group.

Example bing_9f2Kd8QpLzXw

titlestringrequired

What the group is, in words.

createdAtstring (date-time)required

Example 2026-08-19T04:21:07Z

updatedAtstring (date-time)required

Example 2026-08-19T04:21:07Z

Example
{
  "type": "BingViewAttributes",
  "binGroupId": "bing_9f2Kd8QpLzXw",
  "title": "string",
  "ranges": [
    {
      "type": "BingRangeAttributes",
      "from": 1250,
      "to": 1250,
      "title": "string"
    }
  ],
  "createdAt": "2026-08-19T04:21:07Z",
  "updatedAt": "2026-08-19T04:21:07Z"
}

Error responses