APG PayAPG Paydocs

Marketplaces

Get marketplace fee structure

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

Return one fee structure, with the rates on it and whether it is earning.

Permissions

Required permission
marketplaces:query

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

Path parameters

marketplaceFeeStructureIdstring
required

Responses

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

Discriminated by type
type = "MktpfeestructViewAttributes"
feeStructureIdMktpfeestructIdrequired

Identifier of a marketplace fee structure.

Example mktpfeestruct_9f2Kd8QpLzXw

marketplaceIdMktpIdrequired

Identifier of a marketplace.

Example mktp_9f2Kd8QpLzXw

marketplaceMerchantIdMchtIdrequired

The marketplace's own merchant entity, where the earnings are credited.

Example mcht_9f2Kd8QpLzXw

subMerchantIdMchtId

The sub-merchant this applies to. Absent means every sub-merchant of the marketplace.

Example mcht_9f2Kd8QpLzXw

enabledbooleanrequired

false leaves the structure configured but earns nothing, the marketplace falls back to a less specific one, or to none.

Example true

createdAtstring (date-time)required

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

updatedAtstring (date-time)required

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

Example
{
  "type": "MktpfeestructViewAttributes",
  "feeStructureId": "mktpfeestruct_9f2Kd8QpLzXw",
  "marketplaceId": "mktp_9f2Kd8QpLzXw",
  "marketplaceMerchantId": "mcht_9f2Kd8QpLzXw",
  "subMerchantId": "mcht_9f2Kd8QpLzXw",
  "fees": {
    "type": "FeesByPaymentForm",
    "fees": {
      "type": "FeeStructAttributes",
      "split": {
        "type": "FeeTableAttributes",
        "domestic": {
          "type": "FeeAttributes",
          "rate": 0.9412,
          "fixed": 1250,
          "cards": [
            {
              "type": "CardFeeAttributes",
              "cardFunding": "Credit",
              "cardBrand": "Visa",
              "rate": 0.9412,
              "fixed": 1250
            }
          ]
        },
        "international": {
          "type": "FeeAttributes",
          "rate": 0.9412,
          "fixed": 1250,
          "cards": [
            {
              "type": "CardFeeAttributes",
              "cardFunding": "Credit",
              "cardBrand": "Visa",
              "rate": 0.9412,
              "fixed": 1250
            }
          ]
        }
      },
      "full": {
        "type": "FeeTableAttributes",
        "domestic": {
          "type": "FeeAttributes",
          "rate": 0.9412,
          "fixed": 1250,
          "cards": [
            {
              "type": "CardFeeAttributes",
              "cardFunding": "Credit",
              "cardBrand": "Visa",
              "rate": 0.9412,
              "fixed": 1250
            }
          ]
        },
        "international": {
          "type": "FeeAttributes",
          "rate": 0.9412,
          "fixed": 1250,
          "cards": [
            {
              "type": "CardFeeAttributes",
              "cardFunding": "Credit",
              "cardBrand": "Visa",
              "rate": 0.9412,
              "fixed": 1250
            }
          ]
        }
      }
    }
  },
  "enabled": true,
  "createdAt": "2026-08-19T04:21:07Z",
  "updatedAt": "2026-08-19T04:21:07Z"
}

Error responses