Procurando a documentação anterior?Acesse v1.docs.pluggy.ai
PluggyDocs
DELETE/smart-transfers/preauthorizations/{id}/data-consent

Cancelar permissão de saldo

Cancela apenas a permissão de saldo. A pré-autorização permanece ativa e suas transferências continuam funcionando. Uma permissão que já terminou (rejeitada, revogada, cancelada ou expirada), ou uma cuja pré-autorização está `REVOKED`, `REJECTED` ou `ERROR`, responde 200 com `dataConsent.status` `REJECTED`, portanto, tentar novamente é seguro.

Parameters

Path Parameters

NameType
idrequired
string (uuid)

Responses

200A pré-autorização, com a permissão cancelada
object

Pré-autorização de transferências inteligentes

idrequiredstring

Identificador primário de pré-autorização

statusrequiredstring

Status do ciclo de vida da pré-autorização. - `CREATED`: a pré-autorização foi criada e está aguardando o consentimento do pagador (veja `consentUrl`). - `COMPLETED`: o pagador autorizou o consentimento. A pré-autorização agora pode ser usada para executar pagamentos. - `REJECTED`: o pagador rejeitou o consentimento. - `REVOKED`: o consentimento foi revogado após ser autorizado. - `ERROR`: o fluxo de pré-autorização falhou inesperadamente (veja `errorDetail`).

CREATEDCOMPLETEDREVOKEDREJECTEDERROR
consentUrlstring

Url para conceder o consentimento na instituição

clientPreauthorizationIdstring | null

Identificador de pré-autorização do cliente

callbackUrlsobject | null
Any of:
option 1object

Redirecionar URLs após o fluxo de pré-autorização ser concluído ou terminar com status de erro

option 2null | null
recipientsrequiredobject[]
itemsobject

Destinatário de pagamento de conta bancária. Retornado pelos endpoints `/payments/recipients` e incorporado dentro das solicitações de pagamento quando a solicitação tem como alvo um destinatário registrado.

connectorrequiredobject

Objeto do conector

idrequirednumber (integer)

Identificador principal

namestring

Nome da instituição

institutionUrlstring

Página inicial da instituição

imageUrlstring

Imagem do logotipo hospedado pelo Pluggy

primaryColorstring

Cor primária

typestring

Tipo de instituição

countrystring

País localizado

credentialsobject[]

Parâmetros necessários para iniciar a conexão

hasMFAboolean

O conector requer um MFA para ser executado?

productsstring[]

Produtos suportados pelo conector

productCoveragestring[]

Quais subprodutos a instituição oferece, na própria terminologia do diretório de Open Finance (por exemplo, INVESTMENTS:TREASURE_TITLES, CREDIT_OPERATIONS:INVOICE_FINANCINGS). Onde produtos indicam se o conector atende a investimentos, isso diz quais: um conector que lista INVESTMENTS pode atender a um dos cinco recursos de investimento ou a todos os cinco. Ausente para conectores diretos, que não têm participantes de Open Finance.

oauthboolean

Se 'true', o conector requerirá um fluxo Oauth para ser executado

oauthUrlstring

URL para realizar o fluxo Oauth, se necessário

resetPasswordUrlstring

URL para a instituição financeira para redefinir a senha

healthobject

Status de saúde do conector

isOpenFinanceboolean

Indica se o conector utiliza as APIs regulamentadas de Open Finance

isSandboxboolean

Indica se o conector é um conector de sandbox, destinado a testes em vez de uma instituição real

supportsPaymentInitiationboolean

Indica se o conector suporta a API de iniciação de pagamento

supportsScheduledPaymentsboolean

Indica se o conector suporta pagamentos agendados

supportsSmartTransfersboolean

Indica se o conector suporta transferências inteligentes

supportsBoletoManagementboolean

Indica se o conector suporta gerenciamento de boleto

supportsAutomaticPixboolean

Indica se o conector suporta Pix automático

supportsPixBiometricboolean

Indica se os pagadores podem vincular uma conta na instituição para Pix por biometria

createdAtstring (date-time)

Data de criação

updatedAtstring (date-time)

Data da última modificação

createdAtrequiredstring (date-time)

Data em que a pré-autorização foi criada

updatedAtrequiredstring (date-time)

Data em que a pré-autorização foi atualizada

configurationobject

Configuração de pré-autorização de transferências inteligentes

totalAllowedAmountnumber

Valor máximo a ser alcançado pela soma de todas as transações que utilizam o consentimento autorizado pelo cliente.

transactionLimitnumber

Valor máximo para cada transação de pagamento associada a este consentimento.

periodicLimitsobject

Limites transacionais por período conforme determinado pelo usuário pagante.

errorDetailobject

Detalhe do erro

codestring

Error code

descriptionstring

Error description

detailstring

Error detail

dataConsentrequiredobject

Permissão de saldo solicitada com `linkedJourney`. Nulo quando não foi solicitada. Seu status é atualizado pela instituição quando a pré-autorização é recuperada pelo id; a lista retorna o último status conhecido.

One of:
option 1object

Permissão de saldo concedida com a pré-autorização. Seu status é atualizado pela instituição quando a pré-autorização é recuperada pelo id (`GET /smart-transfers/preauthorizations/{id}`); a lista retorna o último status conhecido.

option 2null | null
debtorrequiredobject | null

A conta que o usuário selecionou na instituição para financiar os pagamentos desta pré-autorização. Nulo até que a pré-autorização esteja `COMPLETED` e a instituição reporte a conta; uma vez conhecida, não muda.

Any of:
option 1object

Informações sobre a conta do pagador, conforme retornado pela instituição após a conclusão do pagamento. Apenas preenchido para intenções de pagamento `PAYMENT_COMPLETED` em conectores que expõem esses dados.

