Docs/Saques
Saques (Pix Out)
Solicite transferências para chaves Pix de destino e acompanhe aprovações e processamento.
Ver requisitos de autenticaçãoHeaders
X-Api-Key
stringobrigatóriochave da empresa
X-Api-Secret
stringobrigatóriosecret da empresa
Content-Type
stringobrigatórioapplication/json
Parâmetros do body
amount
numberobrigatórioValor do saque em BRL.
pixKey
stringobrigatórioChave Pix do destinatário (e-mail, telefone, CPF/CNPJ ou chave aleatória).
strict
booleanopcionalQuando true e customer.document informado, o liquidante valida se o CPF/CNPJ da chave Pix corresponde ao documento do destinatário. Divergência resulta em saque failed com a mensagem "A chave Pix não corresponde ao documento informado." durante o processamento.
customer
objectobrigatórioDados do destinatário.
name
stringobrigatórioNome completo do destinatário.
E-mail do destinatário.
phone
stringobrigatórioTelefone do destinatário.
document
stringobrigatórioCPF ou CNPJ do destinatário.
reference
stringobrigatórioID único no seu sistema. Requisições repetidas com a mesma referência e os mesmos parâmetros retornam o mesmo saque (idempotência).
curl -X POST "https://api.aurepay.com.br/v1/withdrawals" \
-H "X-Api-Key: pk_live_******" \
-H "X-Api-Secret: sk_live_******" \
-H "Content-Type: application/json" \
-d '{
"amount": 49.97,
"pixKey": "123.456.789-09",
"strict": true,
"customer": {
"name": "João Silva Santos",
"email": "joao.silva@example.com",
"phone": "+5511987654321",
"document": "12345678909"
},
"reference": "4b2f1d0a-8e3b-4ba7-9f23-54eec86ef6c0"
}'{
"success": true,
"data": {
"id": "01KFAKEWITHDRAW00000000000",
"amount": 49.97,
"feeAmount": 1.25,
"totalAmount": 51.22,
"type": "withdraw",
"method": "pix",
"currency": "brl",
"status": "pending",
"customer": {
"id": "01KFAKECUSTOMER000000000000",
"name": "João Silva Santos",
"email": "joao.silva@example.com",
"phone": "+5511987654321",
"document": "12345678909"
},
"pixKey": "123.456.789-09",
"metadata": {
"number": 1,
"string": "yes",
"boolean": true
},
"reference": "4b2f1d0a-8e3b-4ba7-9f23-54eec86ef6c0",
"createdAt": "2026-03-30T13:10:00.000Z",
"updatedAt": "2026-03-30T13:10:00.000Z"
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Um ou mais campos falharam na validação de entrada.",
"details": [
{
"field": "amount",
"error": "Saldo insuficiente para concluir a operação."
}
]
},
"success": false
}Headers
X-Api-Key
stringobrigatóriochave da empresa
X-Api-Secret
stringobrigatóriosecret da empresa
Content-Type
stringobrigatórioapplication/json
Parâmetros de rota
id
string (ULID)obrigatórioIdentificador único do saque.
curl -X GET "https://api.aurepay.com.br/v1/withdrawals/01JXWITHDRAWALEXAMPLE" \
-H "X-Api-Key: pk_live_******" \
-H "X-Api-Secret: sk_live_******"{
"success": true,
"data": {
"id": "01KFAKEWITHDRAW00000000000",
"amount": 49.97,
"feeAmount": 1.25,
"totalAmount": 51.22,
"type": "withdraw",
"method": "pix",
"currency": "brl",
"status": "paid",
"customer": {
"id": "01KFAKECUSTOMER000000000000",
"name": "João Silva Santos",
"email": "joao.silva@example.com",
"phone": "+5511987654321",
"document": "12345678909"
},
"pixKey": "123.456.789-09",
"metadata": {
"number": 1,
"string": "yes",
"boolean": true
},
"reference": "4b2f1d0a-8e3b-4ba7-9f23-54eec86ef6c0",
"paidAt": "2026-03-30T13:11:40.000Z",
"details": {
"payer": {
"fullName": "AURE B2B LTDA",
"document": "62.389.603/0001-84",
"bankData": {
"id": "53822116",
"name": "MW IP LTDA.",
"agency": "0001",
"account": "3390-1"
}
},
"receiver": {
"fullName": "JOAO SILVA SANTOS",
"document": "123.456.789-09",
"bankData": {
"id": "22896431",
"name": "PICPAY",
"pixKey": "123.456.789-09",
"agency": "0001",
"account": "39408108-0"
}
},
"endToEndId": "E53822116202603301311FAKE123456"
},
"createdAt": "2026-03-30T13:10:00.000Z",
"updatedAt": "2026-03-30T13:11:40.000Z"
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Um ou mais campos falharam na validação de entrada.",
"details": [
{
"field": "amount",
"error": "Saldo insuficiente para concluir a operação."
}
]
},
"success": false
}Headers
X-Api-Key
stringobrigatóriochave da empresa
X-Api-Secret
stringobrigatóriosecret da empresa
Content-Type
stringobrigatórioapplication/json
Parâmetros de rota
id
string (ULID)obrigatórioIdentificador único do saque.
curl -X GET "https://api.aurepay.com.br/v1/withdrawals/01KFAKEWITHDRAW00000000000/payload" \
-H "X-Api-Key: pk_live_******" \
-H "X-Api-Secret: sk_live_******"{
"success": true,
"data": {
"paymentId": "01KFAKEWITHDRAW00000000000",
"method": "POST",
"path": "withdrawals",
"receivedAt": "2026-03-30T13:10:00.000Z",
"processedAt": "2026-03-30T13:10:00.180Z",
"request": {
"amount": 49.97,
"method": "pix",
"pixKey": "…8909",
"reference": "4b2f1d0a-8e3b-4ba7-9f23-54eec86ef6c0"
},
"response": {
"success": true,
"data": {
"id": "01KFAKEWITHDRAW00000000000",
"status": "paid"
}
}
}
}{
"error": {
"code": "PAYLOAD_NOT_FOUND",
"message": "Payload da requisição não existe ou foi removido.",
"details": null
},
"success": false
}