Skip to main content
POST
/
v2
/
payout
/
payments
Create Payout with Inline Markup
curl --request POST \
  --url https://api.sandbox.wepayout.com.br/v2/payout/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "markup": {
    "mode": "<string>",
    "amount": 123,
    "min_charge_value": 123,
    "max_charge_value": 123
  }
}
'
{
  "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": {
    "mode": "percent",
    "amount": 2.5,
    "min_charge_value": 0.50,
    "max_charge_value": 10.00
  },
  "purpose": null,
  "paid_at": null,
  "created_at": "2024-01-15T10:30:00.000000Z",
  "updated_at": "2024-01-15T10:30:00.000000Z"
}

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 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.
​
markup
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

{
  "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"
    }
  },
  "markup": {
    "mode": "percent",
    "amount": 2.5,
    "min_charge_value": 0.50,
    "max_charge_value": 10.00
  }
}

​
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
Inline 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": {
    "mode": "percent",
    "amount": 2.5,
    "min_charge_value": 0.50,
    "max_charge_value": 10.00
  },
  "purpose": null,
  "paid_at": null,
  "created_at": "2024-01-15T10:30:00.000000Z",
  "updated_at": "2024-01-15T10:30:00.000000Z"
}

​
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