Rejeição ou revogação do consentimento

patch

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

Método para rejeitar, revogar ou editar um consentimento de longa duração:
1 - Informações sobre a revogação:

Caso bem sucedido, o consentimento vai para o status “REVOKED”;
Apenas consentimentos com status “AUTHORISED” podem ser revogados;
Pagamentos automáticos associados ao consentimento e que estão agendados para ocorrer até as 23:59h do próximo dia (a partir do dia de
solicitação da revogação) deverão ser mantidos. Pagamentos agendados para ocorrer após esse período devem ser cancelados.
Demais orientações referentes a revogação podem ser encontrados no header da API, tópico “Validações”, item 3.

2 - Informações sobre a rejeição:

Caso haja necessidade de cancelamento de um consentimento ainda não autorizado, o iniciador poderá chamar o endpoint para mover o consentimento para REJECTED.

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.

Body Params

Payload para criação do consentimento para iniciação do pagamento.

data

required

Objeto contendo as informações de rejeição e revogação dos consentimentos

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

200Objeto contendo as informações de consentimento para a iniciação de pagamento individual.

401Unauthorized

404Not Found

500Internal Server Error