APG PayAPG Paydocs

Customers

Create delegates

POST/delegates

Add a delegate, ask a customer's delegates to approve a new one, or approve one by its emailed link. Selected by the body's type.

3 actionsCustdCmdApproveAdditionCustdCmdRequestAdditionCustdCmdUpsert

Permissions

Required permission

Required action depends on the request variant. Select a variant in the request body below to see the permission it requires.

Request body

This body is a typed union. Pick a variant to see its fields, the permission it requires, and a matching example.

Discriminated by type
type = "CustdCmdApproveAddition"
Required permission
Anchored to the presented token

Approve an addition by its emailed link

This variant has no additional fields.

curl -X POST https://api.tst.au.apgpay.dev/delegates \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "CustdCmdApproveAddition"
}'

Responses

The response is a typed union.

Discriminated by type
type = "CustdCreateRspApprovalRequested"

One per delegate asked. The link is emailed to them; it appears here only outside production.

Example
{
  "type": "CustdCreateRspApprovalRequested",
  "approvals": [
    {
      "type": "CustdApprovalAttributes",
      "magicLink": "string",
      "token": "tok_9f2Kd8QpLzXwR4mN"
    }
  ]
}

Error responses