Gera um Flashlink/Safelink de acesso ao checkout de pagamento com Itens.
Gerar Link: Itens
Este recurso permite a criação de um link adaptado aos parâmetros específicos fornecidos na requisição, incluindo itens, valores, quantidade de pagamentos que o link poderá receber, quantidade de parcelas e outros detalhes essenciais que serão detalhados a seguir.
Além disso, A tela de checkout é apresentada em duas etapas e exibe o detalhamento dos itens da venda.
Aviso!
O link pode ser gerado para uma única venda ou para várias vendas. Isso é muito útil para quem deseja vender um curso com um preço fixo, mas quer limitar a venda, por exemplo, aos primeiros 100 compradores.
Como implementar:
Para utilizar este serviço, é necessário incluir o token da API do estabelecimento no cabeçalho "Authorization", juntamente com a adição do Content-type: application/json. Este token é disponibilizado pelo Suporte ao Cliente e os detalhes de contato podem ser encontrados em nossa página Fix Pay.
A seguir, um exemplo de como adicionar o cabeçalho utilizando JSON:
{
"Authorization": "Bearer seu_token_api_aqui",
"Content-type": "application/json"
}
Como o método utilizado é o POST, os dados devem ser incluídos no corpo (body) da requisição.
Segue um exemplo de como inserir esses dados utilizando JSON:
{
"max_installments": "12",
"max_amount": "1",
"freight": true,
"amount_freight": 10.00,
"items": [
{
"item_id": "1",
"item_name": "blusa",
"item_description": "blusa Tamanho M",
"item_quantity": 1,
"item_discount": 10,
"item_price": 49.99
},
{
"item_id": "2",
"item_name": "calça",
"item_description": "calça jeans",
"item_quantity": 1,
"item_discount": 0,
"item_price": 50
}
]
}
Caso queira que os dados do comprador e o endereço de entrega sejam preenchidos ao acessar o link, ou adicionar um código para melhor localização do link, devem ser incluídos alguns campos a mais.
{
"client_name": "maria",
"cpf_cnpj_holder": "12312312312",
"client_birth_date": "01012001",
"client_email": "[email protected]",
"client_phone": "85988888888",
"zip_code": "60120-000",
"address": "Av. Barão de Studart",
"number": 300,
"complement": "AP 123",
"reference": "Ponto de Referencia",
"neighborhood": "Meireles",
"city": "Fortaleza",
"state": "Ceará",
"country": "Brasil",
"max_installments": "12",
"max_amount": "1",
"freight": true,
"amount_freight": 10.00,
"codigo_link_cliente": "FixPay Example Link",
"user_email": "[email protected]",
"items": [
{
"item_id": "1",
"item_name": "blusa",
"item_description": "blusa Tamanho M",
"item_quantity": 1,
"item_discount": 10,
"item_price": 49.99
},
{
"item_id": "2",
"item_name": "calça",
"item_description": "calça jeans",
"item_quantity": 1,
"item_discount": 0,
"item_price": 50
}
]
}
Aviso!
A descrição e o tipo de cada parâmetro estão especificados mais abaixo no tópico Testar Rota.
Exemplo:
A seguir, apresentamos um exemplo da requisição realizada em JavaScript e seu resultado.
const options = {
method: 'POST',
headers: {
accept: 'application/json',
Authorization: 'Bearer 125SEBXXXXXX20150821',
'Content-Type': 'application/json'
},
body: JSON.stringify({
freight: true,
max_installments: '12',
max_amount: '1',
amount_freight: '10.00',
items: [
{
item_id: '1',
item_name: 'blusa',
item_description: 'blusa Tamanho M',
item_quantity: 1,
item_discount: 10,
item_price: 49.99
},
{
item_id: '2',
item_name: 'calça',
item_description: 'calça jeans',
item_quantity: 1,
item_discount: 0,
item_price: 50
}
]
})
};
fetch('https://apis.fixpay.com.br/v1/link/12312313', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
Requisição com os dados do comprador e o endereço da entrega preenchidos.
const options = {
method: 'POST',
headers: {
accept: 'application/json',
Authorization: 'Bearer 125SEBXXXXXX20150821',
'Content-Type': 'application/json'
},
body: JSON.stringify({
freight: true,
max_installments: '1',
max_amount: '1',
amount_freight: 1.9,
items: [
{
item_id: '1',
item_name: 'Name item',
item_description: 'Item description',
item_quantity: 1,
item_discount: 1,
item_price: 10.99
}
],
client_name: 'Nome do Cliente',
cpf_cnpj_holder: '12312312312',
client_birth_date: '01012001',
client_email: '[email protected]',
client_phone: '85988888888',
zip_code: '60120-000',
address: 'Av. Barão de Studart',
number: 300,
complement: 'Ap 123',
reference: 'Próximo ao mercado',
neighborhood: "Paupina",
city: "Fortaleza",
state: "Ceará",
country: "Brasil",
codigo_link_cliente: 'FixPay Example Link',
user_email:'[email protected]',
})
};
fetch('https://apis.fixpay.com.br/v1/link/22123123000123', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
O resultado desta requisição é um JSON que contém o link do checkout de pagamento no parâmetro "link-item", o qual deve ser enviado ao cliente.
{
"link-item": "https://gateway.fixpay.com.br/personpayment/be58202a-85c9-49b7-ad72-a4e7ed123d73",
}
Aviso!
Os parâmetros de endereço de entrega não são obrigatórios. Portanto, se o frete (freight) for igual a true, os parâmetros de entrega podem ser preenchidos durante a geração do link, o que deixará esses campos já preenchidos na tela de pagamento. Caso o endereço não seja fornecido no momento da geração do link, será necessário preenchê-lo na tela de pagamento.
Ao acessar o link, o cliente encontrará duas etapas para realizar o pagamento.
Etapa 1: Identificação do comprador:
Etapa 2: Tela de pagamento com as informações do pedido:
Testar rota
Aqui você pode testar a rota em produção, inserindo os valores nos parâmetros conforme descrito. Na lateral direita da tela, você verá o código da requisição em várias linguagens diferentes, junto com a sua resposta. Além disso, na seção de resposta da requisição, serão exibidos todos os possíveis retornos gerados pela rota.