Solicitação de saque Pix

POST

/api/partner/v1/cash-out

Permite solicitação de saque via Pix. Autenticação e IP autorizado são obrigatórios.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

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

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200OK

application/json

Body

🟠401Não autorizado

🟠422Erro de parâmetro

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/partner/v1/cash-out' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 10,
    "description": "Teste",
    "pix_key_type": "CPF",
    "pix_key": "12345678900",
    "document": {
        "type": "cpf",
        "number": "12345678900"
    }
}'

Response Example

200 - Example 1

{
    "message": "Cashout request successfully submitted.",
    "reference_id": "d0f37529-d361-4a4a-b3df-0d1193bbc19f"
}

Modificado em 2025-08-04 15:07:30

Página anterior

Solicitação de depósito via Pix

Próxima página

OnCreate/OnUpdate