API Link de Pagamento

O conjunto de APIs Link de Pagamento tem como objetivo criar links da Pagamento da Blu bem como consultar seu status. 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.

• Deve ser respeitada a diferença no envio de Link de Pagamento para CNPJ e para CPF.

Criar Link de Pagamento

Criar Link de Pagamento

POST https://api-hlg.blu.com.br/b2b/payment_links

Esta API é responsável por retornar a criação de um Link de Pagamento Blu.

Objetivo

Possibilitar aos nossos fornecedores e varejistas possam criar Links de Pagamento Blu para clientes CNPJ ou CPF.

Fique atento! para visualizar os exemplos dos responses abaixo, clique no botão > para abrir o campo de leitura.

Headers

Name	Type	Description
Authorization*	string	Token de operação.

Request Body

Name	Type	Description
amount*	string	Obrigatório. Valor do pagamento que será pago pelo Link de Pagamento.
email_notification*	string	Obrigatório. E-mail do cobrado que será notificado sobre a criação do Link de Pagamento.
phone_notification*	string	Obrigatório. Telefone do cobrado pelo Link de Pagamento. Deve possuir 11 dígitos (DDD+número).
description	string	Descrição do Link de Pagamento.
document_type*	string	Obrigatório. Deve ser preenchido com “CNPJ” ou “CPF“.
customer_cnpj*	string	Obrigatório caso o document_type seja CNPJ. CNPJ do cobrado pelo Link de Pagamento.
max_installment_number*	string	Obrigatório. Número máximo de parcelas que o cobrado poderá parcelar o pagamento.

200: OK Link de Pagamento criado

{
    "errors": [],
    "link_url": "https://link.blu.com.br/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "trace_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "expiration_date": "aaaa-mm-ddT00:00:00.000-03:00",
    "smart_checkout_url": "https://link.blu.com.br/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "message": "Olá, utilize o link abaixo para fazer o pagamento de *R$00,00* para *Cobrador*🔗 *Link para pagamento*https://link.blu.com.br/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx📝 *Descrição*Descrição do Link🗓 Você deve efetuar o pagamento até dd/mm/aaaa às hh:mm-Link Blu. Simples, rápido e seguro."
}

401: Unauthorized Token inválido

{
    "message": "Usuário não encontrado para o token informado."
}

422: Unprocessable Entity amount inválido

{
    "message": "A validação falhou: Valor deve ser maior que 0"
}

422: Unprocessable Entity amount vazio

{
    "message": "A validação falhou: Valor não é um número"
}

422: Unprocessable Entity email_notification inválido

{
    "message": "A validação falhou: Customer email não é válido"
}

422: Unprocessable Entity phone_notification inválido

{
    "message": "O campo phone_notification não está correto, favor verificar!"
}

422: Unprocessable Entity customer_cnpj inválido

{
    "message": "A validação falhou: CNPJ não é válido"
}

422: Unprocessable Entity document_type cpf com customer_cnpj preenchido

{
    "message": "A validação falhou:  O campo customer_cnpj não deve ser preenchido para o document_type cpf"
}

422: Unprocessable Entity document_type cnpj sem customer_cnpj preenchido

{
    "message": "A validação falhou: CNPJ não é válido"
}

422: Unprocessable Entity max_installment_number vazio

{
    "message": "O campo max_installment_number não está correto, favor verificar!"
}

422: Unprocessable Entity max_installment_number inválido

{
    "message": "A validação falhou: O número máximo de parcelas deve ser maior que 0"
}

422: Unprocessable Entity max_installment_number decimal

{
    "message": "A validação falhou: O número máximo de parcelas deve um número inteiro"
}

422: Unprocessable Entity max_installment_number maior que 12

{
    "message": "A validação falhou: O número máximo deve ser igual ou menor a 12."
}

Existem diferenças no preenchimento do body da chamada quando o Link de Pagamento é para um CNPJ, esta diferença é controlada pelo campo document_type. Quando o pagamento é para CNPJ o campo customer_cnpj deve ser obrigatoriamente preenchido. Quando o pagamento é para CPF o campo customer_cnpj deve ser preenchido como null.

O retorno da criação do Link de Pagamento é um arquivo JSON, contendo as informações necessárias para uso e acompanhamento do Link de Pagamento. Abaixo vemos todos os campos que serão retornados:

Campos da Transação	Data Type	Descrição
erros	string	Conjunto de erros que pode ter ocorrido na criação do Link de Pagamento
link_url	string	Url do Link de Pagamento criado.
id	string	Id interno da Blu para o Link de Pagamento para permitir a rastreabilidade da operação.
trace_key	string	Id interno da Blu para o Link de Pagamento para permitir a rastreabilidade da operação.
expiration_date	string	Data de expiração do Link de Pagamento no formato “aaaa-mm-ddThh:mm:ss.sss-3:00”
smart_checkout_url	string	Url do smart checkout para o Link de Pagamento criado.
message	string	Mensagem com informações sobre o Link de Pagamento criado e sua url.

