Skip to main content
POST
/
v2
/
account
/
markup
Create Merchant Markup Configuration
curl --request POST \
  --url https://api.sandbox.wepayout.com.br/v2/account/markup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": 123,
  "parent_id": 123,
  "product": "<string>",
  "payment_method": "<string>",
  "type": "<string>",
  "mode": "<string>",
  "amount": 123,
  "min_charge_value": 123,
  "max_charge_value": 123
}
'
{
  "id": 1,
  "product": "payin",
  "payment_method": "pix",
  "account_id": 123,
  "parent_id": null,
  "type": "global",
  "mode": "percent",
  "amount": 2.5,
  "min_charge_value": 1.0,
  "max_charge_value": 100.0,
  "enabled": true,
  "created_at": "2024-06-01T12:00:00Z",
  "updated_at": "2024-06-01T12:00:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.wepayout.co/llms.txt

Use this file to discover all available pages before exploring further.

Use this endpoint to configure markup rules for a merchant, defining how much additional amount will be charged per product and payment method.

​
Request Body

​
account_id
integer
required
ID of the merchant that will receive the markup.
​
parent_id
integer
Optional parent relationship ID. Can be used to associate this markup to a parent account or hierarchy level.
​
product
string
required
Product where the markup will be applied.Allowed values: payin, payout
​
payment_method
string
required
Payment method where the markup will be applied.Allowed values: pix, billet, credit_card
​
type
string
required
Markup scope type.Currently, only global is supported externally.
​
mode
string
required
Type of markup to be applied.Allowed values:
  • fixed: fixed amount per charge
  • percent: percentage over the charge amount
​
amount
number
required
Markup value to be applied.Constraints:
  • Must be greater than or equal to 0.01.
​
min_charge_value
number
Minimum markup amount when mode is percent.Business rules:
  • Required when mode = percent
  • Prohibited when mode = fixed
  • Must be greater than or equal to 0.01
​
max_charge_value
number
Maximum markup amount when mode is percent.Business rules:
  • Optional
  • Must be greater than or equal to min_charge_value
  • Prohibited when mode = fixed
When mode is fixed, do not send min_charge_value or max_charge_value.

​
Request Examples

{
  "account_id": 123,
  "product": "payin",
  "payment_method": "pix",
  "type": "global",
  "mode": "percent",
  "amount": 2.5,
  "min_charge_value": 1.0,
  "max_charge_value": 100.0
}

​
Response

​
id
integer
Markup configuration ID.
​
product
string
Product where the markup is applied.
​
payment_method
string
Payment method where the markup is applied.
​
account_id
integer
Merchant ID that receives the markup.
​
parent_id
integer or null
Parent relationship ID, when applicable.
​
type
string
Markup scope type. Example: global.
​
mode
string
Markup mode. Example: fixed or percent.
​
amount
number
Markup value configured for this rule.
​
min_charge_value
number or null
Minimum markup value when mode is percent.
​
max_charge_value
number or null
Maximum markup value when mode is percent.
{
  "id": 1,
  "product": "payin",
  "payment_method": "pix",
  "account_id": 123,
  "parent_id": null,
  "type": "global",
  "mode": "percent",
  "amount": 2.5,
  "min_charge_value": 1.0,
  "max_charge_value": 100.0,
  "enabled": true,
  "created_at": "2024-06-01T12:00:00Z",
  "updated_at": "2024-06-01T12:00:00Z"
}

Update Merchant Markup

Update existing markup configurations

List Merchant Markups

View all markup configurations

About Markup

Learn about markup types and configuration levels

Create Payin with Global Markup

Use global markup when creating payin charges