v1.0

OAS 2.0

API do Tino

O Tino é um meio de pagamento entre lojistas e fornecedores. Concedemos crédito sem juros ao lojista, que pode usá-lo para pagar a prazo com seus fornecedores, aos quais o Tino garante o repasse.

Resumo da integração

O protocolo Tino é faseado em 3 partes, detalhados melhor no guia de integração.

1. Cadastro do lojista

Para cadastrar um lojista no Tino e realizar análise de crédito para o mesmo, a API de Cadastrar Lojista pode ser usada, idealmente, no mesmo momento em que um lojista é cadastrado na sua plataforma.

2. Vendas assistidas

Fornecedores que operam ou desejam operar com vendas assistidas devem integrar com a nossa solução de Links de Pagamento. Com ela, a partir da API de Gerar Link, enviamos uma URL para o WhatsApp do lojista, na qual ele consegue finalizar o pagamento usando o Tino.

É possível saber se o lojista está apto a pagar com o Tino em um pedido específico usando a API de Validar Geração.

3. Faturamento

Após o pagamento, reservamos o limite do lojista, e esse processo é marcado pela criação da entidade chamada Reserva de Limite. Posteriormente, o fornecedor deve faturar a reserva, enviando as notas fiscais referentes ao pedido. Cada nota se torna um boleto parcelado para o lojista conforme a opção de prazo que ele escolheu no momento do pagamento, bem como uma previsão de repasse para o fornecedor conforme a frequência de pagamento acordada com o Tino.

Caso todas as notas fiscais estejam disponíveis no momento do faturamento, ele pode ser realizado pela API de Faturar Reserva. Caso não, as notas podem ser enviadas separadamente pela API de Faturar Parcialmente Reserva, mas é importante que a última leva seja submetida pela primeira opção.

Conciliação

Opcionalmente, é possível obter informações sobre pagamentos e repasses feitos a partir das nossas APIs de Gerar Extrato Financeiro e Gerar Extrato Contábil.

Testes em sandbox

Disponibilizamos um ambiente de testes para ser possível testar a integração. A URL do ambiente é .

Client Libraries

Curl Shell

Links de Pagamento

A solução com Links de Pagamento habilita o fornecedor a realizar compras assistidas usando o Tino. Ao gerá-los, os enviamos ao WhatsApp do lojista para que o mesmo possa finalizar o pagamento.

Antes de gerar, é preferível integrar com a API de Validar Geração para conferir que o lojista está de fato apto a comprar com o Tino. Caso não esteja, a API de Gerar Link retornaria um erro.

Um Link de Pagamento tem prazo de validade de 1 dia. Se, após esse prazo, o lojista não confirmar o pagamento, ele expira e não pode mais ser usado, cabendo ao fornecedor gerar outro para seguir com o pagamento.

Ele também deve estar associado a um identificador externo, que identifica o pedido no lado do fornecedor. Ele deve ser único apenas para os confirmados, já que podem existir vários links de pagamento para um mesmo pedido (devido à expiração, por exemplo).

No momento em que o pagamento é confirmado, o lojista é redirecionado para uma página, que por padrão é a página inicial do Tino, mas que é customizável pelo fornecedor. Nesse momento, também, um webhook de confirmação de compra é enviado à URL acordada entre o fornecedor e o Tino, cujo corpo conterá as informações da Reserva de Limite associada. O identificador desta também é retornado pela API de Listar Links.

Links de Pagamento Endpoints

GET/v1/payment-links
POST/v1/payment-links
POST/v1/payment-links/validate

Listar Links

Retorna uma lista de Links de Pagamento cujos campos batem com os fornecidos nos parâmetros de consulta. Atualmente, o único campo aceito é o identificador do pedido (external_id).

Query Parameters

external_id
required

O identificador do pedido associado ao Link de Pagamento.

Headers

X-API-KEY
required

Chave de acesso

Responses

200

Lista possivelmente vazia de links de pagamento.
400

Requisição inválida.
401

API Key inválida ou ausente.
500

Erro inesperado.

GET/v1/payment-links

Selected HTTP client: Shell Curl

Show Schema

[
  {
    "created_at": "2024-05-24T15:47:28.736402Z",
    "expires_at": "2024-05-25T15:47:28.736402Z",
    "external_id": "123",
    "id": "ea1f6514-9288-4622-bba6-8751c9cd5925",
    "limit_reservation_id": "50406bb6-d306-4a3a-a795-6dad0cd31a81",
    "link": "https://app.tino.com.br/checkout/ea1f6514-9288-4622-bba6-8751c9cd5925",
    "origin": "sdk",
    "status": "link_sent"
  }
]

Lista possivelmente vazia de links de pagamento.

Reservas de Limite

Quando o lojista finaliza o pagamento usando o Tino, reservamos de seu limite o valor da compra, de modo que não pode mais ser usado em futuras compras até que quite sua dívida. Esse processo é definido pela criação de uma Reserva de Limite.

A partir desse momento, uma janela de alguns dias (acordados entre o Tino e o fornecedor) é aberta na qual a reserva criada deve ser faturada, processo no qual o fornecedor envia as notas fiscais referentes ao pedido. Cada nota se torna um boleto para o lojista, que então é dividido em parcelas conforme o que ele escolheu no pagamento. Se a janela de tempo expirar, o limite é estornado para o lojista e a Reserva de Limite não pode mais ser faturada. O faturamento é feito a partir das APIs de Faturar Reserva ou Faturar Parcialmente Reserva.

Se o pedido precisar ser cancelado, a Reserva de Limite também pode ser cancelada usando a API de Cancelar Reserva, e o limite é então estornado para o lojista. Apenas reservas não totalmente faturadas podem ser canceladas. Quaisquer boletos criados devem ser cancelados individualmente usando a API de Cancelar Boleto.

No momento em que a Reserva de Limite é criada, um webhook de confirmação de compra é enviado à URL acordada entre o fornecedor e o Tino, cujo corpo conterá as informações da mesma. O fornecedor pode averiguar se ela de fato existe usando a API de Listar Reservas.

Reservas de Limite Endpoints

GET/v2/limit-reservations/{external_id}
DELETE/v2/limit-reservations/{id}
POST/v2/limit-reservations/{id}/bill
POST/v2/limit-reservations/{id}/partial-bill

Lojistas

O Lojista é a metade do coração do Tino. Concedemos crédito para ele, que pode usar para realizar pagamentos usando o Tino com seus fornecedores favoritos.

Integrando o SDK do CompraTino no e-commerce, o lojista pode se cadastrar sozinho ao escolher o Tino como meio de pagamento. Contudo, a análise de crédito pode ou não ser instantânea o suficiente, ou resultar em uma rejeição. Assim, para garantir uma melhor experiência para o lojista, é recomendado integrar com a API de Cadastrar Lojista no mesmo momento em que ele se cadastra na sua plataforma. Fornecedores que operam via venda assistida são naturalmente obrigados a integrar com essa API.

É possível saber se o lojista está apto a realizar pagamentos usando o Tino pela API de Consultar Lojista.

Lojistas Endpoints

POST/v1/merchants
GET/v2/merchants/{document_number}

API do Tino

Resumo da integração

1. Cadastro do lojista

2. Vendas assistidas

3. Faturamento

Conciliação

Testes em sandbox

Links de Pagamento​#Copy link to "Links de Pagamento"

Listar Links​#Copy link to "Listar Links"

Reservas de Limite​#Copy link to "Reservas de Limite"

Lojistas​#Copy link to "Lojistas"

Models

Links de Pagamento

Listar Links

Reservas de Limite

Lojistas