WysePayDocs

Consultar um saque

GET
/api/v1/withdrawals/{id}

A situação de um saque.

Permissão da chave: withdrawals:read.

Autenticação

headerx-api-key<token>

Sua chave de API, criada no painel em Desenvolvedores → Chaves de API.

Parâmetros da URL

id*string

O id do saque (wd_…).

Corpo da resposta

O saque.

application/json
  1. response

Um saque do saldo para uma chave Pix.

id*string
status*string

PENDING enquanto é enviado; PAID, PARTIALLY_PAID ou FAILED no fim.

Valores aceitos"CREATED""PENDING""APPROVED""PAID""PARTIALLY_PAID""FAILED""CANCELLED"
amountCents*integer

O que chega no destino.

feeCents*integer

A taxa de saque.

pixKeyType*string
Valores aceitos"CPF""CNPJ""PHONE""EMAIL""EVP"
pixKey*string

A chave de destino, parcialmente escondida.

livemode*boolean
createdAt*string
Formato^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Formatodate-time
updatedAt*string
Formato^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Formatodate-time
curl -X GET "https://example.com/api/v1/withdrawals/string"
{  "id": "wd_01k6g8m2v4x7z9b3c5d7f9h0j2",  "status": "PAID",  "amountCents": 49900,  "feeCents": 100,  "pixKeyType": "CPF",  "pixKey": "12.***.***/0001-90",  "livemode": true,  "createdAt": "2026-10-04T15:30:00.000Z",  "updatedAt": "2026-10-04T15:30:00.000Z"}

Listar saques GET

Os saques da conta (pelo painel e pela API), do mais novo para o mais antigo. Permissão da chave: `withdrawals:read`.

Simular o pagamento POST

Só com chave de teste: marca a cobrança de teste como paga e envia o webhook `transaction.paid`, como num pagamento real. Permissão da chave: `charges:write`.