Criar retirada Pix

curl --request POST \
  --url https://gateway.staging.azentech.dev/api/pix/merchant/withdrawal \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "processor_type": "sandbox_pix",
  "amount": 50,
  "document_number": "12345678000195",
  "merchant_transaction_id": "50000000-0000-4000-8000-000000000003",
  "pix_key_type": "email"
}
'

import requests

url = "https://gateway.staging.azentech.dev/api/pix/merchant/withdrawal"

payload = {
    "processor_type": "sandbox_pix",
    "amount": 50,
    "document_number": "12345678000195",
    "merchant_transaction_id": "50000000-0000-4000-8000-000000000003",
    "pix_key_type": "email"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    processor_type: 'sandbox_pix',
    amount: 50,
    document_number: '12345678000195',
    merchant_transaction_id: '50000000-0000-4000-8000-000000000003',
    pix_key_type: 'email'
  })
};

fetch('https://gateway.staging.azentech.dev/api/pix/merchant/withdrawal', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "transaction": {
    "id": "10000000-0000-4000-8000-000000000001",
    "merchant_id": "20000000-0000-4000-8000-000000000001",
    "user_id": "30000000-0000-4000-8000-000000000001",
    "processor_id": "40000000-0000-4000-8000-000000000001",
    "merchant_transaction_id": "50000000-0000-4000-8000-000000000003",
    "transaction_type": "pix",
    "first_name": null,
    "last_name": null,
    "email": null,
    "updated_at": "2026-10-23T14:30:00+00:00",
    "created_at": "2026-10-23T14:30:00+00:00",
    "events": [
      {
        "id": "60000000-0000-4000-8000-000000000001",
        "success": true,
        "status": "pending_settlement",
        "event_type": "payment",
        "amount": "50.00",
        "ip_address": null,
        "processor_code": null,
        "processor_message": null,
        "processor_transaction_id": "sandbox-event-1001",
        "batch_id": null,
        "qrcode": null,
        "qrcode_image": "",
        "pix_key_type": "email",
        "pix_key_value": "destino@example.com",
        "pix_message": "Pagamento para: CONTA DEMO",
        "updated_at": "2026-10-23T14:30:00+00:00",
        "created_at": "2026-10-23T14:30:00+00:00"
      }
    ],
    "document_number": "12345678000195",
    "status": "pending",
    "flow_type": "cashout",
    "error": null,
    "e2e_id": null,
    "source": "settlement",
    "tag": null
  }
}

POST

api

pix

merchant

withdrawal

Criar retirada Pix

curl --request POST \
  --url https://gateway.staging.azentech.dev/api/pix/merchant/withdrawal \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "processor_type": "sandbox_pix",
  "amount": 50,
  "document_number": "12345678000195",
  "merchant_transaction_id": "50000000-0000-4000-8000-000000000003",
  "pix_key_type": "email"
}
'

import requests

url = "https://gateway.staging.azentech.dev/api/pix/merchant/withdrawal"

payload = {
    "processor_type": "sandbox_pix",
    "amount": 50,
    "document_number": "12345678000195",
    "merchant_transaction_id": "50000000-0000-4000-8000-000000000003",
    "pix_key_type": "email"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    processor_type: 'sandbox_pix',
    amount: 50,
    document_number: '12345678000195',
    merchant_transaction_id: '50000000-0000-4000-8000-000000000003',
    pix_key_type: 'email'
  })
};

fetch('https://gateway.staging.azentech.dev/api/pix/merchant/withdrawal', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "transaction": {
    "id": "10000000-0000-4000-8000-000000000001",
    "merchant_id": "20000000-0000-4000-8000-000000000001",
    "user_id": "30000000-0000-4000-8000-000000000001",
    "processor_id": "40000000-0000-4000-8000-000000000001",
    "merchant_transaction_id": "50000000-0000-4000-8000-000000000003",
    "transaction_type": "pix",
    "first_name": null,
    "last_name": null,
    "email": null,
    "updated_at": "2026-10-23T14:30:00+00:00",
    "created_at": "2026-10-23T14:30:00+00:00",
    "events": [
      {
        "id": "60000000-0000-4000-8000-000000000001",
        "success": true,
        "status": "pending_settlement",
        "event_type": "payment",
        "amount": "50.00",
        "ip_address": null,
        "processor_code": null,
        "processor_message": null,
        "processor_transaction_id": "sandbox-event-1001",
        "batch_id": null,
        "qrcode": null,
        "qrcode_image": "",
        "pix_key_type": "email",
        "pix_key_value": "destino@example.com",
        "pix_message": "Pagamento para: CONTA DEMO",
        "updated_at": "2026-10-23T14:30:00+00:00",
        "created_at": "2026-10-23T14:30:00+00:00"
      }
    ],
    "document_number": "12345678000195",
    "status": "pending",
    "flow_type": "cashout",
    "error": null,
    "e2e_id": null,
    "source": "settlement",
    "tag": null
  }
}

Comportamento observado

O Gateway força source para settlement e exige CNPJ.
Quando pix_key_value é omitido, o Gateway copia document_number antes de validar a chave. A chave é validada como UUID, telefone, CPF ou CNPJ, ou email conforme pix_key_type.
Se pix_message não for enviado, o Gateway usa Pagamento para: {alias do processador}.
bank_accounts_allowed é repassado sem validação de formato no controller. A estrutura aceita e o efeito dependem do processador ativo.
As regras de bancos bloqueados e de titularidade dependem do processador e da configuração ativa. A documentação não promete um resultado sem essa confirmação.

Os exemplos usam identificadores e credenciais sintéticos. Os resultados do processador dependem do credenciamento e da configuração do estabelecimento.

Authorizations

Authorization

string

header

required

Token de acesso fornecido para o estabelecimento.

Body

application/json

processor_type

string

required

Tipo do processador habilitado para o estabelecimento.

amount

number

required

Valor em reais, com no máximo duas casas decimais. Deve ser maior que zero e menor que 99.999.999 antes da aplicação dos limites do processador.

Must be a multiple of 0.01

document_number

string

required

CNPJ do estabelecimento.

merchant_transaction_id

string

required

Identificador da transação no estabelecimento.

Maximum string length: 255

pix_key_type

enum<string>

required

Tipo da chave Pix.

Available options:

phone,

document,

email,

random

first_name

string | null

Nome opcional. O controller desta rota não valida o campo.

pix_key_value

string

Valor da chave Pix. O formato é validado conforme pix_key_type.

pix_message

string | null

Mensagem Pix. Máximo de 140 caracteres.

Maximum string length: 140

bank_accounts_allowed

object[] | null

Contas bancárias permitidas para o pagamento. O controller não valida o formato; os campos aceitos e seu efeito dependem do processador ativo.

Show child attributes

tag

string | null

Tag da transação. Conforme a configuração do estabelecimento, pode ser obrigatória, livre ou restrita a CPF ou CNPJ. Tags que contêm internal suprimem os webhooks de pagamento.

Maximum string length: 50

Response

Transação criada ou atualizada.

transaction

object

required

Show child attributes

Pix

Transações

Saldos

Relatórios

Sandbox

Webhooks

Criar retirada Pix

Comportamento observado

Authorizations

Body

Response

​Comportamento observado

Authorizations

Body

Response

Comportamento observado