Create
POST
/api/user/cashout
✅ Requisitos da Requisição
POST/api/user/cashoutapplication/jsonapi_token🧠 Header da requisição
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
x-api-key | string | Sim | Token de autenticação API Key |
User-Agent | AtivoB2B/1.0 | Sim |
📥 Corpo da Requisição (Request Body)
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
amount | number | Sim | Valor a ser transferido em centavos. Ex: 500 representa R$ 5,00. |
pixKey | string | Sim | Chave PIX do destinatário. Pode ser CPF, e-mail, telefone ou chave aleatória. |
pixType | string | Sim | Tipo da chave PIX. Ex: CPF, CNPJ, EMAIL, PHONE e RANDOM. |
beneficiaryName | string | Sim | Nome completo do beneficiário. |
beneficiaryDocument | string | Sim | Documento do beneficiário (CPF ou CNPJ). |
description | string | Sim | Descrição da transferência. |
postbackUrl | string | Sim | URL para notificação de status da transação. |
Request
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/user/cashout' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": 500,
"pixKey": "000.000.000-00",
"pixType": "CPF",
"beneficiaryName": "João da Silva",
"beneficiaryDocument": "000.000.000-00",
"description": "Saque de R$ 5,00.",
"postbackUrl": "http://localhost:3000"
}'Response Response Example
200 - Success
{
"data": {
"id": "123e4567-e89b-189-654e-426614174000",
"amount": 500,
"fee": 50,
"pixKey": "000.000.000-00",
"pixType": "CPF",
"beneficiaryName": "João da Silva",
"beneficiaryDocument": "000.000.000-00",
"creditorName": null,
"creditorDocument": null,
"endToEndId": null,
"receiptUrl": null,
"description": "Saque de R$ 5,00.",
"postbackUrl": "http://localhost:3000/postback",
"externalRef": null,
"error": null,
"status": "PENDING",
"sellerId": "sa65d4dd6e-5b19-11ee-be56-0242ac120002",
"gatewayProviderId": "3c9a9ad1-5b19-3424-be56-0242ac120002",
"gatewayId": "3434331-5b19-11ee-be56-0242ac120002",
"createdAt": "2024-11-22T15:20:10.394Z",
"updatedAt": "2024-11-22T15:20:10.394Z"
},
"status": 200,
"message": "Cashout criado com sucesso.",
"error": null
}Modified at 2025-07-23 19:02:40