Skip to main content
POST
/
v1.1
/
payout
/
create
/
batch
Batch payout request
curl --request POST \
  --url https://api.paymee.com.br/v1.1/payout/create/batch \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-token: <x-api-token>' \
  --data '
{
  "payments": [
    {
      "amount": 1,
      "beneficiary": {
        "bankDetails": {
          "account": "000001-5",
          "bankCode": "077",
          "branch": "0001",
          "type": "CHECKING"
        },
        "document": {
          "number": "00000000000",
          "type": "CPF"
        }
      },
      "email": "foo@bar.com",
      "notes": "example-01",
      "referenceCode": "X540QG02",
      "scheduledDate": "2020-11-29 15:00:00"
    },
    {
      "amount": 1.99,
      "beneficiary": {
        "bankDetails": {
          "account": "000002-2",
          "branch": "7444",
          "type": "CHECKING"
        },
        "document": {
          "number": "00000000001",
          "type": "CPF"
        }
      },
      "email": "foo1@bar.com",
      "notes": "example-02",
      "referenceCode": "X540QG12",
      "scheduledDate": "2020-11-25 00:00:00"
    },
    {
      "amount": 3.99,
      "beneficiary": {
        "bankDetails": {
          "account": "000022-0",
          "bankCode": "104",
          "branch": "7474",
          "type": "SAVING"
        },
        "document": {
          "number": "00000000002",
          "type": "CPF"
        }
      },
      "email": "foo2@bar.com",
      "notes": "saving-account-example",
      "referenceCode": "X540QG22"
    }
  ]
}
'
import requests

url = "https://api.paymee.com.br/v1.1/payout/create/batch"

payload = { "payments": [
        {
            "amount": 1,
            "beneficiary": {
                "bankDetails": {
                    "account": "000001-5",
                    "bankCode": "077",
                    "branch": "0001",
                    "type": "CHECKING"
                },
                "document": {
                    "number": "00000000000",
                    "type": "CPF"
                }
            },
            "email": "foo@bar.com",
            "notes": "example-01",
            "referenceCode": "X540QG02",
            "scheduledDate": "2020-11-29 15:00:00"
        },
        {
            "amount": 1.99,
            "beneficiary": {
                "bankDetails": {
                    "account": "000002-2",
                    "branch": "7444",
                    "type": "CHECKING"
                },
                "document": {
                    "number": "00000000001",
                    "type": "CPF"
                }
            },
            "email": "foo1@bar.com",
            "notes": "example-02",
            "referenceCode": "X540QG12",
            "scheduledDate": "2020-11-25 00:00:00"
        },
        {
            "amount": 3.99,
            "beneficiary": {
                "bankDetails": {
                    "account": "000022-0",
                    "bankCode": "104",
                    "branch": "7474",
                    "type": "SAVING"
                },
                "document": {
                    "number": "00000000002",
                    "type": "CPF"
                }
            },
            "email": "foo2@bar.com",
            "notes": "saving-account-example",
            "referenceCode": "X540QG22"
        }
    ] }
headers = {
    "x-api-key": "<x-api-key>",
    "x-api-token": "<x-api-token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<x-api-key>',
    'x-api-token': '<x-api-token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    payments: [
      {
        amount: 1,
        beneficiary: {
          bankDetails: {account: '000001-5', bankCode: '077', branch: '0001', type: 'CHECKING'},
          document: {number: '00000000000', type: 'CPF'}
        },
        email: 'foo@bar.com',
        notes: 'example-01',
        referenceCode: 'X540QG02',
        scheduledDate: '2020-11-29 15:00:00'
      },
      {
        amount: 1.99,
        beneficiary: {
          bankDetails: {account: '000002-2', branch: '7444', type: 'CHECKING'},
          document: {number: '00000000001', type: 'CPF'}
        },
        email: 'foo1@bar.com',
        notes: 'example-02',
        referenceCode: 'X540QG12',
        scheduledDate: '2020-11-25 00:00:00'
      },
      {
        amount: 3.99,
        beneficiary: {
          bankDetails: {account: '000022-0', bankCode: '104', branch: '7474', type: 'SAVING'},
          document: {number: '00000000002', type: 'CPF'}
        },
        email: 'foo2@bar.com',
        notes: 'saving-account-example',
        referenceCode: 'X540QG22'
      }
    ]
  })
};