option 2null | null

Example response

json
{
  "id": "string",
  "status": "COMPLETED",
  "consentUrl": "string",
  "clientPreauthorizationId": "string",
  "callbackUrls": {
    "success": "https://merchant.example.com/smart-transfers/4821/success",
    "error": "https://merchant.example.com/smart-transfers/4821/error"
  },
  "recipients": [
    {
      "type": "BANK_ACCOUNT",
      "id": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
      "name": "Conta empresa",
      "taxNumber": "22222222222",
      "paymentInstitution": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "Banco J. Safra S.A.",
        "ispb": "03017677",
        "tradeName": "Banco Safra",
        "compe": "074",
        "createdAt": "2020-04-21T15:00:00.000Z",
        "updatedAt": "2020-04-21T15:00:00.000Z"
      },
      "account": {
        "branch": "0001",
        "number": "123456",
        "type": "CHECKING_ACCOUNT"
      },
      "isDefault": false,
      "pixKey": null,
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    }
  ],
  "connector": {
    "id": 601,
    "name": "Itaú",
    "primaryColor": "EC7000",
    "institutionUrl": "https://www.itau.com.br",
    "country": "BR",
    "type": "PERSONAL_BANK",
    "credentials": [
      {
        "validation": "^\\d{3}\\.?\\d{3}\\.?\\d{3}-?\\d{2}$",
        "validationMessage": "CPF deve ter 11 números.",
        "label": "CPF",
        "name": "cpf",
        "type": "number",
        "placeholder": "",
        "optional": false
      }
    ],
    "imageUrl": "https://cdn.pluggy.ai/assets/connector-icons/201.svg",
    "hasMFA": false,
    "oauth": true,
    "health": {
      "status": "ONLINE",
      "stage": null
    },
    "products": [
      "ACCOUNTS",
      "TRANSACTIONS",
      "IDENTITY",
      "CREDIT_CARDS",
      "PAYMENT_DATA",
      "LOANS",
      "INVESTMENTS"
    ],
    "createdAt": "2023-09-01T18:05:09.145Z",
    "isSandbox": false,
    "isOpenFinance": true,
    "updatedAt": "2024-07-16T15:34:08.028Z",
    "supportsPaymentInitiation": true,
    "supportsScheduledPayments": true,
    "supportsSmartTransfers": true,
    "supportsBoletoManagement": true,
    "supportsAutomaticPix": true
  },
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "configuration": {
    "totalAllowedAmount": 0,
    "transactionLimit": 0,
    "periodicLimits": null
  },
  "errorDetail": {
    "code": "string",
    "description": "string",
    "detail": "string"
  },
  "dataConsent": null,
  "debtor": {
    "name": "string",
    "taxNumber": "string",
    "bankAccount": {
      "agency": "string",
      "account": "string",
      "name": "string"
    }
  }
}
curl -X DELETE \
  'https://api.pluggy.ai/smart-transfers/preauthorizations/{id}/data-consent' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY'
Resposta de exemplo
{
  "id": "string",
  "status": "COMPLETED",
  "consentUrl": "string",
  "clientPreauthorizationId": "string",
  "callbackUrls": {
    "success": "https://merchant.example.com/smart-transfers/4821/success",
    "error": "https://merchant.example.com/smart-transfers/4821/error"
  },
  "recipients": [
    {
      "type": "BANK_ACCOUNT",
      "id": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
      "name": "Conta empresa",
      "taxNumber": "22222222222",
      "paymentInstitution": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "Banco J. Safra S.A.",
        "ispb": "03017677",
        "tradeName": "Banco Safra",
        "compe": "074",
        "createdAt": "2020-04-21T15:00:00.000Z",
        "updatedAt": "2020-04-21T15:00:00.000Z"
      },
      "account": {
        "branch": "0001",
        "number": "123456",
        "type": "CHECKING_ACCOUNT"
      },
      "isDefault": false,
      "pixKey": null,
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    }
  ],
  "connector": {
    "id": 601,
    "name": "Itaú",
    "primaryColor": "EC7000",
    "institutionUrl": "https://www.itau.com.br",
    "country": "BR",
    "type": "PERSONAL_BANK",
    "credentials": [
      {
        "validation": "^\\d{3}\\.?\\d{3}\\.?\\d{3}-?\\d{2}$",
        "validationMessage": "CPF deve ter 11 números.",
        "label": "CPF",
        "name": "cpf",
        "type": "number",
        "placeholder": "",
        "optional": false
      }
    ],
    "imageUrl": "https://cdn.pluggy.ai/assets/connector-icons/201.svg",
    "hasMFA": false,
    "oauth": true,
    "health": {
      "status": "ONLINE",
      "stage": null
    },
    "products": [
      "ACCOUNTS",
      "TRANSACTIONS",
      "IDENTITY",
      "CREDIT_CARDS",
      "PAYMENT_DATA",
      "LOANS",
      "INVESTMENTS"
    ],
    "createdAt": "2023-09-01T18:05:09.145Z",
    "isSandbox": false,
    "isOpenFinance": true,
    "updatedAt": "2024-07-16T15:34:08.028Z",
    "supportsPaymentInitiation": true,
    "supportsScheduledPayments": true,
    "supportsSmartTransfers": true,
    "supportsBoletoManagement": true,
    "supportsAutomaticPix": true
  },
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "configuration": {
    "totalAllowedAmount": 0,
    "transactionLimit": 0,
    "periodicLimits": null
  },
  "errorDetail": {
    "code": "string",
    "description": "string",
    "detail": "string"
  },
  "dataConsent": null,
  "debtor": {
    "name": "string",
    "taxNumber": "string",
    "bankAccount": {
      "agency": "string",
      "account": "string",
      "name": "string"
    }
  }
}