APG PayAPG Paydocs

Reference data

Create bin groups

POST/bin-groups

Create a BIN group. The platform assigns the identifier; a replace is the only way to change one afterwards.

Permissions

Required permission
referenceData:create

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

Request body

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

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

Responses

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

Discriminated by type
type = "BingCreateRspAttributes"

The resource that was created.

Example
{
  "type": "BingCreateRspAttributes",
  "created": {
    "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