Referência / PIX

PIX Out (Envio)

POST/api/v1/hub/transactions/out

Realiza uma transferência PIX para a chave de destino informada e retorna o identificador da operação.

Ambiente

Autenticação Basic

Base64

Basic:

Esta requisição pode criar, alterar ou remover dados no ambiente selecionado.

cURL

Exemplo gerado

1curl --request POST \2  --url 'https://staging.sharktecnologia.com/api/v1/hub/transactions/out' \3  --header 'accept: application/json' \4  --header 'Authorization: Basic BASE64(SUA_API_KEY:SEU_SECRET_KEY)' \5  --header 'content-type: application/json' \6  --data '{7  "amount": 5000,8  "pix_key": "usuario@exemplo.com",9  "pix_type": "EMAIL",10  "description": "Transferência para fornecedor"11}'

Resposta

Clique em Executar para enviar a requisição e visualizar a resposta aqui.

Parâmetros do body

4 campos

amountintegerObrigatório

Valor em centavos.

pix_keystringObrigatório

Chave PIX de destino.

pix_typestring · enumObrigatório

Tipo da chave PIX.

Valores: CPFCNPJEMAILPHONE

descriptionstringOpcional

Descrição da transação.

Resposta

200HubPixOutResponseDTO

Transferência PIX realizada com sucesso.

JSON · Resposta de sucesso

{
  "status": "success",
  "transaction_id": "xyz789-abc123-def456",
  "message": "Transferência realizada com sucesso"
}

Campos da resposta

3 campos

statusstringObrigatório

Status da transação.

transaction_idstringOpcional

Identificador único da transação.

messagestringOpcional

Mensagem descritiva sobre o resultado da operação.

Status HTTP

200

Transferência PIX realizada com sucesso.

401

Credenciais inválidas, token mal formatado ou uso de chaves em ambiente incorreto.

422

Dados de entrada inválidos ou usuário sem Provider configurado.

500

Erro interno do servidor.

501

Funcionalidade não implementada para o provedor configurado.