Retorna a lista de consentimentos recorrentes criados. Pode ser filtrada por CPF do pagador.
Autenticação: Bearer Token (application_token)
HTTP
GET {{base_url}}/baas/v1/open/itp/automatic-payments/payment-initiation?cpf=12345678909
Authorization: Bearer {{application_token}}Parâmetro Tipo Obrigatório Descrição cpfstring ❌ CPF do pagador para filtrar os consentimentos
JSON
{
"data": [
{
"id": "6a3d1e159c0f8d0011779569",
"paymentInitiationApi": "AUTOMATIC_PAYMENTS_V2",
"ofConsent": {
"status": "AUTHORISED",
"recurringConsentId": "urn:bricks-demo:f4b0c161-f5f6-4adb-ae63-21a2160238d0",
"recurringConfiguration": {
"automatic": {
"contractId": "XE00038166201907261559y6j6",
"interval": "SEMANAL"
}
}
},
"createdAt": "2026-06-25T12:24:53.798Z",
"updatedAt": "2026-06-25T12:27:02.555Z"
}
]
}Revoga o consentimento recorrente, impedindo novos pagamentos. Pode ser solicitado pela ITP, pelo pagador ou pelo recebedor.
Autenticação: Bearer Token (application_token)
HTTP
PATCH {{base_url}}/baas/v1/open/itp/automatic-payments/v2/payment-initiation/{{itp_payment_id}}
Authorization: Bearer {{application_token}}
Content-Type: application/jsonJSON
{
"data": {
"status": "REVOKED",
"revocation": {
"revokedBy": "USER",
"reason": {
"code": "OUTRAS_RAZOES",
"additionalInformation": "Cancelamento solicitado pelo usuário."
}
}
}
}Campo Tipo Obrigatório Descrição data.statusstring ✅ Fixo: REVOKED data.revocation.revokedBystring ✅ Quem solicitou: USER (pagador), ASPSP (detentora) ou TPP (ITP) data.revocation.reason.codestring ✅ Código do motivo. Ver tabela abaixo data.revocation.reason.additionalInformationstring ❌ Informação adicional sobre o motivo
Código Descrição OUTRAS_RAZOESOutros motivos não listados FRAUDESuspeita ou confirmação de fraude CONTA_ENCERRADAConta do pagador encerrada NAO_INFORMADOMotivo não informado
JSON
{
"data": {
"recurringConsentId": "urn:bricks-demo:f4b0c161-f5f6-4adb-ae63-21a2160238d0",
"status": "REVOKED",
"statusUpdateDateTime": "2026-06-25T15:00:00Z"
}
}HTTP Descrição 200 OKCancelamento realizado com sucesso 401 UnauthorizedToken inválido ou expirado 404 Not FoundPayment initiation não encontrada 422 Unprocessable EntityConsentimento em status que não permite revogação
Status do Consentimento Pode Revogar? AWAITING_AUTHORISATION✅ Sim → vai para REJECTED PARTIALLY_ACCEPTED✅ Sim → vai para REJECTED AUTHORISED✅ Sim → vai para REVOKED REJECTED❌ Não REVOKED❌ Não CONSUMED❌ Não
⚠️ ⚠️ ⚠️ 