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 |
| 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.