O campo id será utilizado na API Consultar Link de Pagamento para localizar o Link da Pagamento na Blu e por isso deve ser gravado.

Consultar Link de Pagamento

O id do Link de Pagamento será utilizado como parâmetro na url da requisição.

Consultar Link de Pagamento

GET https://api-hlg.blu.com.br/b2b/payment_links/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Esta API é responsável por consultar um Link de Pagamento Blu já criado e saber seu status.

Objetivo

Possibilitar aos nossos fornecedores e varejistas possam consultar o staus de um Link de Pagamento Blu 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

Name	Type	Description
id*	string	id do Link de Pagamento.

Headers

Name	Type	Description
Autorization*	string	Token de operação.

200: OK Consulta realizada

{
    "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "client_name": "Cliente",
    "created_by": "Client",
    "link_url": "https://link-staging.blu.com.br/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "customer_email": "[e-mail]",
    "customer_name": "[e-mail]",
    "wpp": "11999999999",
    "description": "Descrição",
    "amount": "00.00",
    "status": "status",
    "created_at": "aaaa-mm-ddT00:00:00.000-03:00",
    "max_installments": 0,
    "expiration_date": "aaaa-mm-ddT00:00:00.000-03:00",
    "customer_cnpj": "00000000000000"
}

401: Unauthorized Token inválido

{
    "message": "Usuário não encontrado para o token informado."
}

404: Not Found id inválido

{
    "message": "Nenhuma Link de Pagamento encontrado para o identificador informado."
}

O retorno da consulta do Link de Pagamento é um arquivo JSON, contendo as informações de status do Link de Pagamento. Abaixo vemos todos os campos que serão retornados:

Campos da Transação	Data Type	Descrição
id	string	Id interno da Blu para o Link de Pagamento que permite a rastreabilidade da operação.
client_name	string	Nome do cliente.
created_by	string	Nome do criador do Link de Pagamento.
link_url	string	Url do Link de Pagamento criado.
customer_email	string	E-mail do cobrado pelo Link de Pagamento.
customer_name	string	E-mail do cobrado pelo Link de Pagamento.
wpp	string	Telefone do cobrado pelo Link de Pagamento.
description	string	Descrição do Link de Pagamento.
amount	string	Valor do pagamento que será pago pelo Link de Pagamento.
status	status	Status do Link de Pagamento.
created_at	string	Data de criação do Link de Pagamento no formato “aaaa-mm-ddThh:mm:ss.sss-3:00”
max_installments	string	Número máximo de parcelas que o cobrado poderá parcelar o pagamento.
expiration_date	string	Data de expiração do Link de Pagamento no formato “aaaa-mm-ddThh:mm:ss.sss-3:00”
client_uuid	string	Identificação interna da Blu para o cliente.
customer_cnpj	string	Caso o document_type seja CNPJ é preenchido com o CNPJ do cobrado pelo Link de Pagamento.

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.

Criar Link de Pagamento

cURL

curl --location 'https://api-hlg.blu.com.br/b2b/payment_links' \
--header 'Authorization: XXXXXXXXXXXXXXXXXX' \
--header 'Content-Type: application/json' \
--header 'Accept: version=1' \
--data-raw '  {
    "amount":"0.00", 
    "email_notification":"[e-mail]", 
    "phone_notification":"21999999999", 
    "customer_cnpj":"00000000000000", 
    "description":"Descrição", 
    "document_type":"cnpj",
    "max_installment_number":"00"
    }'

NodeJs

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://api-hlg.blu.com.br/b2b/payment_links',
  'headers': {
    'Authorization': 'XXXXXXXXXXXXXXXXXX',
    'Content-Type': 'application/json',
    'Accept': 'version=1'
  },
  body: JSON.stringify({
    "amount": "1.00",
    "email_notification": "[e-mail]",
    "phone_notification": "11999999999",
    "customer_cnpj": "00000000000000",
    "description": "Descrição",
    "document_type": "cnpj",
    "max_installment_number": "00"
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Consultar Link de Pagamento

cURL

curl --location 'https://api-hlg.blu.com.br/b2b/payment_links/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' \
--header 'Authorization: XXXXXXXXXXXXXXXXXXX' \
--header 'Content-Type: application/json' \
--header 'Accept: version=1' \

NodeJs

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://api-hlg.blu.com.br/b2b/payment_links/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
  'headers': {
    'Authorization': 'XXXXXXXXXXXXXXXXX',
    'Content-Type': 'application/json',
    'Accept': 'version=1'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

789B

APIs Link de Pagamento.postman_collection.zip

archive