Skip to main content
POST
Create Payout with Global Markup

Create Payout with Global Markup

When creating a payout payment, you can use the global markup configuration that has been set up for your merchant. With global markup, you do not need to send the markup object in the request payload.
Global markup is applied automatically: If the merchant has the markup feature enabled (enable_markup = true), the system will automatically search for and apply the submerchant’s own markup or, if there is none, the global markup configuration.

How It Works

  1. Validation: The system checks if the enable_markup flag is active for the submerchant.
  2. Markup Search: If enabled, the system automatically searches for a markup configuration, first for the submerchant and then for the merchant, based on:
    • account_id (submerchant ID)
    • product (payout)
    • payment_method (markup for payout is currently available for PIX only)
  3. Application: If the submerchant has its own markup for the payment method, it is applied to the payment. Otherwise, the global markup is applied.
  4. Priority: If you send an inline markup object, it takes precedence over the submerchant and global markups.

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 or null
Markup configuration applied to this payment (submerchant or global).

Business Rules

Markup Required: If enable_markup = true for the submerchant and there is neither a submerchant markup nor a global markup configuration for the payment method, you must send an inline markup object. Otherwise, the request will fail with a 422 error.
Automatic Application: When enable_markup = true and a submerchant or global markup exists, it is automatically applied without requiring the markup object in the request.

Error Scenarios

Scenario 1: enable_markup = true, No Submerchant or Global Markup, No Inline Markup

If the submerchant has enable_markup = true but:
  • No submerchant markup configuration exists for the payment method
  • No global markup configuration exists for the payment method
  • No inline markup object is sent in the request
Result: Returns 422 error with message “O campo markup é obrigatório.”

Scenario 2: Error Verifying Global Markup

If there is an error while searching for or verifying the global markup configuration. Result: Returns 422 error with message “Error verifying markup configuration. Please try again or contact support.”

Create Payout with Inline Markup

Learn how to create payout with inline markup

Create Merchant Markup

Configure global markup for merchants

About Markup

Understand markup types and configuration levels

Create Payment

Complete documentation for creating payout payments