Pluggy · Schema
PaymentRecipient
Bank-account payment recipient. Returned by `/payments/recipients` endpoints and embedded inside payment requests when the request targets a registered recipient.
CompanyOpen FinanceBankingFinancial DataPaymentsBrazilFintech
Properties
| Name | Type | Description |
|---|---|---|
| type | string | Recipient discriminator. Always `BANK_ACCOUNT` for this schema. |
| id | string | Primary identifier |
| taxNumber | string | Account owner tax number. Can be CPF or CNPJ (only numbers). |
| name | string | Account owner name. |
| paymentInstitution | object | Institution that holds the recipient's bank account. |
| isDefault | boolean | Indicates if the recipient is the default one |
| account | object | |
| pixKey | stringnull | Pix key associated with the payment recipient |
| createdAt | string | Date when the payment recipient was created |
| updatedAt | string | Date when the payment recipient was last updated |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/pluggy/json-schema/pluggy-payment-recipient-schema.json",
"title": "PaymentRecipient",
"description": "Bank-account payment recipient. Returned by `/payments/recipients` endpoints and embedded inside payment requests when the request targets a registered recipient.",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/pluggy-payment-recipient-api-openapi.yml#/components/schemas/PaymentRecipient",
"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"
],
"$defs": {
"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"
]
},
"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"
]
}
}
}
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-payment-recipient"
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.