Payload enviado para os pagamentos de: Boleto, Pix e Cartão de Crédito

  1. Tipo Boleto
{
  "Identificador": "4713c54a-cce6-4308-a0dc-27cd60df75e8",
  "Tipo": "Boleto",
  "IdentificadorCheckout": null,
  "Estado": "Aprovada",
  "Liquidado": true,
  "NumeroPedido": "pedido.2025061113",
  "DataAprovacaoCancelamento": "2025-06-24T00:00:00",
  "Valor": 1,
  "ValorPago": 1,
  "DataNotificacao": "2025-06-25T08:00:53.13238-03:00",
  "FormaPagamento": "Boleto",
  "DetalhesValores": {
    "ValorDesconto": 9.99,
    "ValorDesconto2": 6.99,
    "ValorDesconto3": 3.99,
    "ValorMulta": 3.22,
    "ValorJuros": 2.75
  }

  1. Tipo Pix ou Cartão de Crédito
{
  "Identificador": "6bc39ed7-17f6-4d54-9be3-4c1d5d759d54",
  "Tipo": "Pix",
  "IdentificadorCheckout": null,
  "Estado": "Aprovada",
  "Liquidado": true,
  "NumeroPedido": "pedido.2025052109",
  "DataAprovacaoCancelamento": "2025-06-24T10:45:22",
  "Valor": 1,
  "ValorPago": 1,
  "DataNotificacao": "2025-06-24T10:45:27.1790605-03:00",
  "FormaPagamento": "Pix"
}

Descrição dos campo

CampoTipoDescrição
IdentificadorTextoUm identificador para o item.
TipoTextoO tipo da transação, podendo ser: Boleto, boleto híbrido, pix ou cartão de crédito.
IndentificadorCheckoutGUIDGUID do checkout responsável pela criação da transação.
EstadoTextoO estado atual do item.
LiquidadoTextoo montante correspondente ao valor pago pelo título está disponível da conta de liquidação do recebível (Estado = Aprovado | Liquidado = 1).
NumeroPedidoTextoO número do pedido.
DataAprocacaoCancelamentoTextoData e hora da aprovação ou cancelamento, no formato ISO 8601.
ValorNúmeroValor do item.
ValorPagoNúmeroValor pago pelo item.
DataNotificacaoTextoData e hora da notificação, no formato ISO 8601.
FormaPagamentoTextoA forma que foi realizado pagamento, podendo ser: Boleto, pix, baixa manual ou cartão de crédito.
DetalhesValoresArray-
ValorDescontoNúmeroValor de desconto aplicado.
ValorDesconto2NúmeroValor de desconto aplicado.
ValorDesconto3NúmeroValor de desconto aplicado.
ValorMultaNúmeroValor da multa aplicada.
ValorJurosNúmeroValor do juros aplicado.

📘

Notas:

Formato de Data e Hora: As datas são representadas no formato ISO 8601 (yyyy-MM-ddTHH:mm:ssZ) para ser um formato padrão e universalmente reconhecido.

Exemplos: Os valores fornecidos são exemplos genéricos. Substitua esses valores pelos valores reais que você possui ou deseja usar.


📘

Notas

Devido à natureza síncrona das transações com cartão de crédito, a resposta de aprovação ou cancelamento é retornada quase instantaneamente ao solicitante, proporcionando uma experiência de compra mais ágil e eficiente.

Observação: Apenas para o provedor Valorem, há o envio de webhook com o status da transação.