Skip to main content
GET
Get Submerchant Markup

Get Submerchant Markup

Use this endpoint to get the markup configured for one submerchant, grouped by product (payin and payout). If the submerchant has no markup of its own, has_markup is false and the lists are empty. In that case the merchant’s global markup is applied.

Path Parameters

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

Request Example

cURL

Response

The response is a submerchant object, with the same fields as an item of List Submerchant Markups.
integer
Submerchant ID.
string
Submerchant name.
Submerchant legal name.
string or null
Submerchant document (CNPJ or CPF), digits only.
boolean
true when the submerchant has its own markup for at least one product and payment method.
array[object]
Markups configured for payin. Each item has id, payment_method, mode, amount, min_charge_value and max_charge_value. Amounts are strings with 2 decimal places.
array[object]
Markups configured for payout, with the same structure as payin.
string or null
Date and time of the most recent change to the submerchant’s markup. null when there is no markup.

Configure Submerchant Markup

Set the markup of a submerchant

Remove Submerchant Markup

Go back to the global markup