API Link de Pagamento

A API de Link de Pagamento da Blu permite criar links de pagamento e consultar seu status. Ela pode ser utilizada tanto por fornecedores quanto por varejistas.

Para acessar:

Solicite o acesso para o seu Executivo de Contas
Aguarde a aprovação do time responsável e receba o token de autenticação para acessar os dados.

Orientações:

O token de autenticação é obrigatório para acessar a API.
Preencha todos os campos obrigatórios.
O formato do Link de Pagamento muda conforme o tipo de documento (CNPJ ou CPF). Certifique-se de seguir a estrutura correta.

API Criar Link de Pagamento

Use essa API para criar um Link de Pagamento Blu.

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

Como funciona

Permite criar um link de pagamento para clientes com CNPJ ou CPF.
Disponível para fornecedores e varejistas.

Headers

Name

Type

Description

Authorization*

string

Token de operação.

Body

Name

Type

Description

Observação

amount*

string

Valor do pagamento que será pago pelo Link de Pagamento.

Obrigatório

email_notification

string

E-mail do cobrado que será notificado sobre a criação do Link de Pagamento.

phone_notification

string

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

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.

Para CNPJ: preencha com o CNPJ do pagador.
Para CPF: envie o campo como null.

max_installment_number

string

Obrigatório. Número máximo de parcelas que o cobrado poderá parcelar o pagamento.

issuer_rate_forwarding

boolean (true ou false)

Indica se o link de pagamento terá repasse de taxas.

Se vazio ou null, será interpretado como false.

Response

Possíveis retornos da requisição:

{
    "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."
}

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

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

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

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

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

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

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

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

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

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

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

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

Descrição dos campos

Campos da Transação

Data Type

Descrição

errors

string

Lista de erros que pode ter ocorrido na criação do Link de Pagamento

link_url

string

Url do Link de Pagamento criado.

string

Identificador único da Blu para o Link de Pagamento, usado para rastrear e acompanhar a operação.

trace_key

string

Identificador interno da Blu para o Link de Pagamento, utilizado para rastrear e monitorar a 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 é utilizado na API Consultar Link de Pagamento para localizar o Link da Pagamento na Blu e por isso deve ser gravado.

Curl

Use este arquivo para fazer a requisição da API:

Antes de executar:

Substitua xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx pelo ID do link de pagamento.
No cabeçalho Authorization, informe seu token de autenticação.

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":"[email protected]", 
    "phone_notification":"21999999999", 
    "customer_cnpj":"00000000000000", 
    "description":"Descrição", 
    "document_type":"cnpj",
    "max_installment_number":"00"
    }'

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": "[email protected]",
    "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);
});

API Consultar Link de Pagamento

Use esta API para verificar o status de um link de pagamento Blu depois de criado.

GET https://api-hlg.blu.com.br/b2b/payment_links/[id do link]

Como funciona

Retorna as informações do link de pagamento com base no ID informado.
Disponível para fornecedores e varejistas.

Query Parameters

Name

Tipo

Descrição

id*

string

id do Link de Pagamento.

Headers

Name

Tipo

Descrição

Autorization*

string

Token de operação.

Responses

Possíveis retornos da requisição:

{
    "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": "[email protected]",
    "customer_name": "[email protected]",
    "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"
}

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

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

Descrição dos campos:

Campo

Tipo

Descrição

string

Identificador interno da Blu para o link de pagamento, utilizado para rastrear e acompanhar a operação.

client_name

string

Nome do cliente.

created_by

string

Nome do usuário que criou o 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

Nome 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 cobrado

status

string

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.

Curl

Use este arquivo para fazer a requisição da API:

Antes de executar:

Substitua xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx pelo ID do link de pagamento.
No cabeçalho Authorization, informe seu token de autenticação.

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' \

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

Webhook Link de pagamento

Esta ferramenta notifica seu sistema sempre que um link de pagamento for atualizado. A Blu enviará uma notificação informando o novo status, que pode ser:

Pago: o pagamento foi confirmado.
Expirado: o link não foi pago dentro do prazo.

API de teste do webhook

Use esta API para testar e visualizar o retorno do webhook quando o status do link de pagamento é atualizado.

PUT https://api.blu.com.br/b2b/webhook

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.

Header

Name

Valor

Descrição

version=1

Content-Type

application/json

Authorization*

xxxxxxxxxxxxx

Token de operação.

Webhook

"link"

Body

Para testar um link de pagamento pago, envie :

