Criar saque š§
POST
/api/v1/withdrawals
š¾ Estrutura de Dados
Headers
application/json<JWT_TOKEN>Body (JSON)
| Propriedade | Tipo | ObrigatĆ³rio | DescriĆ§Ć£o | Valor (exemplo) |
|---|---|---|---|---|
| amount | Int | Sim | Valor desejado para saque em centavos (Int) e nĆ£o em decimal | 1005 |
| pixKey | String | Sim | Chave pix. Onde pode ser CPF/CNPJ, E-mail, Telefone, Chave aleatĆ³ria (EVP) | d9b1b8e3-5c25-4f2e-b2c3-6d6b1c2e4a7f |
| status | Enum | NĆ£o | REQUESTED ā PROCESSING ā COMPLETED / FAILED / CANCELLED | REQUESTED |
| postBackUrl | String | NĆ£o | Para criar um webhook automaticamente para o vendedor se nĆ£o existir | - |
| metadata | String | Sim | Armazenar alguma informaĆ§Ć£o que serĆ” retornada na resposta do webhook | - |
RequisiĆ§Ć£o
ParĆ¢metros Bodyapplication/json
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v1/withdrawals' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": 1005,
"pixKey": "d9b1b8e3-5c25-4f2e-b2c3-6d6b1c2e4a7f"
}'Response Response Example
201 - Sucesso
{
"id": "ba35c1ff-5b12-4b92-96f0-598c628bef9a",
"sellerId": "4a8fec9d-62d7-4104-a34e-680412f1a6bf",
"amount": 1009,
"status": "REQUESTED",
"requestedAt": "2025-11-12T14:37:40.340Z",
"completedAt": null
}Modificado emĀ 2025-12-31 00:48:40