Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-2484155300.5 KB
Smart Transfer

Create preauthorization

Creates the smart transfer preauthorization resource

post/smart-transfers/preauthorizations

Request body

connectorIdnumber required

Primary identifier of the connector

recipientIdsstring[] required
clientPreauthorizationIdstring

Client preauthorization identifier

Example request

{
  "parameters": {
    "cpf": "416.799.495-00",
    "cnpj": "41.679.495/0001-00"
  },
  "callbackUrls": {}
}

Response

Create a Smart Transfer Preauthorization.

idstring required

Preauthorization primary identifier

status'CREATED' | 'COMPLETED' | 'REVOKED' | 'REJECTED' | 'ERROR' required

Preauthorization lifecycle status.

  • CREATED: the preauthorization was created and is awaiting the payer's consent (see consentUrl).
  • COMPLETED: the payer authorized the consent. The preauthorization can now be used to execute payments.
  • REJECTED: the payer rejected the consent.
  • REVOKED: the consent was revoked after being authorized.
  • ERROR: the preauthorization flow failed unexpectedly (see errorDetail).
consentUrlstring

Url to give the consent in the institution

clientPreauthorizationIdstring

Client preauthorization identifier

createdAtstring date-time required

Date when the preauthorization was created

updatedAtstring date-time required

Date when the preauthorization was updated

Example response

{
  "status": "COMPLETED",
  "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
  }
}