APG PayAPG Paydocs

Reference data

Replace bin group

PUT/bin-groups/{binGroupId}

Replace a group's title and ranges. Whole, not partial, and it keeps the group's creation date, which a create cannot.

Permissions

Required permission
referenceData:create

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

Path parameters

binGroupIdstring
required

Request body

This body is a tagged shape: type is always "BingReplaceRanges". Send it; more variants can be added, and a caller that switches on it keeps working when they are.

Discriminated by type
type = "BingReplaceRanges"
titlestringrequired
curl -X PUT https://api.tst.au.apgpay.dev/bin-groups/{binGroupId} \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "BingReplaceRanges",
  "title": "string",
  "ranges": [
    {
      "type": "BingRangeAttributes",
      "from": 1250,
      "to": 1250,
      "title": "string"
    }
  ]
}'

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