A API de Pix permite criar cobranças, consultar o status de um pagamento e realizar devoluções. Pode ser utilizada tanto por fornecedores quanto por varejistas.
Requisitos
Chave Pix criada na sua conta digital Blu.
()
Token de autenticação para usar as APIs
Para receber seu token, fale com seu Executivo de Contas ou com o suporte da Blu. Eles vão liberar o acesso para você.
Orientações
Preencha todos os campos obrigatórios ao fazer suas requisições.
Para obter o Pix copia e cola ou o QR Code, use a API Consultar Pix.
Criar Pix
POSThttps://api.blu.com.br/b2b/pix/
Este endpoint cria uma cobrança Pix com as informações enviadas, como valor e descrição, para que o cliente realize o pagamento.
Ele retorna um identificador único (UUID), que permite da cobrança e obter o código QR ou o código de pagamento (copia e cola).
Headers
Chave
Valor
Origatório
Descrição
Authorization
<token_de_autenticação>
Sim
Token para autenticação da API
Content-Type
application/json
Sim
Indica que o corpo da requisição é JSON
Request Body
{
"expires_at": "AAAA-MM-DD",
"description": "Descrição Externa do Pix",
"description_internal": "Descrição Interna do Pix",
"value": "0.00"
}
Campo
Tipo
Obrigatório
Descrição
expires_at
string
Sim
Data de expiração da cobrança no formato AAAA-MM-DD. Após essa data, o Pix não poderá ser pago.
description
string
Não
Descrição externa que será exibida para o cliente no momento do pagamento.
description_internal
string
Não
Descrição interna, utilizada apenas para controle e organização pela empresa. Não aparece para o cliente.
value
string
Sim
Valor da cobrança em formato monetário, com duas casas decimais. Exemplo: "100.50" para representar R$ 100,50.
O retorno da criação do Pix é um JSON com um único campo: o transaction_token (UUID). Esse token deve ser usado na API Consultar Pix para obter os dados do Pix e acompanhar o status da transação.
Exemplos de erro
{
"message": "Usuário não encontrado para o token informado."
}
{
"success": false,
"message": "A validação falhou: Data de expiração não pode estar no passado",
"statusCode": 422
}
{
"success": false,
"message": "A validação falhou: Valor deve ser maior que 0",
"statusCode": 422
}
var request = require('request');
var options = {
'method': 'GET',
'url': 'https://api.blu.com.br/b2b/pix/{transaction-token}',
'headers': {
'Authorization': 'Bearer XXXXXXXXXXXXXXXXXX'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
Devolução de Pix
POSThttps://api.blu.com.br/b2b/pix/refund
Este endpoint realiza a devolução total ou parcial de um Pix já pago. A partir dos dados enviados, ele registra a devolução para que o valor seja retornado ao pagador.
Importante!
A API de Devolução de Pix não impede que você informe um valor maior do que o pago.
Mas a devolução só acontece e aparece na seção refunds da Consulta Pix se o valor for igual ou menor ao valor pago.
Exemplos de erro
{
"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
}
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://api.blu.com.br/b2b/pix/refund',
'headers': {
'Authorization': 'Bearer XXXXXXXXXXXXXXXXXXXXXXX',
'Content-Type': 'application/json'
},
body: JSON.stringify({
"movement_id": "XXXXXXXXXXXXXXXXXXXXXX",
"reason": "Motivo para Devolução",
"value": "00.00"
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
Webhook Pix
Esta ferramenta notifica seu sistema somente quando um Pix é pago. A Blu envia uma notificação com os detalhes da transação no momento em que o pagamento é confirmado.
API de teste
Use esta API para testar e visualizar o retorno do webhook quando o status de um Pix for atualizado.
PUThttps://api.blu.com.br/b2b/webhook/pix
Orientações:
Forneça a URL de callback ao time responsável pela implantação, para que você receba as notificações.
Use o token de autenticação no header da requisição.
Header
Chave
Valor
Descrição
Obrigatório
Accept
version=1
Não
Content-Type
application/json
Não
Authorization
xxxxxxxxxxxxx
Token de operação.
Sim
Cookie
xxxxxxxxxxxxxxxxxxxxxx
Não
Webhook
"pix"
Tipo da cobrança
Sim
Body
{
"status" : "success"
}
Você também pode deixar o body da requisição vazio — o comportamento será o mesmo.
