Skip to main content
GET
List Submerchant Markups

List Submerchant Markups

Use this endpoint to list the submerchants of a merchant, together with the markup configured for each one. Submerchants that do not have their own markup are also returned, with has_markup: false and empty payin and payout lists. These submerchants use the merchant’s global markup.

Path Parameters

integer
required
ID of the merchant (parent account). It must be one of the authenticated user’s companies.

Query Parameters

Free-text filter. Matches the submerchant’s name or legal name (partial match), ID (exact match), or document. When searching by document, punctuation is ignored, so 12.345.678/0001-90 and 12345678000190 are the same.Max length: 255
integer
default:"1"
Page number. Must be greater than or equal to 1.
integer
default:"10"
Number of submerchants per page. Must be between 1 and 500.

Request Examples

Response

array[object]
List of submerchants.
integer
Total number of submerchants that match the filter.
integer
Current page.
integer
Number of submerchants per page.
integer
Total number of pages.

Get Submerchant Markup

View the markup of a single submerchant

Configure Submerchant Markup

Set the markup of a submerchant

Batch Apply Submerchant Markup

Apply the same markup to many submerchants

About Markup

Learn about markup types and configuration levels