Skip to content

Create payout

POST api/v2/paygate/payout/wallet/
 Create a payout by wallet

Request Body schema

application/json

Field Type Required Description Example
endpoint string Yes Api key "1dc4441f-38d5-42b5-a705-81958f928462"
amount integer Yes Amount in minor units 1000
currency integer Yes Number code 986
buyer object Yes Buyer at the endpoint in JSON format {"remote_id": "string", "ip": "string"}
description string No Description "string"
client_id string No Transaction id at the endpoint.
Max 255 chars		 "string"
notify_url string or null No Notification URL of changed status "http://example.com"
payment_method string or null Yes The method of payment being used for the transaction.
May be: pix		 "pix"
moderated boolean or null No Is payout moderated? Default: True True
name string Yes The customer's name "John Smith"
phone string Yes The customer's phone number in international format (E164) "+5511912345678"
email string No (Required under certain conditions) The customer's email "user@example.com"
evp_random_key string No (Required under certain conditions) The customer's EVP random key "string"
document_number string Yes The customer's official identification number assigned by a government authority "111111111"
document_type string No The customer's document type.
May be: cnpj, cpf, phone, email, evp. Default: cpf		 "cpf"

Request sample

{
    "endpoint": "1dc4441f-38d5-42b5-a705-81958f928462",
    "amount": 1000,
    "currency": 986,
    "buyer": {
        "remote_id": "string",
        "ip": "string"
    },
    "description": "string",
    "client_id": "string",
    "notify_url": "http://example.com",
    "payment_method": "pix",
    "name": "John Smith",
    "phone": "+5511912345678",
    "email": "user@example.com",
    "evp_random_key": "string",
    "document_number": "111111111",
    "document_type": "cpf"
}

Response sample


STATUS 201

{
    "tx": {
        "tx": "f17d7f5c-6b4a-47fd-95eb-08086e250473",
        "payout": {},
        "status": "create",
        "currency": {
          "id": 0,
          "title": "BRL",
          "char_code": "BRL",
          "num_code": 986
        },
        "amount": 1000,
        "created_at": "2000-01-01T00:00:00Z",
        "errors": {},
        "parts_tx": [],
        "additional_data": {},
        "endpoint_logo": "string"
    }
}