{
    "status" : "success"
}

Você também pode deixar o body da requisição vazio — o comportamento será o mesmo.

Para testar um link de pagamento expirado, envie:

{
    "status" : "expired"
}

Responses

{
	"id": "946e2411-65dc-450e-95fd-9834lkjl",
	"business_name": "Blu ",
	"cpf_cnpj": "23881758001234",
	"installments": 12,
	"client_name": "Blu LTDA",
	"paid_at": "2024-04-20T15:14:58.000-03:00",
	"created_by": "Fred",
	"link_url": "https://link.blu.com.br/946e2411-65dc-450e-95fd-9834lkjl",
	"customer_email": "Não informado",
	"wpp": "Não informado",
	"payment_link_transaction": {
		"id": "946e2411-65dc-450e-95fd-9834lkjl",
		"provider_nsu_code": "202402023101",
		"provider_authorization_code": "123456",
		"happened_at": "2024-04-20T15:14:58.000-03:00",
		"acquirer_id": 441,
		"installments": 12,
		"transaction_category_id": 93,
		"status": "confirmed",
		"created_at": "2024-04-20T15:14:25.745-03:00"
	},
	"last_payment_link_intent": {
		"id": "946e2411-65dc-450e-95fd-9834lkjl",
		"credit_card_number": "476331******2657",
		"cpf_cnpj": "124.135.606-02",
		"kind": "credit",
		"phone": "9090909070",
		"email": "[email protected]",
		"device": "smartphone",
		"user_agent": "Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/134.0.0.0 Mobile Safari/537.36",
		"birth_date": "1980-10-19",
		"address": {
			"cep": "25070300",
			"city": "Duque de Caxias",
			"state": "RJ",
			"number": "296",
			"street": "Rua Caio Notini",
			"district": "Divinópolis",
			"complement": "Casa"
		},
		"name": "Pagador oliveira santiago",
		"status": "confirmed",
		"created_at": "2024-04-20T15:14:04.583-03:00",
		"checkout_type": "authentication_3ds",
		"payment_link_transaction": {
			"id": "946e2411-65dc-450e-95fd-9834lkjl",
			"provider_nsu_code": "202402023101",
			"provider_authorization_code": "123456",
			"happened_at": "2024-04-20T15:14:58.000-03:00",
			"acquirer_id": 441,
			"installments": 12,
			"transaction_category_id": 93,
			"status": "confirmed",
			"created_at": "2024-04-20T15:14:25.745-03:00"
		},
		"payment_status": "confirmed"
	},
	"customer_name": "",
	"description": null,
	"amount": "4500.0",
	"status": "paid",
	"created_at": "2024-03-17T14:24:10.106-03:00",
	"max_installments": 12,
	"expiration_date": "2024-03-19T23:59:59.999-03:00",
	"client_uuid": "g0e155f2",
	"customer_cnpj": null,
	"alert": {
		"contents": [
			"Este link já foi pago. Acompanhe o recebimento das parcelas no seu extrato."
		],
		"status": "success"
	}
}

{
    "id": "xxxxxx-xxx-xxxx-xxxx-xxxxxxxx",
    "business_name": "Fabricante Flipper",
    "cpf_cnpj": "xxxxxxxxxxxx",
    "client_name": "Fabricante Flipper",
    "created_by": "Blu",
    "link_url": "https://link-staging.blu.com.br/xxxxxx-xxx-xxxx-xxxx-xxxxxxxx",
    "customer_email": "Não informado",
    "wpp": "Não informado",
    "customer_name": "",
    "description": "teste",
    "amount": "1.0",
    "status": "expired",
    "created_at": "2024-03-07T18:50:16.129-03:00",
    "max_installments": 1,
    "expiration_date": "2024-03-09T23:59:59.999-03:00",
    "client_uuid": "xxxxxx", 
    "customer_cnpj": ""
}

{
	"message": "Cliente não possuí callback cadastrado"
}

Descrição dos principais objetos:

Campo

Descrição

payment_link_transaction

Dados do pagamento

last_payment_link_intent

Dados do cobrado

Descrição dos principais campos:

Campo

Tipo

Descrição

string

Id interno da Blu para o Link de Pagamento que permite a rastreabilidade da operação.

business_name

string

Nome fantasia do cliente

client_name

string

Nome do cliente.

created_by

string

Nome do usuário que criou o 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

string

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.

PreviousAPI Criação de Clientes NextAPI Pix Blu

Last updated 2 months ago

Was this helpful?