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
}
'

import requests

url = "https://api.sandbox.wepayout.com.br/v2/account/markup"

payload = {
    "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
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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
  })
};

fetch('https://api.sandbox.wepayout.com.br/v2/account/markup', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.wepayout.com.br/v2/account/markup",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.wepayout.com.br/v2/account/markup"

	payload := strings.NewReader("{\n  \"account_id\": 123,\n  \"parent_id\": 123,\n  \"product\": \"<string>\",\n  \"payment_method\": \"<string>\",\n  \"type\": \"<string>\",\n  \"mode\": \"<string>\",\n  \"amount\": 123,\n  \"min_charge_value\": 123,\n  \"max_charge_value\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.wepayout.com.br/v2/account/markup")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": 123,\n  \"parent_id\": 123,\n  \"product\": \"<string>\",\n  \"payment_method\": \"<string>\",\n  \"type\": \"<string>\",\n  \"mode\": \"<string>\",\n  \"amount\": 123,\n  \"min_charge_value\": 123,\n  \"max_charge_value\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.wepayout.com.br/v2/account/markup")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": 123,\n  \"parent_id\": 123,\n  \"product\": \"<string>\",\n  \"payment_method\": \"<string>\",\n  \"type\": \"<string>\",\n  \"mode\": \"<string>\",\n  \"amount\": 123,\n  \"min_charge_value\": 123,\n  \"max_charge_value\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "message": "Dados inválidos.",
  "errors": {
    "product": [
      "O campo product é inválido."
    ],
    "amount": [
      "O campo amount é obrigatório."
    ],
    "min_charge_value": [
      "O campo min_charge_value é obrigatório quando mode é percent."
    ]
  }
}

{
  "error": "Não foi possível criar o markup."
}

POST

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
}
'

import requests

url = "https://api.sandbox.wepayout.com.br/v2/account/markup"

payload = {
    "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
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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
  })
};

fetch('https://api.sandbox.wepayout.com.br/v2/account/markup', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.wepayout.com.br/v2/account/markup",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.wepayout.com.br/v2/account/markup"

	payload := strings.NewReader("{\n  \"account_id\": 123,\n  \"parent_id\": 123,\n  \"product\": \"<string>\",\n  \"payment_method\": \"<string>\",\n  \"type\": \"<string>\",\n  \"mode\": \"<string>\",\n  \"amount\": 123,\n  \"min_charge_value\": 123,\n  \"max_charge_value\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.wepayout.com.br/v2/account/markup")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": 123,\n  \"parent_id\": 123,\n  \"product\": \"<string>\",\n  \"payment_method\": \"<string>\",\n  \"type\": \"<string>\",\n  \"mode\": \"<string>\",\n  \"amount\": 123,\n  \"min_charge_value\": 123,\n  \"max_charge_value\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.wepayout.com.br/v2/account/markup")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": 123,\n  \"parent_id\": 123,\n  \"product\": \"<string>\",\n  \"payment_method\": \"<string>\",\n  \"type\": \"<string>\",\n  \"mode\": \"<string>\",\n  \"amount\": 123,\n  \"min_charge_value\": 123,\n  \"max_charge_value\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

{
  "message": "Dados inválidos.",
  "errors": {
    "product": [
      "O campo product é inválido."
    ],
    "amount": [
      "O campo amount é obrigatório."
    ],
    "min_charge_value": [
      "O campo min_charge_value é obrigatório quando mode é percent."
    ]
  }
}

{
  "error": "Não foi possível criar o markup."
}

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

integer

required

ID of the merchant that will receive the markup.

integer

Optional parent relationship ID. Can be used to associate this markup to a parent account or hierarchy level.

string

required

Product where the markup will be applied.Allowed values: payin, payout

string

required

Payment method where the markup will be applied.Allowed values: pix, billet, credit_card

string

required

Markup scope type.Currently, only global is supported externally.

string

required

Type of markup to be applied.Allowed values:

fixed: fixed amount per charge
percent: percentage over the charge amount

number

required

Markup value to be applied.Constraints:

Must be greater than or equal to 0.01.

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

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
}

{
  "account_id": 123,
  "product": "payout",
  "payment_method": "pix",
  "type": "global",
  "mode": "fixed",
  "amount": 5.0
}

curl -X POST "https://api.sandbox.wepayout.com.br/v2/account/markup" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "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

integer

Markup configuration ID.

string

Product where the markup is applied.

string

Payment method where the markup is applied.

integer

Merchant ID that receives the markup.

integer or null

Parent relationship ID, when applicable.

string

Markup scope type. Example: global.

string

Markup mode. Example: fixed or percent.

number

Markup value configured for this rule.

number or null

Minimum markup value when mode is percent.

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"
}

{
  "message": "Dados inválidos.",
  "errors": {
    "product": [
      "O campo product é inválido."
    ],
    "amount": [
      "O campo amount é obrigatório."
    ],
    "min_charge_value": [
      "O campo min_charge_value é obrigatório quando mode é percent."
    ]
  }
}

{
  "error": "Não foi possível criar o markup."
}

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

Submit Document For KYC Update Merchant Markup Configuration

Account

Banks

Payin

Payout

KYC

Markup

Create Merchant Markup Configuration

Request Body

Request Examples

Response

Update Merchant Markup

List Merchant Markups

About Markup

Create Payin with Global Markup

​Request Body

​Request Examples

​Response

​Related Resources

Update Merchant Markup

List Merchant Markups

About Markup

Create Payin with Global Markup

Request Body

Request Examples

Response

Related Resources