O conjunto de APIs Pix tem como objetivo criar links para pagamento de Pix, consultar seu status e realizar uma devolução de valores. Esse conjunto de APIs é voltado tanto para fornecedores quanto para varejistas.
Para ter acesso a qualquer uma das APIs deve ser feita uma solicitação a quem te ajuda na Blu, seja um Executivo de Contas ou o suporte, para que a mesma seja encaminhada para o time responsável.
Orientações
Para ter acesso aos dados, é necessário um token.
Os campos obrigatórios devem ser preenchidos.
Para ter acesso ao Pix copia e cola e ao QR Code deve ser utilizada a API de Consultar Pix
Criar Pix
Criar Pix
POSThttps://api.blu.com.br/b2b/pix/
Esta API é responsável por retornar o código para que sejam consultados os dados do Pix.
Objetivo
Possibilitar aos nossos fornecedores e varejistas possam criar cobranças Pix.
Fique atento!para visualizar os exemplos dos responses abaixo, clique no botão > para abrir o campo de leitura.
Esta API é responsável por consultar os dados do Pix criado via API e saber seu status.
Objetivo
Possibilitar aos nossos fornecedores e varejistas possam consultar os dados e status de um um Pix criado via API por meio de seu id.
Fique atento!para visualizar os exemplos dos responses abaixo, clique no botão > para abrir o campo de leitura.
Query Parameters
Headers
{"id":"XXXXXXXXXXXXXX-XXXXXXX-XXXXXX-XXXXXXX-XXXXXXXXXXXX","tx_id":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX","transaction_token":"XXXXXXXX-XXXXXXX-XXXXXX-XXXXXXX-XXXXXX-XXXXXXXXXXXX","status":"status retornado","expires_at":"YYYY-MM-DD","description":"Descrição do Pix","description_internal":"Descrição do Pix no Portal Blu","value":"00.00","created_at":"YYYY-MM-DDTHH:MM:SS.SSSZ","emv":"pix copia e cola","qr_code_base64":"url do qr code"}
{"message":"Usuário não encontrado para o token informado."}
{"message":"Nenhum pix encontrado para o identificador informado."}
{"id":"XXXXXXXXXXXXXX-XXXXXXX-XXXXXX-XXXXXXX-XXXXXXXXXXXX","tx_id":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX","transaction_token":"XXXXXXXX-XXXXXXX-XXXXXX-XXXXXXX-XXXXXX-XXXXXXXXXXXX","status":"status retornado","expires_at":"YYYY-MM-DD","description":"Descrição do Pix","description_internal":"Descrição do Pix no Portal Blu","value":"00.00","created_at":"YYYY-MM-DDTHH:MM:SS.SSSZ","emv":"pix copia e cola","qr_code_base64":"url do qr code","payment_inbounds": [ {"data": {"id":"XXXXXXXXXXXXX-XXXXXX-XXXXXX-XXXXX-XXXXXXXXXXXX","type":"payment_inbound","attributes": {"debit_party": {"account":"XXXXXXXXXXX","bank":"XXXXXXXX","branch":"XXX","personType":"XXXXXXXX","taxId":"XXXXXXXXXXXX","accountType":"XXXXXX","name":"Nome de quem pagou o Pix" },"pactual_id":"XXXXXXXXXXXXX-XXXXXX-XXXXXX-XXXXX-XXXXXXXXXXXX","autorizathion_code":"XXXXXXXXXXXXXXXXXXXXXXXXXXX","movement_id":"XXXXXXXX","value":"00.00","debt_id":"XXXXXXXXXXXXX-XXXXXX-XXXXXX-XXXXX-XXXXXXXXXXXX","created_at":"YYYY-MM-DDTHH:MM:SS.SSSZ","description":"Descrição do Pix","receiver_key":null,"tx_id":"XXXXXXXXXXXXXXXXXXXXXXXXXXX" } ]}
{"id":"XXXXXXXXXXXXXX-XXXXXXX-XXXXXX-XXXXXXX-XXXXXXXXXXXX","tx_id":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX","transaction_token":"XXXXXXXX-XXXXXXX-XXXXXX-XXXXXXX-XXXXXX-XXXXXXXXXXXX","status":"status retornado","expires_at":"YYYY-MM-DD","description":"Descrição do Pix","description_internal":"Descrição do Pix no Portal Blu","value":"00.00","created_at":"YYYY-MM-DDTHH:MM:SS.SSSZ","emv":"pix copia e cola","qr_code_base64":"url do qr code","payment_inbounds": [ {"data": {"id":"XXXXXXXXXXXXX-XXXXXX-XXXXXX-XXXXX-XXXXXXXXXXXX","type":"payment_inbound","attributes": {"debit_party": {"account":"XXXXXXXXXXX","bank":"XXXXXXXX","branch":"XXX","personType":"XXXXXXXX","taxId":"XXXXXXXXXXXX","accountType":"XXXXXX","name":"Nome de quem pagou o Pix" },"pactual_id":"XXXXXXXXXXXXX-XXXXXX-XXXXXX-XXXXX-XXXXXXXXXXXX","autorizathion_code":"XXXXXXXXXXXXXXXXXXXXXXXXXXX","movement_id":"XXXXXXXX","value":"00.00","debt_id":"XXXXXXXXXXXXX-XXXXXX-XXXXXX-XXXXX-XXXXXXXXXXXX","created_at":"YYYY-MM-DDTHH:MM:SS.SSSZ","description":"Descrição do Pix","receiver_key":null,"tx_id":"XXXXXXXXXXXXXXXXXXXXXXXXXXX","refunds": [ {"data": {"id":"XXXXXXXXXXXXX-XXXXXX-XXXXXX-XXXXX-XXXXXXXXXXXX","type":"refund","attributes": {"value":"00.00","client_transaction_refund_id":"XXXXXXXXXXXXX-XXXXXX-XXXXXX-XXXXX-XXXXXXXXXXXX","requester_uuid":"XXXXXXX","status":"confirmed","return_identification_transiting_id":"XXXXXXXXXXXXXXXXXXXXXXXXXXX","reason":"Mensagem de Devolução","requested_at":"YYYY-MM-DDTHH:MM:SS.SSSZ","liquidated_at":null,"payment_inbound_id":"XXXXXXXXXXXXX-XXXXXX-XXXXXX-XXXXX-XXXXXXXXXXXX","original_e2e_id":"XXXXXXXXXXXXXXXXXXXXXXXXXXX","original_pactual_id":"XXXXXXXXXXXXX-XXXXXX-XXXXXX-XXXXX-XXXXXXXXXXXX","pactual_id":"XXXXXXXXXXXXX-XXXXXX-XXXXXX-XXXXX-XXXXXXXXXXXX" [...] } } ] } ]}
Para realizar uma Devolução de Pix deve ser utilizado o campo movement_id que aparece após o pagamento do Pix.
O retorno da consulta do Pix é um arquivo JSON, contendo as informações do Pix e seu status. Abaixo vemos todos os campos que serão retornados:
Devolução de Pix
Após o pagamento de um Pix é possível devolvê-lo de forma total ou parcial e para isso a API de Devolução de Pix deve ser utilizada. Para realizar a
Devolução de Pix
POSThttps://api.blu.com.br/b2b/pix/refund
Esta API possibilita devolver total ou parcialmente um Pix criado via API.
Objetivo
Possibilitar aos nossos fornecedores e varejistas possam devolver valores cobrados via Pix.
Fique atento!para visualizar os exemplos dos responses abaixo, clique no botão > para abrir o campo de leitura.
{"message":"Usuário não encontrado para o token informado."}
{"success":false,"message":"A validação falhou: Valor deve ser maior que 0","statusCode":422}
A API Devolução de Pix não critica se o valor devolvido é ou não maior que o valor da transação. Contudo, a operação só é executada e aparece na sessão refunds da Consulta Pix se o valor ou igual ou menor que o valor do Pix pago.
Os cURLs para executar as APIs do Link de Pagamento são exibidos abaixo, bem como a collection com todas as APIs para ser importada no Postman está em anexo na página.