Visão geral
A API tem como objetivo coletar o consentimento e realizar a iniciação de pagamento entre bancos, instituições financeiras e é acessível também à estabelecimentos comerciais participantes do Open Finance Brasil.
Os recursos estão disponíveis para pagadores que possuem registro em uma instituição detentora de conta participante do Open Finance, independentemente de serem pessoa física ou jurídica.
Criar consentimento para iniciação de pagamento : (POST /payments/v4/consents)
Método para a criação do consentimento para iniciação de pagamento.
Dicionário de dados
Campos de resposta do endpoint de /consents
Fazer download do dicionário de dados
Consultar consentimento para iniciação de pagamento : (GET /payments/v4/consents/{consentId})
Método para consultar o consentimento para iniciação de pagamento.
Dicionário de dados
Campos de resposta do endpoint de /consents/{consentId}
Fazer download do dicionário de dados
Pix - Criar iniciação de pagamento : (POST /payments/v4/pix/payments)
Método para a criação de uma iniciação de pagamento.
Dicionário de dados
Campos de resposta do endpoint de /pix/payments
Fazer download do dicionário de dados
Pix - Consultar iniciação de pagamento : (GET /payments/v4/pix/payments/{paymentId})
Método para consultar uma iniciação de pagamento.
Dicionário de dados
Campos de resposta do endpoint de /pix/payments/{paymentId}.
Fazer download do dicionário de dados
Pix - Cancelar iniciação de pagamento : (PATCH /payments/v4/pix/payments/{paymentId})
Método para cancelar uma iniciação de pagamento.
Dicionário de dados
Campos de resposta do endpoint de /pix/payments/{paymentId}.
Fazer download do dicionário de dados
Pix - Cancelar iniciação de pagamento : (PATCH /payments/v4/pix/payments/consents/{consentId})
Método para cancelar todos os pagamentos referentes ao mesmo consentimento.
Dicionário de dados
Campos de resposta do endpoint de /pix/payments/consents/{consentId}.