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

Documentation Index

Fetch the complete documentation index at: https://developer.paymee.com.br/llms.txt

Use this file to discover all available pages before exploring further.

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[]