Criar Payout

POST

https://api.novuspagamentos.com/api/v2/payout

Use este endpoint para criar uma nova solicitação de saque (Payout). Esta operação inicia a transferência de fundos do seu saldo disponível na plataforma para uma conta bancária externa designada (por exemplo, via PIX).

🔁 Idempotência

Envie um UUID v4 único no cabeçalho Idempotency-Key para evitar payouts duplicados em caso de retentativa.

Se a mesma chave for enviada novamente, a resposta original é retornada sem criar um novo payout. O cabeçalho é opcional.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Sucesso

application/json

Body

🟠401Auth Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.novuspagamentos.com/api/v2/payout' \
--header 'Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ammmount": 10000,
    "type": "",
    "description": "",
    "notes": "",
    "postback_url": "",
    "external_id": "",
    "pix_key": "",
    "pix_key_type": ""
}'

Response Example

{
    "data": {
        "amount": 1000,
        "balances": {
            "bank_slip": 0,
            "card": 0,
            "pix": 10100,
            "total": 10100
        },
        "can_auto_process": true,
        "external_id": "cff80120-1520-4338-987c-87926m4201b0",
        "has_baas": true,
        "id": 24,
        "payee": {
            "conta": {
                "agencia": "123",
                "ispb": "12345678",
                "numero": "12345",
                "tipo": 0
            },
            "documento": "123456789",
            "nome": "PEDRO MIGUEL DA SILVA"
        },
        "payer": {
            "conta": {
                "agencia": "1",
                "ispb": "12345678",
                "numero": "000012345",
                "tipo": 0
            },
            "documento": "123456789101112",
            "nome": "EMPRESA MODELO"
        },
        "pix_key": "12345678910",
        "pix_key_type": "CPF",
        "postback_url": "https://google.com/",
        "status": "processing",
        "type": "withdrawal"
    },
    "message": "Auto-saque processado com sucesso"
}

Criar Payout

🔁 Idempotência#

Requisição

Respostas

🔁 Idempotência