POST
/
v1.1
/
payout
/
create
curl --request POST \
  --url https://api.paymee.com.br/v1.1/payout/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-token: <x-api-token>' \
  --data '{
  "amount": 0.01,
  "referenceCode": "ABC012363YAA",
  "beneficiary": {
    "bankDetails": {
      "pixKey": "00000000000"
    },
    "document": {
      "number": "00000000000",
      "type": "CPF"
    }
  },
  "callbackURL": "https://www2.paymee.com.br/callback.php",
  "email": "foo@bar.com",
  "notes": "pixKey"
}'
{
  "status": 0,
  "message": "success",
  "id": 49913,
  "uuid": "b1b6c32c-65a5-3ecc-8c20-d1d24d7a1e40",
  "type": "PAYOUT",
  "situation": "PENDING",
  "currency": "BRL",
  "amount": 0.01,
  "discounts": 0,
  "total": 0.01,
  "serviceFee": 3.5,
  "creation": "2021-05-26 22:47:42",
  "beneficiary": {
    "bank": "000 - PIX",
    "branch": "0000",
    "account": "000000-0"
  },
  "authorizationKey": "2d1e28e2-b820-48fb-8b58-d2dc32b25944"
}

Headers

​
x-api-key
string
required
Example:

"your-x-api-key"

​
x-api-token
string
required
Example:

"your-x-api-token"

Body

application/json

Response

200
application/json

Success response

The response is of type object.