Este endpoint tem como objetivo fazer a busca de todos os checkouts para um estabelecimento específico através do seu token. A busca retornará todos os links de um determinado estabelecimento identificado pelo token. Na versão 1.3.0 Esta busca ocorrerá com paginação, o que facilitará o gerenciamento de paginação do frontend das aplicações.
Respostas das requisições
O retorno da requisição é uma lista paginada, onde o conteúdo da lista se encontra no atributo content.
Nesta documentação estarão descritos apenas os atributos mais relevantes da entidade de paginação, para que não estejam presentes dados desnecessários e irrelevantes para o desenvolvimento da integração, bem como todos os atributos das entidades de checkout. Alguns exemplos de respostas de requisição estão listados abaixo bem como na tabela a seguir existem as descrições destes corpos e do que significa cada atributo da requisição:
| Variável | Tipo | Descrição |
|---|---|---|
| content | List<.Checkout> | Contém a página solicitada da listagem de links de pagamento |
| last | Boolean | Indica se a página retornada é a última |
| totalPages | Integer | Indica o total de páginas |
| size | Integer | Indica o tamanho da página |
| empty | Boolean | Indica se a página está vazia |
Checkout
Os campos para a entidade checkout são os seguintes:
| Variável | Tipo | Descrição |
|---|---|---|
| checkoutId | BigInteger | Identificador do link de pagamento |
| expirationDate | LocalDateTime | Data-hora da expiração do checkout representado yyyy-MM-dd HH:mm:ss |
| totalValue | BigInteger | Valor total do link de pagamento |
| status | Checkout.Status | Status do link de pagamento |
| url | String | Link para pagamento de um checkout |
| maxInstallments | Integer | Número máximo de parcelas que aquele checkout pode ter |
| paymentOptions | List<.PaymentOption> | Lista com as opções de pagamento (se existirem) |
| maxPayments | Int | Quantidade máxima de pagamentos que o checkout pode ter |
| currentPayments | Int | Quantidade de vezes que o checkout já foi pago |
| payments | List<.Payment> | Lista com os pagamentos realizados para um checkout |
| order | String | Número de ordem de um checkout (o mesmo enviado na requisição de criação) |
Checkout.Status
Os status de um checkout podem ser:
PAYED - Se um checkout já foi pago completamente (todos os pagamentos já forem realizados)
PENDING - Status pendente aguardando pagamento
EXPIRED - Status expirado (quando passou a data de vencimento e não foi pago)
CANCELED - Status cancelado para quando um cliente deseja cancelar o checkout
PROCESSING - Status para quando a transação está sendo processada (cliente inserindo dados da transação). Normalmente utilizado para que não aconteça a troca do token durante a operação de pagamento, evitando erro.
BLOCKED - Status usado quando um checkout é bloqueado dado um lojista bloqueado
PaymentOption
Opções de pagamento que podem aparecer na listagem:
MULTI_PAYMENT - Essa forma de pagamento permite um link ser pago mais de uma vez. Para mais detalhes sobre formas de pagamento, visite a página inicial da API de checkout.
Payment
A entidade payment possui o seguinte corpo:
| Variável | Tipo | Descrição |
|---|---|---|
| id | BigInteger | Id do pagamento |
| payedValue | BigInteger | Valor pago no determinado pagamento |
| status | Payment.Status | Status de um pagamento |
| completionDateTime | LocalDateTime | Data-hora em que o pagamento foi dado como completo |
| transactions | List<.Transaction> | Lista de transações que foram realizadas para o pagamento do ckeckout |
| customer | Customer | Cliente que realizou o determinado pagamento (diferente do portador do cartão) |
Payment.Status
Os pagamentos podem assumir os seguintes status:
COMPLETE - O pagamento foi realizado completamente (valor total foi pago)
INCOMPLETE - O pagamento está incompleto (valor total ainda não foi pago)
PROCESSING - O pagamento está sendo processado
Customer
Variáveis do objeto Customer dentro do Objeto Payment:
| Variável | Tipo | Descrição |
|---|---|---|
| name | String | Nome do cliente ao qual pertence o pagamento |
| phone | String | Telefone do cliente |
| String | Email do cliente no formato de email válido | |
| legalDocument | String | Documento legal do cliente ao qual pertence o pagamento |
| address | Address | Dados de endereço do cliente |
Transaction
| Variável | Tipo | Descrição |
|---|---|---|
| id | BigInteger | Id da transação |
| localCode | String | Código identificador da transação para possível cancelamento |
| status | Transaction.Status | Status da transação |
| installments | Int | Quantidade de parcelas em que a transação ocorreu |
| value | BigInteger | Valor da transação |
| dateTime | LocalDateTime | Data-hora da transação representado yyyy-MM-dd HH:mm:ss |