Pluggy · Schema
SmartTransferPreauthorization
Smart transfer preauthorization
CompanyOpen FinanceBankingFinancial DataPaymentsBrazilFintech
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Preauthorization primary identifier |
| status | string | Preauthorization lifecycle status. - `CREATED`: the preauthorization was created and is awaiting the payer's consent (see `consentUrl`). - `COMPLETED`: the payer authorized the consent. The preauthori |
| consentUrl | string | Url to give the consent in the institution |
| clientPreauthorizationId | stringnull | Client preauthorization identifier |
| callbackUrls | object | |
| recipients | array | |
| connector | object | |
| createdAt | string | Date when the preauthorization was created |
| updatedAt | string | Date when the preauthorization was updated |
| configuration | object | |
| errorDetail | object | Error detail |
| dataConsent | object | Balance permission requested with `linkedJourney`. Null when it was not requested. Its status is refreshed from the institution when the preauthorization is retrieved by id; the list returns the last |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/pluggy/json-schema/pluggy-smart-transfer-preauthorization-schema.json",
"title": "SmartTransferPreauthorization",
"description": "Smart transfer preauthorization",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/pluggy-smart-transfer-api-openapi.yml#/components/schemas/SmartTransferPreauthorization",
"properties": {
"id": {
"type": "string",
"description": "Preauthorization primary identifier"
},
"status": {
"type": "string",
"description": "Preauthorization lifecycle status.\n- `CREATED`: the preauthorization was created and is awaiting the payer's consent (see `consentUrl`).\n- `COMPLETED`: the payer authorized the consent. The preauthorization can now be used to execute payments.\n- `REJECTED`: the payer rejected the consent.\n- `REVOKED`: the consent was revoked after being authorized.\n- `ERROR`: the preauthorization flow failed unexpectedly (see `errorDetail`).",
"enum": [
"CREATED",
"COMPLETED",
"REVOKED",
"REJECTED",
"ERROR"
]
},
"consentUrl": {
"type": "string",
"description": "Url to give the consent in the institution"
},
"clientPreauthorizationId": {
"type": [
"string",
"null"
],
"description": "Client preauthorization identifier"
},
"callbackUrls": {
"anyOf": [
{
"$ref": "#/$defs/SmartTransferCallbackUrls"
},
{
"type": "null"
}
]
},
"recipients": {
"type": "array",
"items": {
"$ref": "#/$defs/PaymentRecipient"
}
},
"connector": {
"$ref": "#/$defs/Connector"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Date when the preauthorization was created"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Date when the preauthorization was updated"
},
"configuration": {
"$ref": "#/$defs/SmartTransferPreauthorizationConfiguration"
},
"errorDetail": {
"type": "object",
"description": "Error detail",
"properties": {
"code": {
"type": "string",
"description": "Error code"
},
"description": {
"type": "string",
"description": "Error description"
},
"detail": {
"type": "string",
"description": "Error detail"
}
}
},
"dataConsent": {
"description": "Balance permission requested with `linkedJourney`. Null when it was not requested. Its status is refreshed from the institution when the preauthorization is retrieved by id; the list returns the last known status.",
"oneOf": [
{
"$ref": "#/$defs/SmartTransferDataConsent"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"id",
"status",
"recipients",
"connector",
"createdAt",
"updatedAt",
"dataConsent"
],
"$defs": {
"Connector": {
"description": "Connector object",
"properties": {
"id": {
"type": "number",
"format": "integer",
"description": "Primary identifier"
},
"name": {
"type": "string",
"description": "Name of the institution"
},
"institutionUrl": {
"type": "string",
"description": "Homepage of the institution"
},
"imageUrl": {
"type": "string",
"description": "Image of the logo hosted by Pluggy"
},
"primaryColor": {
"type": "string",
"description": "Primary color"
},
"type": {
"type": "string",
"description": "Type of institution"
},
"country": {
"type": "string",
"description": "Country located"
},
"credentials": {
"type": "array",
"items": {
"$ref": "#/$defs/ConnectorCredential"
},
"description": "Parameters required to start the connection"
},
"hasMFA": {
"type": "boolean",
"description": "Does the connector require an MFA to execute?"
},
"products": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ACCOUNTS",
"CREDIT_CARDS",
"TRANSACTIONS",
"PAYMENT_DATA",
"INVESTMENTS",
"INVESTMENTS_TRANSACTIONS",
"IDENTITY",
"BROKERAGE_NOTE",
"MOVE_SECURITY",
"LOANS"
]
},
"description": "Products supported by the connector"
},
"productCoverage": {
"type": "array",
"items": {
"type": "string"
},
"description": "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."
},
"oauth": {
"type": "boolean",
"description": "If 'true', the connector requires an Oauth flow to execute"
},
"oauthUrl": {
"type": "string",
"description": "URL to perform Oauth flow if needed"
},
"resetPasswordUrl": {
"type": "string",
"description": "URL to the financial institution to reset the password"
},
"health": {
"$ref": "#/$defs/ConnectorHealth"
},
"isOpenFinance": {
"type": "boolean",
"description": "Indicates if the connector uses the regulated Open Finance APIs"
},
"isSandbox": {
"type": "boolean",
"description": "Indicates if the connector is a sandbox connector, meant for testing rather than a real institution"
},
"supportsPaymentInitiation": {
"type": "boolean",
"description": "Indicates if the connector supports the payment initiation API"
},
"supportsScheduledPayments": {
"type": "boolean",
"description": "Indicates if the connector supports scheduled payments"
},
"supportsSmartTransfers": {
"type": "boolean",
"description": "Indicates if the connector supports smart transfers"
},
"supportsBoletoManagement": {
"type": "boolean",
"description": "Indicates if the connector supports boleto management"
},
"supportsAutomaticPix": {
"type": "boolean",
"description": "Indicates if the connector supports automatic Pix"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Date of creation"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Date of last modification"
}
},
"type": "object",
"required": [
"id"
]
},
"ConnectorCredential": {
"description": "Credential details for a connector",
"properties": {
"name": {
"type": "string",
"description": "Name of the key"
},
"label": {
"type": "string",
"description": "Label for input"
},
"type": {
"enum": [
"text",
"password",
"number",
"image",
"select"
],
"type": "string",
"description": "Type of credential required"
},
"assistiveText": {
"type": "string",
"description": "Text to help the user when completing the input"
},
"data": {
"type": "string",
"description": "Used to return base64 images"
},
"placeholder": {
"type": "string",
"description": "Placeholder text for the input"
},
"validation": {
"type": "string",
"description": "Regex validation for the user's input"
},
"validationMessage": {
"type": "string",
"description": "Validation message when input doesn't match the regex"
},
"mfa": {
"type": "boolean",
"description": "Credential is an MFA parameter and must be refreshed on each execution"
},
"options": {
"type": "array",
"items": {
"$ref": "#/$defs/CredentialSelectOption"
},
"description": "List of possible values for the input"
},
"optional": {
"type": "boolean",
"description": "Whether the credential can be left empty. Always present; defaults to false"
},
"instructions": {
"type": "string",
"description": "Instructions to help the user obtain this credential"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"description": "Expiration date of the credential value, when the institution sets one"
}
},
"type": "object",
"required": [
"name",
"label",
"type",
"optional"
]
},
"ConnectorHealth": {
"description": "Connector health status",
"properties": {
"status": {
"type": "string",
"description": "'ONLINE' | 'OFFLINE' | 'UNSTABLE'"
},
"stage": {
"type": [
"string",
"null"
]
},
"incidents": {
"type": "array",
"description": "Incidents currently affecting this connector, as published on https://status.pluggy.ai. Absent when the connector has none, so a healthy connector's payload is unchanged. Ordered worst-first, so the first entry is the one to show if you only show one. Note this is about the institution, not about your own connections: use it to warn a user before they pick a bank that is known to be failing right now.",
"items": {
"$ref": "#/$defs/ConnectorIncident"
}
},
"details": {
"type": "object",
"description": "Statistics about your recent connections on the connector and recent connection rate (percentage of healthy connections). This field is only present if you include the parameter healthDetails=true. This will be null if there was an error obtaining health details.",
"properties": {
"connectionRateLast6Hours": {
"type": "number",
"description": "A number from 0 to 100: the percentage of executions that succesfully connect to the institution: status of CONNECTION_ERROR,ERROR,SITE_NOT_AVAILABLE decrease the percentage. Any other status (like SUCCESS/LOGIN_ERROR) increase the percentage. The value will be null if there were no connections"
},
"connectionsLast6Hours": {
"type": "number",
"description": "Amount of your connections for this connector during the last 6 hours. 0 if there were no connections"
}
}
}
}
},
"ConnectorIncident": {
"description": "An incident affecting a connector right now, as published on the Pluggy status page. Only incidents active at this moment are listed: a scheduled maintenance appears once its window opens, not when it is announced, and disappears when the window closes.",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Status page identifier of the incident"
},
"title": {
"type": "string",
"description": "Short, customer-facing summary, for example 'XP Banking - Compras parceladas não sendo retornadas'"
},
"description": {
"type": [
"string",
"null"
],
"description": "Longer explanation, when there is one"
},
"type": {
"enum": [
"CONNECTOR_UNAVAILABLE",
"CONNECTOR_DEGRADED",
"INSTITUTION_OUTAGE",
"SCHEDULED_MAINTENANCE",
"CONSENT_ERROR",
"CONNECTION_NOT_UPDATING",
"PARTIAL_SUCCESS",
"ACCOUNTS_MISSING",
"BALANCE_INCORRECT",
"TRANSACTIONS_MISSING",
"TRANSACTIONS_INCORRECT",
"TRANSACTIONS_INSTALLMENTS_ISSUE",
"INVESTMENTS_MISSING",
"INVESTMENTS_INCORRECT",
"IDENTITY_MISSING",
"HISTORICAL_DATA_MISSING",
"WEBHOOK_DELAY",
"PAYMENT_FAILURE",
"OTHER"
],
"type": "string",
"description": "What is broken, as opposed to how badly (severity) or how far along we are (state). Use it to group the same problem across institutions, and to decide which incidents are worth showing your own users: a SCHEDULED_MAINTENANCE and a TRANSACTIONS_MISSING both read as 'degraded' otherwise. OTHER means Pluggy has not classified it, not that nothing is wrong"
},
"product": {
"enum": [
"dados",
"pis",
"pis-agendado",
"pixauto",
"smart",
"infra"
],
"type": "string",
"description": "Which Pluggy product line the incident affects"
},
"kind": {
"enum": [
"INCIDENT",
"MAINTENANCE"
],
"type": "string",
"description": "Whether this is an unplanned incident or a planned maintenance window"
},
"severity": {
"enum": [
"DEGRADED",
"PARTIAL_OUTAGE",
"MAJOR_OUTAGE",
"MAINTENANCE"
],
"type": "string",
"description": "How badly the institution is affected"
},
"state": {
"enum": [
"INVESTIGATING",
"IDENTIFIED",
"MONITORING",
"SCHEDULED"
],
"type": "string",
"description": "Where the incident is in its lifecycle. Resolved incidents are not listed"
},
"startedAt": {
"type": "string",
"format": "date-time",
"description": "When the incident began"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "When the incident was last updated"
},
"url": {
"type": "string",
"description": "Permalink to the incident on the status page, with its full timeline and postmortem. Safe to show to your own users"
}
},
"type": "object",
"required": [
"id",
"title",
"type",
"product",
"kind",
"severity",
"state",
"startedAt",
"url"
]
},
"CredentialSelectOption": {
"description": "Option for ConnectorCredential of type select",
"properties": {
"value": {
"type": "string",
"description": "Value for the option"
},
"label": {
"type": "string",
"description": "Label for the option"
}
},
"type": "object",
"required": [
"value",
"label"
]
},
"PaymentInstitution": {
"description": "Response with information related to a payment institution",
"properties": {
"id": {
"type": "string",
"description": "Primary identifier"
},
"name": {
"type": "string",
"description": "Payment institution name"
},
"tradeName": {
"type": "string",
"description": "Payment institution trade name"
},
"ispb": {
"type": "string",
"description": "Payment institution ISPB"
},
"compe": {
"type": "string",
"description": "Payment institution COMPE"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Date when the payment institution was created"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Date when the payment institution was updated"
}
},
"type": "object",
"required": [
"id",
"name",
"ispb",
"tradeName",
"createdAt",
"updatedAt"
]
},
"PaymentRecipient": {
"description": "Bank-account payment recipient. Returned by `/payments/recipients` endpoints and embedded inside payment requests when the request targets a registered recipient.",
"properties": {
"type": {
"type": "string",
"enum": [
"BANK_ACCOUNT"
],
"description": "Recipient discriminator. Always `BANK_ACCOUNT` for this schema."
},
"id": {
"type": "string",
"description": "Primary identifier"
},
"taxNumber": {
"type": "string",
"description": "Account owner tax number. Can be CPF or CNPJ (only numbers)."
},
"name": {
"type": "string",
"description": "Account owner name."
},
"paymentInstitution": {
"allOf": [
{
"$ref": "#/$defs/PaymentInstitution"
}
],
"description": "Institution that holds the recipient's bank account."
},
"isDefault": {
"type": "boolean",
"description": "Indicates if the recipient is the default one"
},
"account": {
"$ref": "#/$defs/PaymentRecipientAccount"
},
"pixKey": {
"type": [
"string",
"null"
],
"description": "Pix key associated with the payment recipient"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Date when the payment recipient was created"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Date when the payment recipient was last updated"
}
},
"type": "object",
"required": [
"type",
"id",
"name",
"taxNumber",
"paymentInstitution",
"isDefault",
"account",
"createdAt",
"updatedAt"
]
},
"PaymentRecipientAccount": {
"description": "Payment receiver bank account information",
"properties": {
"branch": {
"type": "string",
"description": "Receiver bank account branch (agency)"
},
"number": {
"type": "string",
"description": "Receiver bank account number"
},
"type": {
"type": "string",
"description": "Receiver bank account type, could be: 'CHECKING_ACCOUNT', 'SAVINGS_ACCOUNT' or 'GUARANTEED_ACCOUNT'"
}
},
"type": "object",
"required": [
"branch",
"number",
"type"
]
},
"SmartTransferCallbackUrls": {
"description": "Redirect urls after the preauthorization flow was completed or ended in error status",
"properties": {
"success": {
"type": "string",
"description": "Url to be redirected after the preauthorization was completed"
},
"error": {
"type": "string",
"description": "Url to be redirected after the preauthorization ended in error status"
}
},
"type": "object"
},
"SmartTransferDataConsent": {
"description": "Balance permission granted with the preauthorization. Its status is refreshed from the institution when the preauthorization is retrieved by id (`GET /smart-transfers/preauthorizations/{id}`); the list returns the last known status.",
"type": "object",
"required": [
"status",
"rejectionReason",
"updatedAt"
],
"properties": {
"status": {
"type": "string",
"enum": [
"AWAITING_AUTHORISATION",
"AUTHORISED",
"REJECTED"
],
"description": "AWAITING_AUTHORISATION: the user has not approved yet. AUTHORISED: the balance can be read. REJECTED: the permission was rejected, revoked, cancelled or expired; it does not come back."
},
"rejectionReason": {
"type": [
"string",
"null"
],
"description": "Why the permission is REJECTED, for example CUSTOMER_MANUALLY_REJECTED, CUSTOMER_MANUALLY_REVOKED, CONSENT_EXPIRED or CONSENT_MAX_DATE_REACHED. Null otherwise. New values may appear."
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "When Pluggy last saw the status change."
}
}
},
"SmartTransferPreauthorizationConfiguration": {
"description": "Smart transfer preauthorization configuration",
"properties": {
"totalAllowedAmount": {
"type": "number",
"description": "Maximum amount to be reached by the sum of all transactions that use the consent authorized by the customer."
},
"transactionLimit": {
"type": "number",
"description": "Maximum amount for each payment transaction associated with this consent."
},
"periodicLimits": {
"$ref": "#/$defs/SmartTransferPreauthorizationConfigurationPeriodicLimits"
}
},
"type": "object"
},
"SmartTransferPreauthorizationConfigurationPeriodicLimit": {
"description": "Transactional limit per period. If sent, at least one of the fields (quantityLimit or transactionLimit) must be filled in.",
"properties": {
"quantityLimit": {
"type": "number",
"description": "Maximum number of transactions allowed to occur in the period."
},
"transactionLimit": {
"type": "number",
"description": "Maximum amount to be transacted in the period."
}
}
},
"SmartTransferPreauthorizationConfigurationPeriodicLimits": {
"description": "Transactional limits per period as determined by the paying user.",
"properties": {
"day": {
"description": "Daily transactional limit.",
"$ref": "#/$defs/SmartTransferPreauthorizationConfigurationPeriodicLimit"
},
"week": {
"description": "Weekly transactional limit.",
"$ref": "#/$defs/SmartTransferPreauthorizationConfigurationPeriodicLimit"
},
"month": {
"description": "Monthly transactional limit.",
"$ref": "#/$defs/SmartTransferPreauthorizationConfigurationPeriodicLimit"
},
"year": {
"description": "Yearly transactional limit.",
"$ref": "#/$defs/SmartTransferPreauthorizationConfigurationPeriodicLimit"
}
}
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/pluggy-smart-transfer-preauthorization"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.