Cria um checkout

post https://sandbox.staging.justa.com.vc/payment-provider/api/checkout/

Este endpoint tem como objetivo realizar a criação de um checkout (linkou) e geração de um link para acesso do usuário final. Para geração de um link rápido, serão necessários enviar apenas os dados do checkout obrigatórios para que possamos realizar a criação do link de pagamento.

Detalhes do body

Caso um atributo não seja enviado (por exemplo, customer) não é necessário inseri-lo no JSON da requisição, porém se presente, deverá seguir as regras de obrigatoriedade descritas na tabela que descreve este objeto na aplicação.

🚧
Atenção
O valor que será cobrado ao cliente final é definido pela variável totalValue. A Justa não fará o cálculo do total da sua transação baseado nos produtos. Tome cuidado para o valor inserido condizer com a realidade dos produtos listados.

PaymentMethods
Esta lista de strings é responsável por identificar os meios de pagamento que serão disponibilizados ao cliente. Caso não seja enviada, todos os métodos de pagamento ficam disponíveis para seleção. Os métodos de pagamento são:

CREDIT_CARD - Pagamento via cartão de crédito.
BANK_BILL - Pagamento via boleto.
PIX_QRCODE - Pagamento via pix QRCODE e copia e cola.

PaymentOption
Este objeto é na verdade uma lista de strings com as opções de pagamento, caso sejam selecionadas:

MULTI_PAYMENT - Essa forma de pagamento permite um link ser pago mais de uma vez.

CUSTOMER_INTEREST- Adicionando esta opção de pagamento, indica que os custos de parcelamento e antecipação serão repassados para o consumidor final (pagador).

Respostas das requisições

Variável	Tipo	Descrição
checkoutId	Int	Identificador do checkout que foi criado para posterior identificação da notificação de pagamento de um checkout via webhook
accessLink	String	Link de pagamento sem o encurtamento, para caso ocorra algum erro no encurtamento do link, este seja utilizado no lugar
shortLink	String	Link encurtado para acesso à pagina de pagamento do checkout
customer	Customer	Dados do cliente (não do portador do cartão) que foram inseridos e estão atrelados ao checkout de pagamento

Customer:

Variável	Tipo	Descrição
name	String	Nome do cliente ao qual pertence o checkout de pagamento
phone	String	Telefone do cliente com ddd concatenado sem caracteres especiais. Somente números devem ser enviados
email	String	Email do cliente no formato de email válido
legalDocument	String	Documento legal do cliente ao qual pertence o checkout de pagamento
address	Address	Dados de endereço do cliente para que ele não precise inserir os dados de endereço
birthDate	String	Data de nascimento
gender	String	Gênero

Address

Variável	Tipo	Descrição
type	Address.Type	Tipo do endereço. Enviar somente os tipos RESIDENTIAL ou COMERCIAL, caso contrário, ocorrerá erro na hora do pagamento da requisição
street	String	Rua do endereço sem número e sem caracteres especiais
number	String	Número do endereço (normalmente número da casa ou do edifício a ser identificado na rua)
complement	String	Complemento do endereço (ponto de referência)
district	String	Bairro do endereço
zipCode	String	Cep do endereço (enviar somente números para que não ocorra erro na requisição)
city	String	Cidade do endereço
state	String	Estado do endereço
country	String	País do endereço

❗️
Erros mapeados
Para visualizar os possíveis erros nesta API, acesse a tabela de erros na criação de um checkout.

Body Params

expirationDate

string

required

Data de expiração do checkout. Enviar uma String no formato yyyy-MM-dd. A data precisa ser igual ou posterior à data de hoje.

totalValue

int32

required

Defaults to 1000

Valor total da transação EM CENTAVOS Obs.: Este é o valor que definirá o valor da cobrança. Enviar o valor EM CENTAVOS. O valor mínimo para esse campo é 500 (representando R$5,00)

message

string

Mensagem a ser enviada para o seu cliente no checkout. Máximo de 355 caracteres e não deve conter caracteres especiais, como, por exemplo, ">" ou "="

order

string

required

Defaults to 1234567891

Número de ordem do pedido para que você possa identificá-lo posteriormente. No mínimo 1 e no máximo 36 caracteres

reference

string

required

Defaults to 1234567891

Número de referência do pagamento para que você possa identificá-lo posteriormente. No máximo 36 caracteres

products

array of objects

required

Produtos vendidos neste checkout.

products*

customer

array of objects

Dados do cliente

customer

installments

int32

required

Defaults to 1

Número de parcelas da transação. Se não for parcelada, enviar 1. O valor máximo para esse campo é 12

customParams

string

Parâmetros customizados a serem aplicados na requisição para uso pessoal do integrador. Aconselhamos enviar em formato JSON, mas você pode enviar em qualquer formato transpilado para string. Máximo 1000 caracteres

redirectUrl

string

required

URL de redirecionamento da página de checkout após a efetivação do pagamento. No máximo 500 caracteres

creationLatitude

double

Latitude de onde foi criado o checkout

creationLongitude

double

Longitude de onde foi criado o checkout

creationIpAddress

string

required

Defaults to 8.8.8.8

Endereço de IP de onde foi criado o checkout. No máximo 20 caracteres

expirationTime

string

Hora da expiração de um checkout. Caso um checkout precise expirar no mesmo dia, utilizar esse atributo. Enviar uma String no formato HH:mm:ss. A hora precisa ser posterior à hora de agora.

paymentMethods

array of strings

required

Lista de opções de pagamento a serem enviados. Caso não seja informada, deverá ser enviada como vazia ou em branco e a opção de pagamento com cartão de crédito será ativada. No máximo 355

paymentMethods*

paymentOptions

array of strings

Opções de pagamento do checkout. MULTI_PAYMENT ou CUSTOMER_INTEREST.

paymentOptions

maxPayments

int32

Quantidade máxima de vezes que um link pode ser pago. Caso deseje colocar a opção de pagamento MULTI_PAYMENTS , e não for enviado esse atributo, o checkout será criado como um checkout normal sem pagamentos múltiplos

logoUrl

string

A URL da imagem da marca do estabelecimento. Se não for enviado, as iniciais do estabelecimento serão exibidas por padrão. No máximo 1000 caracteres

Headers

Authorization

string

required

Defaults to Bearer {access_token}

Autenticação do tipo Bearer a ser enviada. O atributo {access_token} é gerado na requisição para o servidor de autenticação da Justa, como já explicitado na seção de autenticação deste documento.

Token

string

required

Defaults to {client-token}

Token que irá identificar o estabelecimento. Este Token é recebido via webhook e é fixo para cada lojista

Content-Type

string

Defaults to application/json

Tipo do corpo da requisição a ser enviado

integrator-id

string

ID do integrador. Esse ID será provido pelo técnico responsável por acompanhar a integração

Response

Cria um checkout

Detalhes do body

🚧
Atenção

Respostas das requisições

❗️
Erros mapeados

Detalhes do body

🚧Atenção

Respostas das requisições

❗️Erros mapeados

201201

🚧
Atenção

❗️
Erros mapeados