The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are Connector (24 properties), PaymentRequest (19 properties), CreateAutomaticPixPaymentRequest (15 properties), Boleto (13 properties). Each schema is shown below with its type and property counts.
PaymentRecipientAccount
object
Payment receiver bank account information
3 properties3 required
AutomaticPixPaymentAttempt
object
Payment attempt. It represents an attempt to complete this payment. Useful for tracking the payment history.
5 properties3 required
PaymentRecipient
object
Bank-account payment recipient. Returned by /payments/recipients endpoints and embedded inside payment requests when the request targets a registered recipient.
10 properties9 required
ConnectorHealth
object
Connector health status
4 properties
AutomaticPixPaymentErrorDetail
object
Details about an error that occurred with the automatic PIX payment
2 properties2 required
AutomaticPixFirstPayment
object
Definitions for the first payment. It is considered as the user's enrollment payment for the service.
3 properties1 required
WEEKLY
object
Schedule attribute to generate weekly payments on a specific day of the week.
4 properties4 required
SmartAccount
object
Pluggy Smart Account (escrow account) attached to a payment request. Receives funds and lets the client orchestrate splits and withdrawals.
8 properties6 required
PaymentCustomer
object
Response with information related to a payment customer
9 properties5 required
DAILY
object
Schedule attribute to generate daily payments starting from startDate.
3 properties3 required
AutomaticPixSchedulerConfiguration
object
Configuration for automatic scheduling of payments. When enabled, the system will schedule payments according to the consent interval and start date.
3 properties1 required
PaymentRequest
object
Response with information related to a payment request
19 properties5 required
ScheduleAutomaticPixPaymentRequest
object
Request to schedule an Automatic PIX payment
5 properties2 required
ConnectorIncident
object
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 a…
11 properties9 required
PaymentRequestCallbackUrls
object
Redirect urls after the payment was completed or ended in error status
3 properties
MONTHLY
object
Schedule attribute to generate monthly payments on a specific day of the month.
4 properties4 required
BoletoRecipient
object
Boleto recipient information
2 properties2 required
CreateAutomaticPixPaymentRequest
object
Automatic PIX data
15 properties3 required
AutomaticPixRetriesConfiguration
object
“Configuration for automatic retries. If provided, the scheduled payments associated with this consent will only be retried on the days specified in the array…
1 property1 required
SINGLE
object
Schedule attribute to generate a single payment on a specific future date.
2 properties2 required
PaymentRequestStatus
string
Lifecycle of a payment request. - CREATED: the request was created and is waiting for a payment intent. - INPROGRESS: a payment intent is being processed by th…
BoletoPaymentRecipient
object
Payment recipient inferred from a boleto.
3 properties1 required
AutomaticPix
object
Automatic PIX data
10 properties2 required
AutomaticPixInterval
string
Permitted frequency for recurring PIX payments under a consent.
BoletoPayer
object
Payer of a boleto being paid. Only identity data — this is not the payer of an issued boleto, which carries the full address block under IssuedBoleto.payer.
2 properties2 required
PaymentCustomerType
string
Customer type. - INDIVIDUAL: identified by cpf. - BUSINESS: identified by cnpj.
Boleto
object
Boleto data
13 properties9 required
PaymentInstitution
object
Response with information related to a payment institution
7 properties6 required
AutomaticPixPaymentStatus
string
Status of an individual recurring PIX payment. - SCHEDULED: the payment has been scheduled at the institution. - CREATED: the payment is created and pending ex…
PaymentRequestRecipient
Recipient embedded inside a payment request. Polymorphic depending on the kind of payment. - BANKACCOUNT: a registered bank-account recipient (see PaymentRecip…
PixQrPaymentRecipient
object
Payment recipient inferred from a PIX QR code (only the merchant name is exposed).
2 properties1 required
CUSTOM
object
Schedule attribute to generate payments on an explicit list of dates.
3 properties2 required
AutomaticPixPaymentDetail
Automatic PIX payment detail with additional fields
CredentialSelectOption
object
Option for ConnectorCredential of type select
2 properties2 required
AutomaticPixPayment
object
Automatic PIX payment
11 properties5 required
RetryAutomaticPixPaymentRequest
object
Request to retry an automatic PIX payment
1 property1 required
Connector
object
Connector object
24 properties1 required
ConnectorCredential
object
Credential details for a connector
13 properties4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Pluggy Automatic PIX API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
