Skip to main content
POST
/
v2
/
payout
/
payments
Create Payout with Global Markup
curl --request POST \
  --url https://api.sandbox.wepayout.com.br/v2/payout/payments \
  --header 'Authorization: Bearer <token>'
{
  "id": 12345,
  "merchant": {
    "id": 477,
    "name": "Merchant Name"
  },
  "payment_method": "PIX",
  "amount": "R$ 100,50",
  "currency": "BRL",
  "invoice": "e3317882-f821-455b-b082-dc3ba36e8a57",
  "status": {
    "id": 1,
    "name": "Awaiting"
  },
  "beneficiary": {
    "name": "John Doe",
    "document": {
      "type": "CPF",
      "number": "12345678901"
    }
  },
  "markup": null
}

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.

​
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 global markup configuration for the submerchant.

​
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 the global markup configuration based on:
    • account_id (submerchant ID)
    • product (payout)
    • payment_method (PIX, TED, etc.)
  3. Application: If a global markup is found, it is automatically applied to the payment.
  4. Priority: If you send an inline markup object, it takes precedence over the global markup.

​
Request Examples

{
  "payment_method": "PIX",
  "invoice": "e3317882-f821-455b-b082-dc3ba36e8a57",
  "currency": "BRL",
  "amount": 100.50,
  "country": "BR",
  "beneficiary": {
    "name": "John Doe",
    "document": {
      "type": "CPF",
      "number": "12345678901"
    },
    "pix": {
      "key": "12345678901"
    }
  }
}

​
Response

​
id
integer
WEpayment’s auto generated id, use this id to perform conciliation or perform queries via API / Dashboard.
​
merchant
object
Merchant object.
​
payment_method
string
Payment method used for the payout.Values: PIX
​
amount
string
The payout amount formatted with currency symbol.
​
currency
string
Currency code (ISO 4217).
​
invoice
string
Invoice identifier.
​
status
object
Payout status.
​
beneficiary
object
Beneficiary information.
​
markup
object or null
Global markup configuration applied to this payment.
{
  "id": 12345,
  "merchant": {
    "id": 477,
    "name": "Merchant Name"
  },
  "payment_method": "PIX",
  "amount": "R$ 100,50",
  "currency": "BRL",
  "invoice": "e3317882-f821-455b-b082-dc3ba36e8a57",
  "status": {
    "id": 1,
    "name": "Awaiting"
  },
  "beneficiary": {
    "name": "John Doe",
    "document": {
      "type": "CPF",
      "number": "12345678901"
    }
  },
  "markup": null
}

​
Business Rules

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

​
Error Scenarios

​
Scenario 1: enable_markup = true, No Global Markup, No Inline Markup

If the submerchant has enable_markup = true but:
  • No global markup configuration exists
  • 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