Busca informações de transações de pagamentos associadas a um consentimento.

get

https://api-openfinance.opb.bricks.demo.fsapps.io/api/management/consents/v1/consents/{recurringConsentId}/proxy_duplicate

Método para buscar informações sobre um conjunto de pagamentos associados ao mesmo recurringConsentId.
Também é possível enviar uma data de início (startDate) e final (endDate), caso a busca seja por transações em uma determinada janela de tempo.

Exemplo de chamada: {{url_api}}/api/management/consents/v1/consents/{{recurringConsentId}}/proxy?link=/open-banking/automatic-payments/v1/pix/recurring-payments&recurringConsentId={{recurringConsentId}}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

recurringConsentId

string

required

length between 1 and 256

^urn:[a-zA-Z0-9][a-zA-Z0-9\-]{0,31}:[a-zA-Z0-9()+,\-.:=@;$_!*'%\/?#]+$

O recurringConsentId é o identificador único do consentimento de longa duração e deverá ser um URN - Uniform Resource Name.
Um URN, conforme definido na RFC8141 é um Uniform Resource
Identifier - URI - que é atribuído sob o URI scheme "urn" e um namespace URN específico, com a intenção de que o URN
seja um identificador de recurso persistente e independe da localização.
Considerando a string urn:bancoex:C1DD33123 como exemplo para recurringConsentId temos:

o namespace(urn)
o identificador associado ao namespace da instituição detentora (bancoex).
o identificador específico dentro do namespace (C1DD33123).
Informações mais detalhadas sobre a construção de namespaces devem ser consultadas na RFC8141.

Query Params

link

string

required

Parâmetro de chamada para o endpoint de proxy para buscar um pagamento automatico no detentor de contas.

startDate

string

length between 10 and 10

^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$

Data inicial de corte da ocorrência do pagamento ligada ao consentimento de longa duração.

endDate

string

length between 10 and 10

^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$

Data final de corte para recuperação da ocorrência do pagamento ligada ao consentimento de longa duração.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/jwt

application/json

200Dados de iniciação de pagamento Pix obtidos com sucesso.

401Unauthorized

404Not Found

500Internal Server Error