Este método permite consultar os detalhes e o status de todas as solicitações de pagamento geradas e processadas pela plataforma Mercos (MercosPay).
Estrutura da Resposta (GET)
| Campo | Tipo | Descrição |
|---|---|---|
| id | Integer | Identificador único da solicitação de pagamento. |
| token | String | Token único da solicitação de pagamento. Com ele é possível acessar a página de um Link de pagamento pela URL https://app.mercos.com/pagamentos/+token |
| data_criacao | DateTime | Data e hora que a solicitação de pagamento foi criada. |
| criador_id | Integer | Identificador único do usuário que criou a solicitação de pagamento. |
| pedido_id | Integer | Identificador único do pedido. |
| cliente_id | Integer | Identificador único do cliente. |
| valor | Decimal | Valor cobrado. |
| numero_parcelas | Number | Número de parcelas. |
| forma_pagamento | String | Formas de pagamento disponíveis: credit para Cartão de crédito, boleto para Boleto. |
| nota_fiscal | String | Número da Nota Fiscal, quando informada. |
| data_expiracao | Date | Data em que a solicitação de pagamento expira. Nos links de pagamento, o cliente ficará impedido de utilizar o link após esta data, com exceção dos links de Boletos. |
| ultima_alteracao | DateTime | Data e hora da última atualização na solicitação de pagamento. Alterações no status da transação também atualizam este campo. |
| excluido | Boolean | Indica se a solicitação de pagamento foi excluída. |
| transacoes | Objeto de transações | Lista as transações associadas a solicitação de pagamento. Em um parcelamento, cada parcela corresponde a uma transação. |
Estrutura do Objeto transacoes
transacoes| Campo | Tipo | Descrição |
|---|---|---|
| transacao_id | Integer | Identificador único da transação. |
| valor | Decimal | Valor cobrado. No caso de um parcelamento, este corresponde ao valor da parcela. |
| valor_liquido | Decimal | Valor líquido, descontadas as tarifas de processamento da transação ou emissão de boleto. |
| valor_original | Decimal | Valor da cobrança na criação. Auxilia na identificação de alterações posteriores. |
| data_vencimento | Date | Data de vencimento da transação. |
| data_vencimento_original | Date | Data de vencimento na criação da cobrança. Auxilia na identificação de alterações posteriores. |
| observacao | String | Descrição exibida no corpo do boleto. Para outras formas de pagamento, será sempre null. |
| bandeira | String | Bandeira do cartão. Para outras formas de pagamento, será sempre null. |
| status | String | Status dessa transação: pendente, recebido, confirmado, vencida, estornada, recebido-em-dinheiro, estorno-solicitado, chargeback-recebido, chargeback-disputa, chargeback-aguardando-repasse, recuperacao, recuperada, aguardando-analise |
| data_ultimo_status | DateTime | Data da última atualização no status da transação. |
| data_prevista_repasse | Date | Data estimada para o repasse do valor líquido. |
| data_repasse | Date | Data em que o repasse foi realizado. |
Status de Pagamento — Mercos Pay
As transações do Mercos Pay possuem dois tipos de status que trabalham juntos para refletir a situação completa de um pagamento:
-
Situação do Pedido — indica o estado geral do pagamento vinculado ao pedido. É o status de mais alto nível, visível na listagem de pedidos.
-
Situação do Pagamento — traz o detalhamento de cada transação individualmente, com granularidade maior sobre o que aconteceu (confirmado, vencido, estornado, etc).
Abaixo estão descritos todos os valores possíveis para cada um deles.
Situação do Pedido
Não Pago — Cobrança emitida mas ainda não paga pelo cliente.
Pago R$ XXX,XX — Valor pago, podendo ser integral ou parcial (ex: alguns boletos parcelados foram pagos).
Falha no Pagamento — Exclusivo para cartão de crédito, quando houve tentativa de pagamento mas ocorreu algum erro (cartão errado, sem saldo, não autorizado).
Situação do Pagamento
Pendente — O Mercos ainda aguarda o pagamento do pedido.
Confirmado — Exclusivo para cartão de crédito, quando o cliente finalizou o pedido mas o valor ainda não caiu em conta.
Recebido — Recebimento já processado e disponível na conta.
Vencido — Boleto, PIX ou link com data limite expirada, ou boleto com vencimento passado.
Recebido em Dinheiro — Recebimento confirmado manualmente pela plataforma do Asaas.
Estornado — Valor devolvido ao pagador, geralmente quando o cliente desiste da compra.