fetch('https://api.paymee.com.br/v1.1/payout/create/batch', 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.paymee.com.br/v1.1/payout/create/batch",
  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([
    'payments' => [
        [
                'amount' => 1,
                'beneficiary' => [
                                'bankDetails' => [
                                                                'account' => '000001-5',
                                                                'bankCode' => '077',
                                                                'branch' => '0001',
                                                                'type' => 'CHECKING'
                                ],
                                'document' => [
                                                                'number' => '00000000000',
                                                                'type' => 'CPF'
                                ]
                ],
                'email' => 'foo@bar.com',
                'notes' => 'example-01',
                'referenceCode' => 'X540QG02',
                'scheduledDate' => '2020-11-29 15:00:00'
        ],
        [
                'amount' => 1.99,
                'beneficiary' => [
                                'bankDetails' => [
                                                                'account' => '000002-2',
                                                                'branch' => '7444',
                                                                'type' => 'CHECKING'
                                ],
                                'document' => [
                                                                'number' => '00000000001',
                                                                'type' => 'CPF'
                                ]
                ],
                'email' => 'foo1@bar.com',
                'notes' => 'example-02',
                'referenceCode' => 'X540QG12',
                'scheduledDate' => '2020-11-25 00:00:00'
        ],
        [
                'amount' => 3.99,
                'beneficiary' => [
                                'bankDetails' => [
                                                                'account' => '000022-0',
                                                                'bankCode' => '104',
                                                                'branch' => '7474',
                                                                'type' => 'SAVING'
                                ],
                                'document' => [
                                                                'number' => '00000000002',
                                                                'type' => 'CPF'
                                ]
                ],
                'email' => 'foo2@bar.com',
                'notes' => 'saving-account-example',
                'referenceCode' => 'X540QG22'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>",
    "x-api-token: <x-api-token>"
  ],
]);

$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.paymee.com.br/v1.1/payout/create/batch"

	payload := strings.NewReader("{\n  \"payments\": [\n    {\n      \"amount\": 1,\n      \"beneficiary\": {\n        \"bankDetails\": {\n          \"account\": \"000001-5\",\n          \"bankCode\": \"077\",\n          \"branch\": \"0001\",\n          \"type\": \"CHECKING\"\n        },\n        \"document\": {\n          \"number\": \"00000000000\",\n          \"type\": \"CPF\"\n        }\n      },\n      \"email\": \"foo@bar.com\",\n      \"notes\": \"example-01\",\n      \"referenceCode\": \"X540QG02\",\n      \"scheduledDate\": \"2020-11-29 15:00:00\"\n    },\n    {\n      \"amount\": 1.99,\n      \"beneficiary\": {\n        \"bankDetails\": {\n          \"account\": \"000002-2\",\n          \"branch\": \"7444\",\n          \"type\": \"CHECKING\"\n        },\n        \"document\": {\n          \"number\": \"00000000001\",\n          \"type\": \"CPF\"\n        }\n      },\n      \"email\": \"foo1@bar.com\",\n      \"notes\": \"example-02\",\n      \"referenceCode\": \"X540QG12\",\n      \"scheduledDate\": \"2020-11-25 00:00:00\"\n    },\n    {\n      \"amount\": 3.99,\n      \"beneficiary\": {\n        \"bankDetails\": {\n          \"account\": \"000022-0\",\n          \"bankCode\": \"104\",\n          \"branch\": \"7474\",\n          \"type\": \"SAVING\"\n        },\n        \"document\": {\n          \"number\": \"00000000002\",\n          \"type\": \"CPF\"\n        }\n      },\n      \"email\": \"foo2@bar.com\",\n      \"notes\": \"saving-account-example\",\n      \"referenceCode\": \"X540QG22\"\n    }\n  ]\n}")

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

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("x-api-token", "<x-api-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.paymee.com.br/v1.1/payout/create/batch")
  .header("x-api-key", "<x-api-key>")
  .header("x-api-token", "<x-api-token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payments\": [\n    {\n      \"amount\": 1,\n      \"beneficiary\": {\n        \"bankDetails\": {\n          \"account\": \"000001-5\",\n          \"bankCode\": \"077\",\n          \"branch\": \"0001\",\n          \"type\": \"CHECKING\"\n        },\n        \"document\": {\n          \"number\": \"00000000000\",\n          \"type\": \"CPF\"\n        }\n      },\n      \"email\": \"foo@bar.com\",\n      \"notes\": \"example-01\",\n      \"referenceCode\": \"X540QG02\",\n      \"scheduledDate\": \"2020-11-29 15:00:00\"\n    },\n    {\n      \"amount\": 1.99,\n      \"beneficiary\": {\n        \"bankDetails\": {\n          \"account\": \"000002-2\",\n          \"branch\": \"7444\",\n          \"type\": \"CHECKING\"\n        },\n        \"document\": {\n          \"number\": \"00000000001\",\n          \"type\": \"CPF\"\n        }\n      },\n      \"email\": \"foo1@bar.com\",\n      \"notes\": \"example-02\",\n      \"referenceCode\": \"X540QG12\",\n      \"scheduledDate\": \"2020-11-25 00:00:00\"\n    },\n    {\n      \"amount\": 3.99,\n      \"beneficiary\": {\n        \"bankDetails\": {\n          \"account\": \"000022-0\",\n          \"bankCode\": \"104\",\n          \"branch\": \"7474\",\n          \"type\": \"SAVING\"\n        },\n        \"document\": {\n          \"number\": \"00000000002\",\n          \"type\": \"CPF\"\n        }\n      },\n      \"email\": \"foo2@bar.com\",\n      \"notes\": \"saving-account-example\",\n      \"referenceCode\": \"X540QG22\"\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.paymee.com.br/v1.1/payout/create/batch")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["x-api-token"] = '<x-api-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payments\": [\n    {\n      \"amount\": 1,\n      \"beneficiary\": {\n        \"bankDetails\": {\n          \"account\": \"000001-5\",\n          \"bankCode\": \"077\",\n          \"branch\": \"0001\",\n          \"type\": \"CHECKING\"\n        },\n        \"document\": {\n          \"number\": \"00000000000\",\n          \"type\": \"CPF\"\n        }\n      },\n      \"email\": \"foo@bar.com\",\n      \"notes\": \"example-01\",\n      \"referenceCode\": \"X540QG02\",\n      \"scheduledDate\": \"2020-11-29 15:00:00\"\n    },\n    {\n      \"amount\": 1.99,\n      \"beneficiary\": {\n        \"bankDetails\": {\n          \"account\": \"000002-2\",\n          \"branch\": \"7444\",\n          \"type\": \"CHECKING\"\n        },\n        \"document\": {\n          \"number\": \"00000000001\",\n          \"type\": \"CPF\"\n        }\n      },\n      \"email\": \"foo1@bar.com\",\n      \"notes\": \"example-02\",\n      \"referenceCode\": \"X540QG12\",\n      \"scheduledDate\": \"2020-11-25 00:00:00\"\n    },\n    {\n      \"amount\": 3.99,\n      \"beneficiary\": {\n        \"bankDetails\": {\n          \"account\": \"000022-0\",\n          \"bankCode\": \"104\",\n          \"branch\": \"7474\",\n          \"type\": \"SAVING\"\n        },\n        \"document\": {\n          \"number\": \"00000000002\",\n          \"type\": \"CPF\"\n        }\n      },\n      \"email\": \"foo2@bar.com\",\n      \"notes\": \"saving-account-example\",\n      \"referenceCode\": \"X540QG22\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "message": "success",
  "result": [
    {
      "amount": 1,
      "appliedRate": 3.5,
      "creation": "2019-11-21 19:33:00",
      "currency": "BRL",
      "discounts": 0,
      "id": 1103460,
      "situation": "PENDING",
      "total": 1,
      "type": "PAYOUT",
      "uuid": "734150a2-3377-3717-832c-6f142ece7fa8"
    },
    {
      "amount": 1.99,
      "appliedRate": 3.5,
      "creation": "2019-11-21 19:33:00",
      "currency": "BRL",
      "discounts": 0,
      "id": 1103461,
      "situation": "PENDING",
      "total": 1.99,
      "type": "PAYOUT",
      "uuid": "b8784391-8d54-3d72-a9e6-5db10499c674"
    },
    {
      "amount": 3.99,
      "appliedRate": 3.5,
      "creation": "2019-11-21 19:33:00",
      "currency": "BRL",
      "discounts": 0,
      "id": 1103462,
      "situation": "PENDING",
      "total": 3.99,
      "type": "PAYOUT",
      "uuid": "ad4d5020-c896-324e-8979-03b7b5e63895"
    }
  ],
  "resultSize": 3,
  "status": 0,
  "totalElements": 3,
  "totalPages": 1
}

Headers

​
x-api-key
string
required
Example:

"your-x-api-key"

​
x-api-token
string
required
Example:

"your-x-api-token"

Body

application/json
​
payments
object[]
required

Array of payment requests

Minimum array length: 1

Response

Success or partial success response

​
message
string
Example:

"success"

​
status
number
Example:

0

​
resultSize
number
Example:

3

​
totalElements
number
Example:

3

​
totalPages
number
Example:

1

​
result
object[]