Consulta e Cancelamento

Consulta

Listar Payment Initiations

`GET /baas/v1/open/itp/automatic-payments/payment-initiation`

Retorna a lista de consentimentos recorrentes criados. Pode ser filtrada por CPF do pagador.

Autenticação: Bearer Token (application_token)

GET {{base_url}}/baas/v1/open/itp/automatic-payments/payment-initiation?cpf=12345678909
Authorization: Bearer {{application_token}}

Query Parameters

Parâmetro	Tipo	Obrigatório	Descrição
`cpf`	string	❌	CPF do pagador para filtrar os consentimentos

Response — HTTP 200

{
  "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"
    }
  ]
}

Cancelamento

Cancelar Consentimento

`PATCH /baas/v1/open/itp/automatic-payments/v2/payment-initiation/:paymentInitiationId`

Revoga o consentimento recorrente, impedindo novos pagamentos. Pode ser solicitado pela ITP, pelo pagador ou pelo recebedor.

Autenticação: Bearer Token (application_token)

PATCH {{base_url}}/baas/v1/open/itp/automatic-payments/v2/payment-initiation/{{itp_payment_id}}
Authorization: Bearer {{application_token}}
Content-Type: application/json

{
  "data": {
    "status": "REVOKED",
    "revocation": {
      "revokedBy": "USER",
      "reason": {
        "code": "OUTRAS_RAZOES",
        "additionalInformation": "Cancelamento solicitado pelo usuário."
      }
    }
  }
}

Campos do Request

Campo	Tipo	Obrigatório	Descrição
`data.status`	string	✅	Fixo: `REVOKED`
`data.revocation.revokedBy`	string	✅	Quem solicitou: `USER` (pagador), `ASPSP` (detentora) ou `TPP` (ITP)
`data.revocation.reason.code`	string	✅	Código do motivo. Ver tabela abaixo
`data.revocation.reason.additionalInformation`	string	❌	Informação adicional sobre o motivo

Códigos de Revogação (`reason.code`)

Código	Descrição
`OUTRAS_RAZOES`	Outros motivos não listados
`FRAUDE`	Suspeita ou confirmação de fraude
`CONTA_ENCERRADA`	Conta do pagador encerrada
`NAO_INFORMADO`	Motivo não informado

Response — HTTP 200

{
  "data": {
    "recurringConsentId": "urn:bricks-demo:f4b0c161-f5f6-4adb-ae63-21a2160238d0",
    "status": "REVOKED",
    "statusUpdateDateTime": "2026-06-25T15:00:00Z"
  }
}

Códigos de Retorno

HTTP	Descrição
`200 OK`	Cancelamento realizado com sucesso
`401 Unauthorized`	Token inválido ou expirado
`404 Not Found`	Payment initiation não encontrada
`422 Unprocessable Entity`	Consentimento em status que não permite revogação

Estados que permitem cancelamento

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

Pontos de Atenção

⚠️
Pagamentos SCHD com consentimento revogado: Pagamentos agendados (SCHD) para o mesmo dia da revogação devem ser liquidados normalmente conforme a regulação. Apenas pagamentos de dias futuros são rejeitados com CONSENTIMENTO_REVOGADO.

⚠️
Revogação é irreversível: Consentimentos REVOKED não podem ser reativados. Um novo consentimento completo (com nova autorização do usuário) é necessário.

⚠️
Polling recomendado: Consulte via GET para verificar o status de processamento.

Consulta e Cancelamento

Consulta

Listar Payment Initiations

`GET /baas/v1/open/itp/automatic-payments/payment-initiation`

Query Parameters

Response — HTTP 200

Cancelamento

Cancelar Consentimento

`PATCH /baas/v1/open/itp/automatic-payments/v2/payment-initiation/:paymentInitiationId`

Campos do Request

Códigos de Revogação (`reason.code`)

Response — HTTP 200

Códigos de Retorno

Estados que permitem cancelamento

Pontos de Atenção

Pagamentos `SCHD` com consentimento revogado: Pagamentos agendados (`SCHD`) para o mesmo dia da revogação devem ser liquidados normalmente conforme a regulação. Apenas pagamentos de dias futuros são rejeitados com `CONSENTIMENTO_REVOGADO`.

Revogação é irreversível: Consentimentos `REVOKED` não podem ser reativados. Um novo consentimento completo (com nova autorização do usuário) é necessário.

Polling recomendado: Consulte via `GET` para verificar o status de processamento.

Consulta

Listar Payment Initiations

GET /baas/v1/open/itp/automatic-payments/payment-initiation

Query Parameters

Response — HTTP 200

Cancelamento

Cancelar Consentimento

PATCH /baas/v1/open/itp/automatic-payments/v2/payment-initiation/:paymentInitiationId

Campos do Request

Códigos de Revogação (reason.code)

Response — HTTP 200

Códigos de Retorno

Estados que permitem cancelamento

Pontos de Atenção

Pagamentos SCHD com consentimento revogado: Pagamentos agendados (SCHD) para o mesmo dia da revogação devem ser liquidados normalmente conforme a regulação. Apenas pagamentos de dias futuros são rejeitados com CONSENTIMENTO_REVOGADO.

Revogação é irreversível: Consentimentos REVOKED não podem ser reativados. Um novo consentimento completo (com nova autorização do usuário) é necessário.

Polling recomendado: Consulte via GET para verificar o status de processamento.

`GET /baas/v1/open/itp/automatic-payments/payment-initiation`

`PATCH /baas/v1/open/itp/automatic-payments/v2/payment-initiation/:paymentInitiationId`

Códigos de Revogação (`reason.code`)

Pagamentos `SCHD` com consentimento revogado: Pagamentos agendados (`SCHD`) para o mesmo dia da revogação devem ser liquidados normalmente conforme a regulação. Apenas pagamentos de dias futuros são rejeitados com `CONSENTIMENTO_REVOGADO`.

Revogação é irreversível: Consentimentos `REVOKED` não podem ser reativados. Um novo consentimento completo (com nova autorização do usuário) é necessário.

Polling recomendado: Consulte via `GET` para verificar o status de processamento.