APG PayAPG Paydocs

API reference

Marketplaces

9 endpoints

What a marketplace earns on payments its sub-merchants take, the revenue share, credited to a merchant entity the marketplace owns.

These point the opposite way from a merchant's fees. /merchants carries what the platform charges the merchant; this carries what the marketplace earns. marketplaceMerchantId is where the earnings land, and it is a merchant record belonging to the marketplace itself.

One structure usually covers every sub-merchant. Leave subMerchantId out and it applies to all of them; add structures naming particular sub-merchants for the ones negotiated separately, and the platform takes the most specific match.

There is no list. The platform can find a structure by its identifier and by the sub-merchant it covers, and it cannot page them, so keep the identifier the create hands back. Reading them all is recorded as an outstanding gap in the migration guide.