Pular para o conteúdo principal

Transferência PIX

POST/api/v1/bank/wallet/transfer/pix/Bearer Token

Cabeçalhos da requisição

CabeçalhoValorObrigatório
AuthorizationBearer {A55_ACCESS_TOKEN}Sim
Content-Typeapplication/jsonSim
Idempotency-KeyUUID v4Recomendado

Corpo da requisição

CampoTipoObrigatórioDescrição
wallet_uuidstring (UUID)SimCarteira de origem da transferência
amountnumberSimValor da transferência em BRL (ex.: 500.00)
currencystringSimDeve ser BRL
pix_key_typestringSimcpf, cnpj, email, phone, random_key
pix_keystringSimValor da chave PIX correspondente ao tipo
recipient_namestringSimNome completo do destinatário
recipient_tax_idstringSimCPF ou CNPJ do destinatário
descriptionstringNãoDescrição da transferência
reference_idstringNãoSua referência interna para conciliação

Campos da resposta

CampoTipoDescrição
transfer_uuidstringIdentificador único da transferência
statusstringprocessing, completed, failed
amountnumberValor transferido
currencystringBRL
pix_key_typestringTipo de chave PIX utilizada
pix_keystringChave PIX de destino
recipient_namestringNome do destinatário confirmado
created_atstringTimestamp de criação ISO 8601
completed_atstringTimestamp de conclusão ISO 8601 (quando disponível)

Códigos de status HTTP

StatusDescrição
200Transferência iniciada com sucesso
400Chave PIX inválida ou campos obrigatórios ausentes
401Token Bearer inválido ou expirado
403Permissões insuficientes ou saldo insuficiente na carteira
404Carteira não encontrada
409Transferência duplicada (mesma Idempotency-Key)
422Erro de validação (tipo de chave inválido, valor inválido)
429Limite de requisições excedido
500Erro interno do servidor — tente novamente com backoff exponencial

Exemplos de código

curl -s -X POST https://core-manager.a55.tech/api/v1/bank/wallet/transfer/pix/ \
-H "Authorization: Bearer $A55_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: 770e8400-e29b-41d4-a716-446655440002" \
-d '{
"wallet_uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"amount": 500.00,
"currency": "BRL",
"pix_key_type": "cpf",
"pix_key": "123.456.789-09",
"recipient_name": "João Santos",
"recipient_tax_id": "123.456.789-09",
"description": "Supplier payment #2048",
"reference_id": "PAY-2048"
}'

Exemplo de resposta de erro

{
"transfer_uuid": null,
"status": "error",
"message": [
{
"code": "INSUFFICIENT_BALANCE",
"source": "wallet",
"description": "Wallet balance is insufficient for this transfer amount"
}
]
}