Skip to main content
POST
/
withdraw
/
create
Criar um novo saque
curl --request POST \
  --url https://api.aobapay.com/v1/withdraw/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 200,
  "pix_key": "<string>",
  "comment": "<string>",
  "externalID": "<string>",
  "postbackUrl": "https://webhook.example.com/pix"
}
'
{
  "error": null,
  "status": 200,
  "data": {
    "id": "<string>",
    "amount": 123,
    "pixKey": "<string>",
    "pixType": "<string>",
    "externalID": "<string>",
    "status": "<string>",
    "comment": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Cabeçalho de autenticação Bearer no formato Bearer <aobapay-api-key> onde <aobapay-api-key> é a sua chave de API.

Body

application/json
​
amount
number

Valor do saque em centavos.

Required range: x >= 200
Example:

200

​
pix_type
enum<string>

Tipo da chave PIX.

Available options:
EMAIL,
PHONE,
CPF,
CNPJ,
RANDOM
​
pix_key
string

Chave PIX.

​
comment
string

Comentário para o saque.

Maximum string length: 35
​
externalID
string

ID externo para referência na sua aplicação.

​
postbackUrl
string

URL para receber notificações sobre o status do pagamento, dos eventos de cobrança paga, expirada e extornada.

Example:

"https://webhook.example.com/pix"

Response

Saque criado com sucesso.

​
error
null
​
status
integer
Example:

200

​
data
object