Consultar personalização do checkout
Consulte as imagens, as cores, o contato de suporte e os meios padrão do checkout.
Consulte a configuração do checkout da sua empresa para conferir as imagens, as cores, o contato de suporte e os meios de pagamento padrão disponíveis. As imagens informam também o andamento de uma alteração enviada.
Veja o alcance dessas preferências e como alterá-las em Personalização do checkout.
Respostas
Corpo da resposta
Configuração atual do checkout no ambiente autenticado. Os meios de pagamento são somente para consulta. As imagens informam o endereço atual e o resultado da última alteração.
Imagens, cores, contato de suporte e meios padrão do checkout no ambiente autenticado.
E-mail de suporte apresentado no checkout, ou null quando não informado.
Cor principal do checkout no formato #RRGGBB.
Cor de fundo do checkout no formato #RRGGBB.
Meios padrão habilitados e disponíveis: 1 para Pix e 2 para boleto. Cobranças e links podem ter configurações próprias. Para alterar o padrão, use o Dashboard.
Imagem atual e andamento da última alteração.
Endereço da imagem atual, ou null quando não houver imagem disponível. Durante uma troca pendente ou com falha, conserva a imagem anterior, quando existir.
Situação da imagem: absent quando não há imagem configurada; ready quando está disponível; pending durante o processamento; failed quando a alteração não pôde ser aplicada.
Código público da falha na aplicação da imagem, ou null quando não houver falha.
Imagem atual e andamento da última alteração.
Endereço da imagem atual, ou null quando não houver imagem disponível. Durante uma troca pendente ou com falha, conserva a imagem anterior, quando existir.
Situação da imagem: absent quando não há imagem configurada; ready quando está disponível; pending durante o processamento; failed quando a alteração não pôde ser aplicada.
Código público da falha na aplicação da imagem, ou null quando não houver falha.
Corpo da resposta
Esta consulta não aceita corpo nem parâmetros de consulta. Remova os dados indicados nos detalhes do erro.
Código e explicação do erro retornado pela API.
Código estável do erro.
Explicação do erro em inglês. Em validações, resume a categoria; os detalhes identificam as correções. Use os códigos para tratar a resposta.
Falhas em campos recebidos ou referências enviadas no corpo, com campo, código e explicação. Omitido em erros gerais e quando não há correção de campo a indicar.
Nome público do campo JSON, parâmetro de consulta, parâmetro de rota ou header relacionado ao erro. Campos aninhados e listas preservam o caminho e o índice. $ representa a raiz do corpo JSON.
Motivo do erro no campo, como REQUIRED, INVALID_TAXID, UNKNOWN_FIELD, DUPLICATE_FIELD ou INVALID_TYPE.
Explicação em inglês sobre o problema nesse campo ou parâmetro e a correção disponível. Não use o texto para decidir o fluxo da integração.
Corpo da resposta
A configuração da conta não foi encontrada para a consulta. Confira o acesso à empresa antes de repetir a requisição.
Código e explicação do erro retornado pela API.
Código estável do erro.
Explicação do erro em inglês. Em validações, resume a categoria; os detalhes identificam as correções. Use os códigos para tratar a resposta.
Falhas em campos recebidos ou referências enviadas no corpo, com campo, código e explicação. Omitido em erros gerais e quando não há correção de campo a indicar.
Nome público do campo JSON, parâmetro de consulta, parâmetro de rota ou header relacionado ao erro. Campos aninhados e listas preservam o caminho e o índice. $ representa a raiz do corpo JSON.
Motivo do erro no campo, como REQUIRED, INVALID_TAXID, UNKNOWN_FIELD, DUPLICATE_FIELD ou INVALID_TYPE.
Explicação em inglês sobre o problema nesse campo ou parâmetro e a correção disponível. Não use o texto para decidir o fluxo da integração.
Para os erros gerais, consulte Códigos HTTP das respostas.