Qualpay · Schema
AusListSummaryResponse
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-aus-list-summary-response-schema.json",
"title": "AusListSummaryResponse",
"x-generated": "2026-11-04",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/qualpay-account-updater-api-openapi.yml#/components/schemas/AusListSummaryResponse",
"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/AccountUpdaterSummary"
}
}
},
"$defs": {
"AccountUpdaterSummary": {
"type": "object",
"properties": {
"request_id": {
"type": "integer",
"description": "<strong>Format: </strong>Variable length, up to 10 N<br><strong>Description: </strong>The unique ID assigned to the Account Updater request.",
"format": "int64",
"readOnly": true
},
"merchant_id": {
"type": "integer",
"description": "<strong>Format: </strong>Variable length, up to 16 N<br><strong>Description: </strong>The unique ID assigned to a merchant.",
"format": "int64",
"readOnly": true
},
"status": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 10 A<br><strong>Description: </strong> The status of the Account Updater request: <ul> <li>`INPROGRESS` - The Account Updater request has been validated, and the request is ready to be sent to the Account Updater engine. If needed, the request can be canceled. </li> <li>`QUEUED` - The Account Updater request is queued in the Account Updater service. The request can no longer be canceled. </li> <li>`COMPLETED` - The Account Updater request has completed.</li><li>`CANCELED` - The Account Updater request has been canceled.</li></ul>",
"readOnly": true,
"enum": [
"INPROGRESS",
"QUEUED",
"COMPLETED",
"CANCELED"
]
},
"method": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 32 AN<br><strong>Description: </strong>The source of the Account Updater harvest. Possible values: <ul> <li>`harvest_cust_vault` - Harvest all card IDs belonging to customer profiles in the Customer Vault. </li> <li>`harvest_card_vault` - Harvest all card IDs in the Card Vault.</li> <li>`harvest_card_id `- Harvest specific card IDs. Requested through the Account Updater API.</li> <li>`harvest_api` - Harvest full card numbers. Requested through the Account Updater API.</li></ul>",
"readOnly": true,
"enum": [
"harvest_cust_vault",
"harvest_card_vault",
"harvest_card_id",
"harvest_api"
]
},
"cnt_request": {
"type": "integer",
"description": "<strong>Format: </strong>Variable length, up to 10 N<br><strong>Description: </strong>The number of cards in this request.",
"format": "int32",
"readOnly": true
},
"cnt_response": {
"type": "integer",
"description": "<strong>Format: </strong>Variable length, up to 10 N<br><strong>Description: </strong>The number of cards in this request that were reviewed by the Account Updater service. (This should match the `cnt_request`.) The `cnt_response` field will be `0` if the status field is not `COMPLETED`.",
"format": "int32",
"readOnly": true
},
"cnt_update": {
"type": "integer",
"description": "<strong>Format: </strong>Variable length, up to 10 N<br><strong>Description: </strong>The number of cards in this request that were updated by the Account Updater service. The `cnt_update` field will be `0` if the status field is not `COMPLETED` or if there are no updates by the Account Updater service.",
"format": "int32",
"readOnly": true
},
"request_date": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 10 AN, in YYYY-MM-DD format<br><strong>Description: </strong>The Account Updater request date, the date when a harvest request was sent to the Account Updater service.",
"readOnly": true
},
"rejected_cards": {
"type": "array",
"description": "<strong>Description: </strong>An array of card IDs excluded from the request when the Account Updater request was created. A card ID may be excluded from the request if the card is not found in the system, if it is not a U.S.-issued card, or if the card is held for harvesting. Only credit cards can be harvested; card IDs belonging to ACH payment are rejected.",
"readOnly": true,
"items": {
"$ref": "#/$defs/RejectedCards"
}
}
}
},
"RejectedCards": {
"type": "object",
"properties": {
"card_id": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 32 AN<br><strong>Description: </strong>The `card_id` of the card that was excluded from the request.",
"readOnly": true
},
"reject_reason": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, AN<br><strong>Description: </strong>The reason the card was excluded from the harvest request.",
"readOnly": true
}
}
}
}
}
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-aus-list-summary-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.