POST/smart-transfers/preauthorizations

Criar pré-autorização

Cria o recurso de pré-autorização de transferência inteligente

Request Body

required

object

Create smart transfer preauthorization request data

connectorIdrequirednumber

Identificador principal do conector

parametersrequiredobject

Credentials neccesary to create a smart transfer preauthorization

cpfrequiredstring

CPF do pagador

cnpjstring

CNPJ do pagador

recipientIdsrequiredstring[]

itemsstring

Primary identifier of the payment recipient

callbackUrlsobject

Redirect urls after the preauthorization flow was completed or ended in error status

successstring

Url para onde redirecionar após a pré-autorização ser concluída

errorstring

Url para ser redirecionado após a pré-autorização terminar com status de erro

clientPreauthorizationIdstring

Identificador de pré-autorização do cliente

configurationobject

Smart transfer preauthorization configuration

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

Transactional limits per period as determined by the paying user.

Responses

200Crie uma pré-autorização de Transferência Inteligente.

object

Smart transfer preauthorization

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

Redirect urls after the preauthorization flow was completed or ended in error status

option 2null | null

recipientsrequiredobject[]

itemsobject

Bank-account payment recipient. Returned by `/payments/recipients` endpoints and embedded inside payment requests when the request targets a registered recipient.

connectorrequiredobject

Connector object

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[]

Which sub-products the institution serves, in the Open Finance directory's own vocabulary (for example INVESTMENTS:TREASURE_TITLES, CREDIT_OPERATIONS:INVOICE_FINANCINGS). Where products says whether the connector serves investments at all, this says which ones: a connector listing INVESTMENTS may serve one of the five investment resources or all five. Absent for direct connectors, which have no Open Finance participant.

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

Connector health status

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

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

Smart transfer preauthorization configuration

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

Transactional limits per period as determined by the paying user.

errorDetailobject

Detalhe do erro

codestring

Error code

descriptionstring

Error description

detailstring

Error detail

Example response

json

{
  "id": "string",
  "status": "COMPLETED",
  "consentUrl": "string",
  "clientPreauthorizationId": "string",
  "callbackUrls": {},
  "recipients": [
    {
      "type": "BANK_ACCOUNT",
      "id": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
      "name": "Conta empresa",
      "taxNumber": "12345678900",
      "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"
  }
}

curl -X POST \
  'https://api.pluggy.ai/smart-transfers/preauthorizations' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY' \
  -d '{}'

Resposta de exemplo

{
  "id": "string",
  "status": "COMPLETED",
  "consentUrl": "string",
  "clientPreauthorizationId": "string",
  "callbackUrls": {},
  "recipients": [
    {
      "type": "BANK_ACCOUNT",
      "id": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
      "name": "Conta empresa",
      "taxNumber": "12345678900",
      "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"
  }
}