Skip to main content
POST
/
withdraw
/
create
curl -X POST https://api.aobapay.com/v1/withdraw/create \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
  "amount": 200,
  "pix_type": "CPF",
  "pix_key": "12345678900",
  "comment": "Pagamento de fatura",
  "externalID": "pedido-12345"
}'

{
  "error": "<unknown>",
  "status": 200,
  "data": {
    "id": "<string>",
    "amount": 123,
    "pixKey": "<string>",
    "pixType": "<string>",
    "externalID": "<string>",
    "status": "<string>",
    "comment": "<string>"
  }
}

​
Criar um Novo Saque

Este endpoint permite que você crie um novo pedido de saque. Você precisará fornecer o valor, os detalhes da chave PIX de destino e, opcionalmente, um comentário e um ID externo. 
{
  "amount": 200,
  "pix_type": "CPF",
  "pix_key": "12345678900",
  "comment": "Pagamento de fatura",
  "externalID": "pedido-12345"
}

curl -X POST https://api.aobapay.com/v1/withdraw/create \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
  "amount": 200,
  "pix_type": "CPF",
  "pix_key": "12345678900",
  "comment": "Pagamento de fatura",
  "externalID": "pedido-12345"
}'

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.

Response

Saque criado com sucesso.

​
error
null
​
status
integer
Example:

200

​
data
object