APG PayAPG Paydocs

Marketplaces

Get marketplace

GET/marketplaces/{marketplaceId}
Request
GEThttps://api.tst.au.apgpay.dev/marketplaces/{marketplaceId}
curl -X GET https://api.tst.au.apgpay.dev/marketplaces/{marketplaceId} \
  -H "Authorization: Bearer $API_KEY"

Return one marketplace, with its bank-transfer details and source rules.

Permissions

Required permission
marketplaces:query

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

Path parameters

marketplaceIdstring
required

Responses

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

Discriminated by type
type = "MktpViewAttributes"
marketplaceIdMktpIdrequired

Identifier of a marketplace.

Example mktp_9f2Kd8QpLzXw

enterpriseIdEntIdrequired

Identifier of an enterprise.

Example ent_9f2Kd8QpLzXw

slugstringrequired

The marketplace's short name, used in URLs and dashboards. Unique, and set at creation.

businessNamestringrequired

Example Ada Lovelace

websitestringrequired

The marketplace's public website.

companyEmailstringrequired

Where to contact the marketplace.

Example ada@example.com

companyPhonestringrequired

Phone number in E.164 format.

Example +61400000000

statusMktpStatusrequired
EnabledDisabledUnknown
merchantDashboardAccessbooleanrequired

Whether sub-merchants may sign in to their own dashboard.

Example true

selfManagedGrossSettlementbooleanrequired

Whether the marketplace collects its own sub-merchants' invoice fees. This decides who may mark a merchant invoice paid.

Example true

shortenerBaseUristring

Base URL the marketplace's short links are issued under, where it has its own.

Example https://example.com/callback

zendeskUserGroupIdinteger (int64)

The marketplace's Zendesk group, where support is routed through one.

Example 1250

How the marketplace is paid by bank transfer. Absent where you may not read its financials, which is not the same as it not being set up.

sourceRulesarray of string

The rules deciding which payment sources its sub-merchants may take. Empty means no restriction.

createdAtstring (date-time)required

Example 2026-08-19T04:21:07Z

updatedAtstring (date-time)required

Example 2026-08-19T04:21:07Z

Example
{
  "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