Skip to main content
POST
Create Payout with Inline Markup

Create Payout with Inline Markup

When creating a payout payment, you can include an inline markup object in the request payload.
Inline markup takes precedence: If you send a markup object in the payment creation request, it will override any global or submerchant markup configurations.

Markup Object Structure

The markup object should be added to the request body when creating a payment via POST /v2/payout/payments.
object
Optional inline markup configuration for this specific payment.
When mode is fixed, do not send min_charge_value or max_charge_value.

Request Examples

Response

integer
WEpayment’s auto generated id, use this id to perform conciliation or perform queries via API / Dashboard.
object
Merchant object.
string
Payment method used for the payout.Values: PIX
string
The payout amount formatted with currency symbol.
string
Currency code (ISO 4217).
string
Invoice identifier.
object
Payout status.
object
Beneficiary information.
object
Inline markup configuration applied to this payment.

How It Works

  1. Priority: The inline markup configuration takes precedence over global and submerchant markup settings.
  2. Calculation (for percent mode):
    • The system calculates: payment_amount * (amount / 100)
    • If calculated value < min_charge_value → applies min_charge_value
    • If calculated value > max_charge_value → applies max_charge_value
    • Otherwise → applies the calculated value
  3. Fixed Mode: When using fixed mode, the markup amount is applied directly regardless of the transaction value.

Create Payment

Complete documentation for creating payout payments

About Markup

Learn about markup types and configuration levels