Referência / PIX

PIX In (Recebimento)

POST/api/v1/hub/transactions/in

Cria uma cobrança PIX para recebimento e retorna os dados necessários para gerar o QR Code de pagamento.

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/in' \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": 1000,8  "description": "Pagamento de serviço"9}'

Resposta

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

Parâmetros do body

3 campos

amountintegerObrigatório

Valor em centavos.

descriptionstringOpcional

Descrição da transação.

payloadstringOpcional

String EMV ou QR Code existente para reutilização.

Resposta

200HubPixInResponseDTO

Cobrança PIX criada com sucesso.

JSON · Resposta de sucesso

{
  "status": "pending",
  "transaction_id": "abc123-def456-ghi789",
  "qr_code": "00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890520400005303986540510005802BR5913NOME EMPRESA6009SAO PAULO62070503***6304ABCD",
  "qr_code_name": "qr_empresa_123",
  "expiration_date": "2026-03-18T23:59:59"
}

Campos da resposta

5 campos

statusstringObrigatório

Status da transação.

transaction_idstringOpcional

Identificador único da transação.

qr_codestringOpcional

Código EMV do PIX copia e cola.

qr_code_namestringOpcional

Nome identificador do QR Code.

expiration_datestring · date-timeOpcional

Data e hora de expiração do QR Code.

Status HTTP

200

Cobrança PIX criada 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.