Qualpay · Schema
AddPayeeRequest
PaymentsPayment ProcessingMerchant ServicesB2B PaymentsReportingTokenization
Properties
| Name | Type | Description |
|---|---|---|
| payee_name | string | Format: Variable length, up to 64 AN Description: Payee name. |
| merchant_id | integer | Format: Variable length, up to 16 N Description: Identifies the merchant to whom this request applies. Optional field, applicable only if the request is sent on be |
| payee_account | object | Description: Payee account information. Possible fields: `type_id`, `tr_number`, `dda_number`, `accountholder_name`. |
| payee_address | object | Description: Payee address. |
| payee_email | array | Description: An array of payee email addresses. |
| payee_phone | string | Format: Variable length, up to 32 N Description: Payee phone number. Prefix the number with `+` and the country code. |
| vendor_id | integer | Unique vendor ID assigned to the integrator. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/qualpay/json-schema/qualpay-add-payee-request-schema.json",
"title": "AddPayeeRequest",
"x-generated": "2026-11-04",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/qualpay-payee-vault-api-openapi.yml#/components/schemas/AddPayeeRequest",
"required": [
"payee_name"
],
"type": "object",
"properties": {
"payee_name": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 64 AN <br><strong>Description:</strong> Payee name."
},
"merchant_id": {
"type": "integer",
"description": "<strong>Format: </strong>Variable length, up to 16 N<br><strong>Description: </strong>Identifies the merchant to whom this request applies. Optional field, applicable only if the request is sent on behalf of another merchant.<br><strong>Conditional Requirement: </strong>Required if this request is on behalf of another merchant."
},
"payee_account": {
"type": "object",
"description": "<strong>Description: </strong>Payee account information. Possible fields: `type_id`, `tr_number`, `dda_number`, `accountholder_name`.",
"items": {
"$ref": "#/$defs/addPayeeAccountRequest"
}
},
"payee_address": {
"description": "<strong>Description: </strong>Payee address.",
"items": {
"$ref": "#/$defs/addPayeeAddressRequest"
}
},
"payee_email": {
"type": "array",
"items": {
"type": "string"
},
"description": "<strong>Description:</strong> An array of payee email addresses."
},
"payee_phone": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 32 N<br><strong>Description: </strong>Payee phone number. Prefix the number with `+` and the country code."
},
"vendor_id": {
"type": "integer",
"description": "Unique vendor ID assigned to the integrator.",
"format": "int64"
}
},
"$defs": {
"addPayeeAccountRequest": {
"type": "object",
"x-display-fields": [
"type_id",
"tr_number",
"dda_number",
"accountholder_name"
],
"properties": {
"type_id": {
"type": "string",
"default": "C",
"description": "<strong>Format: </strong>Fixed length, 1 AN<br><strong>Description:</strong> Bank Account Type. Possible values are: <br> <ul> <li>`C` - Personal checking account</li> <li>`S` - Personal savings account</li> <li>`K` - Business checking account</li> <li>`V` - Business savings account</li> </ul>",
"enum": [
"C",
"S",
"K",
"V"
]
},
"tr_number": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 9 N <br> <strong>Description:</strong>Bank transit/routing number."
},
"dda_number": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 17 N<br><strong>Description: </strong>Owner's account number at the bank."
},
"accountholder_name": {
"type": "string",
"description": "Account holder name"
}
}
},
"addPayeeAddressRequest": {
"type": "object",
"x-display-fields": [
"address1",
"address2",
"city",
"state",
"zip",
"country_code",
"country"
],
"properties": {
"address1": {
"type": "string",
"description": "<strong>Format: </strong>Variable length<br><strong>Description:</strong> Payee mailing address line 1."
},
"address2": {
"type": "string",
"description": "<strong>Format: </strong>Variable length<br><strong>Description:</strong> Payee mailing address line 2."
},
"city": {
"type": "string",
"description": "<strong>Format: </strong>Variable length<br><strong>Description:</strong> Mailing city."
},
"state": {
"type": "string",
"description": "<strong>Format: </strong>Variable length<br><strong>Description:</strong> Mailing state."
},
"zip": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 16 AN<br><strong>Description: </strong>Mailing zip code."
},
"country_code": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length 3 N<br><strong>Description: </strong>ISO numeric country code. Refer to <a href=\"/docs/references\" target=\"_blank\">Country Codes</a> for a list of country codes.",
"default": "840"
},
"country": {
"type": "string",
"description": "<strong>Format: </strong>Variable length<br><strong>Description: </strong>Country name."
}
}
}
}
}
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/qualpay-add-payee-request"
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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.