Overview

Um pagamento via open banking se faz via um fluxo relativamente complexo, envolvendo diferentes sistemas, essa documentação engloba apenas uma parte do fluxo, na qual após já terem sido validadas algumas questões como consentimento e autorização, podemos receber duas requisições, a de "criação de um pagamento" e a "consulta de um pagamento", mais detalhes e referências estão logo a seguir.

Nomenclaturas dos envolvidos

Debtor:

Pessoa que está pagando, ou seja, estará tirando dinheiro de sua conta e enviando para alguma empresa/pessoa

Iniciadora:

Empresa/site que inicia o fluxo, é onde estará ocorrendo a compra, um bom exemplo são marketplaces como Mercado Livre, Americanas e Magalu.

Detentora:

Banco onde se encontra o dinheiro do Debtor, por exemplo o banco da Randon, nessa documentação parte da perspectiva da Detentora.

Creditor:

Empresa/pessoa que receberá o dinheiro

Referências

Muito importante entender esse diagrama de sequencia, pois é uma visão mais ampla do processo, sempre tendo em mente que o serviço em questão é o da Detentora
Diagrama de Sequencia Open Banking
Documentação mais antiga do Open Banking sobre pagamentos, ainda muito útil https://openbanking-brasil.github.io/areadesenvolvedor/#fase-3-apis-do-open-banking-brasil-api-pagamentos
Documentação mais recente do Open Banking link: https://openbankingbrasil.atlassian.net/wiki/spaces/OB/pages/1737751/Inicia+o+de+Pagamentos

---

Collection Postman

---

Environment Postman

---

Fluxo geral - Diagrama sequencial

---

Endpoints

Open Banking

• post /auth/realms/randon/protocol/openid-connect/token
• get /v1/banking/openbanking/conta/saldo
• post /v1/banking/openbanking/pagamento
• get /v1/banking/openbanking/status/pagamento

Default

---

---

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

• application/json

Responses

201

Sucesso ao criar registro de um pagamento

204

Já existe um pagamento criado com o msm ID

401

Cabeçalho de autenticação ausente/inválido ou token inválido. ErrorResponse

403

O token tem escopo incorreto ou uma política de segurança foi violada. ErrorResponse

404

O recurso solicitado não existe ou não foi implementado. ErrorResponse

422

Pagamento rejeitado pro regra de idempotência ErrorResponse

get /v1/banking/openbanking/status/pagamento

{
  "localInstrument" : "",
  "endToEndId" : "endToEndId",
  "proxy" : "proxy",
  "consentId" : "consentId",
  "remittanceInformation" : "remittanceInformation",
  "paymentId" : "paymentId",
  "creditorAccount" : {
    "number" : "number",
    "accountType" : "",
    "ispb" : "ispb",
    "issuer" : "issuer"
  },
  "statusUpdateDateTime" : "statusUpdateDateTime",
  "cnpjInitiator" : "cnpjInitiator",
  "payment" : {
    "amount" : "amount",
    "currency" : "currency"
  },
  "ibgeTownCode" : "ibgeTownCode",
  "rejectionReason" : "",
  "creationDateTime" : "creationDateTime",
  "status" : "",
  "transactionIdentification" : "transactionIdentification"
}