v1

latestOpenAPI 3.0.02026-07-2671191208.7 KB

Pagamentos de boletos

Consultar um pagamento específico

get/v1/marketplace/payments/{id}

Path parameters

idstring required

Headers

integration-keystring required

Chave de integração.

x-tokenstring required

x-token utilizado para autenticação. Pode ser encontrado em nosso portal, na guia de integração com a api pública.

Response

_idstring required

ID do pagamento.

typestring required

Tipo do pagamento.

status'PAID' | 'PENDING' | 'PROCESSING' | 'REFUNDED' | 'CANCELED' required

Status atual do pagamento.

barcodestring required

Código de barras do boleto pago.

digitable_linestring required

Linha digitável do boleto pago.

expected_onstring date-time required

Data prevista para pagamento.

amountnumber required

Valor líquido.

nominal_amountnumber required

Valor nominal do boleto.

discountnumber required

Valor de desconto aplicado.

finenumber required

Valor de multa (mora) aplicado ao boleto.

interestnumber required

Valor de juros aplicado ao boleto.

gateway_keystring required

Chave do gateway que processou o pagamento.

document_numberstring required

Documento informado como referência no boleto.

gateway_authorizationstring required

Nome do gateway responsável pelo processamento do boleto.

establishment_idstring required

ID do estabelecimento.

reprocessedboolean required

Indica se o pagamento foi reprocessado.

created_atstring date-time required

Data de criação do pagamento.

updated_atstring date-time required

Data da última atualização do pagamento.

payment_datestring date-time required

Data em que o pagamento foi confirmado.

Example response

{
  "establishment": {
    "active": 1
  }
}