Pular para o conteúdo principal
POST
/
withdrawals
Criar um saque via PIX
curl --request POST \
  --url https://api.pague.dev/v1/withdrawals \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "amount": 150.75,
  "bankAccountId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "pixKey": "12345678901",
  "pixKeyType": "cpf",
  "holderName": "João da Silva",
  "holderDocument": "12345678901",
  "holderDocumentType": "cpf"
}
'
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "bankAccountId": null,
  "amount": 150.75,
  "feeAmount": 2.5,
  "netAmount": 148.25,
  "status": "completed",
  "snapshotHolderName": "João da Silva",
  "snapshotHolderDocument": "12345678901",
  "createdAt": "2026-02-10T14:30:00.000Z",
  "snapshotPixKey": "12345678901",
  "snapshotPixKeyType": "cpf",
  "failureReason": null,
  "pspReference": null,
  "processedAt": "2026-02-10T14:30:01.000Z"
}

Cabeçalhos

​
X-API-Key
string
obrigatório

Chave de API de integração (pd_live_* para produção, pd_test_* para sandbox)

Corpo

application/json

Dados para criar um saque via PIX. Informe bankAccountId para usar uma conta salva, ou os campos PIX inline (pixKey, pixKeyType, holderName, holderDocument).

​
amount
number
obrigatório

Valor do saque em BRL (ex: 100.50 para R$ 100,50). Mínimo R$ 1,00.

Intervalo obrigatório: x >= 1
Exemplo:

150.75

​
bankAccountId
string<uuid>

ID de uma conta bancária PIX salva. Se não informado, os campos PIX inline são obrigatórios.

Exemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
pixKey
string

Chave PIX do destinatário. Obrigatório quando bankAccountId não é informado.

Exemplo:

"12345678901"

​
pixKeyType
enum<string>

Tipo da chave PIX. Obrigatório quando bankAccountId não é informado.

Opções disponíveis:
cpf,
cnpj,
email,
phone,
random
Exemplo:

"cpf"

​
holderName
string

Nome do titular da conta PIX. Obrigatório quando bankAccountId não é informado.

Exemplo:

"João da Silva"

​
holderDocument
string

CPF ou CNPJ do titular. Obrigatório quando bankAccountId não é informado.

Exemplo:

"12345678901"

​
holderDocumentType
enum<string>
padrão:cpf

Tipo do documento do titular. Padrão: cpf.

Opções disponíveis:
cpf,
cnpj

Resposta

Saque criado com sucesso

Dados do saque criado.

​
id
string<uuid>
obrigatório

ID do saque

Exemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
bankAccountId
string<uuid> | null
obrigatório

ID da conta bancária usada (null para PIX avulso)

Exemplo:

null

​
amount
number
obrigatório

Valor do saque em BRL

Exemplo:

150.75

​
feeAmount
number
obrigatório

Valor da taxa em BRL

Exemplo:

2.5

​
netAmount
number
obrigatório

Valor líquido em BRL

Exemplo:

148.25

​
status
enum<string>
obrigatório

Status do saque

Opções disponíveis:
pending,
processing,
completed,
failed
Exemplo:

"completed"

​
snapshotHolderName
string
obrigatório

Nome do titular no momento do saque

Exemplo:

"João da Silva"

​
snapshotHolderDocument
string
obrigatório

Documento do titular no momento do saque

Exemplo:

"12345678901"

​
createdAt
string<date-time>
obrigatório

Data de criação

Exemplo:

"2026-02-10T14:30:00.000Z"

​
snapshotPixKey
string | null

Chave PIX usada no momento do saque

Exemplo:

"12345678901"

​
snapshotPixKeyType
enum<string> | null

Tipo da chave PIX usada no momento do saque

Opções disponíveis:
cpf,
cnpj,
email,
phone,
random
Exemplo:

"cpf"

​
failureReason
string | null

Motivo da falha (quando status = failed)

Exemplo:

null

​
pspReference
string | null

Referência do PSP (provedor de pagamento)

Exemplo:

null

​
processedAt
string<date-time> | null

Data de processamento

Exemplo:

"2026-02-10T14:30:01.000Z"