Especificação em OAS 3.0
Download da Especificação (OAS 3.0)
Visão Geral
A API tem como objetivo coletar o consentimento e realizar a iniciação de pagamento entre bancos e instituições financeiras e acessível também à estabelecimentos comerciais participantes do Open Banking Brasil.
Os recursos estão disponíveis para pagadores que possuem vínculo com uma instituição detentora de conta participante do Open Banking, independentemente de serem pessoa física ou jurídica.
Criar consentimento para iniciação de pagamento : (GET /payments/v1/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
Consulte a seção Convenções de payload para obter mais informações sobre Atributos Obrigatórios / Opcionais.
Consultar consentimento para iniciação de pagamento : (GET /payments/v1/consents/{consentId})
Método para consultar o consentimento para iniciação de pagamento.
Dicionário de dados
Campos de resposta do endpoint de /consents
Fazer download do dicionário de dados
Consulte a seção Convenções de payload para obter mais informações sobre Atributos Obrigatórios / Opcionais.
Pix - Criar iniciação de pagamento : (GET /payments/v1/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
Consulte a seção Convenções de payload para obter mais informações sobre Atributos Obrigatórios / Opcionais.
Pix - Consultar iniciação de pagamento : (GET /payments/v1/pix/payments/{paymentId})
Método para consultar uma iniciação de pagamento.
Dicionário de dados
Campos de resposta do endpoint de /pix/payments.
Fazer download do dicionário de dados
Consulte a seção Convenções de payload para obter mais informações sobre Atributos Obrigatórios / Opcionais.