APG PayAPG Paydocs

Marketplaces

Update marketplace

PATCH/marketplaces/{marketplaceId}

Set up bank transfers, replace the source rules, or set who collects sub-merchant invoice fees. One change per call.

17 actionsMktpUpdateBankTransfersMktpUpdateBrandingMktpUpdateBusinessRegistrationMktpUpdateClearBrandingMktpUpdateClearCustomerDashboardBrandingMktpUpdateClearSourceRulesMktpUpdateClearTagsMktpUpdateContactMktpUpdateCustomerDashboardBrandingMktpUpdateDefaultsMktpUpdateEmailTemplatesMktpUpdatePaymentProfileMktpUpdatePayoutDefaultsMktpUpdateSelfManagedGrossSettlementMktpUpdateSourceRulesMktpUpdateSubMerchantFeesMktpUpdateTags

Permissions

Required permission
marketplaces:update

Requires the `update` action on `marketplaces` for the supplied runtime context

Path parameters

marketplaceIdstring
required

Request body

This body is a typed union. Pick a variant to see its fields and a matching example.

Discriminated by type
type = "MktpUpdateBankTransfers"
payIdDomainstring

The domain half of the PayID to issue, payments.example.com. Omit for the platform's default.

curl -X PATCH https://api.tst.au.apgpay.dev/marketplaces/{marketplaceId} \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "MktpUpdateBankTransfers",
  "payIdDomain": "string"
}'

Responses

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

Discriminated by type
type = "MktpUpdateRspAttributes"

The resource as it stands after the change.

Example
{
  "type": "MktpUpdateRspAttributes",
  "updated": {
    "type": "MktpViewAttributes",
    "marketplaceId": "mktp_9f2Kd8QpLzXw",
    "enterpriseId": "ent_9f2Kd8QpLzXw",
    "slug": "string",
    "businessName": "Ada Lovelace",
    "website": "string",
    "companyEmail": "ada@example.com",
    "companyPhone": "+61400000000",
    "status": "Enabled",
    "merchantDashboardAccess": true,
    "selfManagedGrossSettlement": true,
    "shortenerBaseUri": "https://example.com/callback",
    "zendeskUserGroupId": 1250,
    "bankTransfers": {
      "type": "MktpBankTransfersAttributes",
      "bankAccountBsb": "string",
      "bankAccountNumber": "string",
      "payId": "string"
    },
    "sourceRules": [
      "string"
    ],
    "createdAt": "2026-08-19T04:21:07Z",
    "updatedAt": "2026-08-19T04:21:07Z"
  }
}

Error responses