Qualpay · Schema
PayeeListResponse
PaymentsPayment ProcessingMerchant ServicesB2B PaymentsReportingTokenization
Properties
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/qualpay/json-schema/qualpay-payee-list-response-schema.json",
"title": "PayeeListResponse",
"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/PayeeListResponse",
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "<strong>Format: </strong>Fixed length, 1 N<br><strong>Description: </strong>Response code from the API. `0` indicates success. Refer to <a href=\"/docs/api-conventions#platform-api-response-codes\" target=\"_blank\">Platform API Response Codes</a> for the entire list of return codes.",
"format": "int32",
"readOnly": true
},
"message": {
"type": "string",
"description": "<strong>Format: </strong>Variable length AN<br><strong>Description: </strong>A short description of the API response code.",
"readOnly": true
},
"totalPages": {
"type": "integer",
"description": "<strong>Format: </strong>Variable length N<br><strong>Description: </strong>Total number of pages. ",
"format": "int32",
"readOnly": true
},
"totalRecords": {
"type": "integer",
"description": "<strong>Format: </strong>Variable length, up to 3 N<br><strong>Description: </strong>Total number of records up to a maximum of 100.",
"format": "int32",
"readOnly": true
},
"data": {
"type": "array",
"description": "An array of the resource object.",
"readOnly": true,
"items": {
"$ref": "#/$defs/Payee"
}
}
},
"$defs": {
"Payee": {
"type": "object",
"properties": {
"payee_id": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 32 AN<br><strong>Description: </strong>A unique ID generated by Qualpay to identify a payee.",
"format": "int64"
},
"payee_name": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 64 AN <br><strong>Description:</strong> Payee name."
},
"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."
},
"payee_email": {
"type": "array",
"items": {
"type": "string"
},
"description": "<strong>Description:</strong> Payee email addresses."
},
"payee_address": {
"$ref": "#/$defs/addPayeeAddressRequest"
},
"payee_account": {
"$ref": "#/$defs/PayeeAccountResponse"
}
}
},
"PayeeAccountResponse": {
"type": "object",
"properties": {
"type_id": {
"type": "string",
"default": "C",
"description": "<strong>Format: </strong>Fixed length, 1 AN<br><strong>Description:</strong> Bank account type. Possible values: <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": "<strong>Format: </strong>Variable length, AN<br><strong>Description: </strong>Account holder's name."
},
"verified_date": {
"type": "string",
"description": "<strong>Format: </strong>Variable length<br><strong>Description: </strong>Verified date. The date the account was last successfully verified."
}
}
},
"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-payee-list-response"
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.