Criar saque 🚧

POST

/api/v1/withdrawals

Endpoint para criar um novo registro de saque.

💾 Estrutura de Dados

Headers

Content-type: application/json

Authorization: Bearer <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	-

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/json

Examples

Responses

🟢201

application/json

Body

🟠400

🟠401

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://xpend-backend.onrender.com/api/v1/withdrawals' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 1005,
    "pixKey": "d9b1b8e3-5c25-4f2e-b2c3-6d6b1c2e4a7f"
}'

Response Example

201 - Success

{
    "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
}

Modified at 2025-12-27 01:31:55

Atualizar uma taxa

Listar todos saques

Criar saque 🚧

💾 Estrutura de Dados#

Headers#

Body (JSON)#

Request

Responses

💾 Estrutura de Dados

Headers

Body (JSON)