APG PayAPG Paydocs

Merchants

Update merchants

PATCH/merchants

Advance every merchant with outstanding gateway onboarding. Test environments only, a 400 in production.

Permissions

Required permission
merchants:verify

Requires the `verify` action on `merchants` for the supplied runtime context

Request body

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

Discriminated by type
type = "MchtCollectionUpdateProcessOnboarding"

This variant has no additional fields.

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

Responses

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

Discriminated by type
type = "MchtOnboardingSweepAttributes"
startedbooleanrequired

Always true. Present because a response body that carries nothing cannot gain a field without a breaking change, and a sweep that learns to report counts should not need a new shape.

Example true

Example
{
  "type": "MchtOnboardingSweepAttributes",
  "started": true
}

Error responses