Qualpay · Schema
PGApiVerifyResponse
PaymentsPayment ProcessingMerchant ServicesB2B PaymentsReportingTokenization
Properties
| Name | Type | Description | ||||
|---|---|---|---|---|---|---|
| card_number | string | Format: Variable length, up to 16 AN Description: Cardholder's card number (truncated). |
||||
| merchant_advice_code | string | Format: Fixed length 4 AN Description: Recurring transaction advice for Mastercard authorizations. Refer to pg_id |
string | Format: Fixed length, 32 AN Description: 32-byte unique identifier generated by the payment gateway, returned in all valid responses. |
||
| rcode | string | Format: Fixed length, 3 AN Description: Response code from the payment gateway. `000` indicates success. Refer to rmsg |
string | Format: Variable length Description: Response text from the payment gateway. |
||
| card_id | string | Format: Fixed length, 32 AN Description: 32-byte value returned after successful tokenize request or when a transaction requests tokenization of the cardholder dat |
||||
| auth_code | string | Format: Fixed length, 6 AN Description: Card issuer authorization code returned on successful authorization request. The `auth_code` will not appear in the payment |
||||
| auth_avs_result | string | Format: Fixed length, 1 AN Description: AVS result from card issuer (if `avs_zip` and optionally `avs_address` were provided in the request). Refer to auth_cvv2_result |
string | Format: Fixed length, 1 AN Description: CVV2 result from card issuer (if CVV2 data was sent in the request). Refer to echo_fields |
string | Format: Variable length Description: Data that was provided in `echo_fields` in the request. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/qualpay/json-schema/qualpay-pgapi-verify-response-schema.json",
"title": "PGApiVerifyResponse",
"x-generated": "2026-11-04",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/qualpay-payment-gateway-api-openapi.yml#/components/schemas/PGApiVerifyResponse",
"type": "object",
"properties": {
"card_number": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 16 AN<br><strong>Description: </strong>Cardholder's card number (truncated)."
},
"merchant_advice_code": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length 4 AN<br><strong>Description: </strong>Recurring transaction advice for Mastercard authorizations. Refer to <a href=\"/docs/test-conventions#mastercard-merchant-advice-codes\" target=\"_blank\"> Mastercard Merchant Advice Codes</a> for possible values.",
"readOnly": true
},
"pg_id": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 32 AN<br><strong>Description: </strong>32-byte unique identifier generated by the payment gateway, returned in all valid responses.",
"readOnly": true
},
"rcode": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 3 AN<br><strong>Description: </strong>Response code from the payment gateway. `000` indicates success. Refer to <a href=\"/docs/api-conventions#payment-gateway-api-response-codes\" target=\"_blank\">Payment Gateway Response Codes</a> for the entire list of Payment Gateway response codes.",
"readOnly": true
},
"rmsg": {
"type": "string",
"description": "<strong>Format: </strong>Variable length<br><strong>Description: </strong>Response text from the payment gateway.",
"readOnly": true
},
"card_id": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 32 AN<br><strong>Description: </strong>32-byte value returned after successful tokenize request or when a transaction requests tokenization of the cardholder data.",
"readOnly": true
},
"auth_code": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 6 AN<br><strong>Description: </strong>Card issuer authorization code returned on successful authorization request. The `auth_code` will not appear in the payment gateway response for sales on accounts that are not net-new because those accounts have already been validated.",
"readOnly": true
},
"auth_avs_result": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 1 AN<br><strong>Description: </strong>AVS result from card issuer (if `avs_zip` and optionally `avs_address` were provided in the request). Refer to <a href=\"/docs/api-conventions#payment-result-codes-for-avs\" target=\"_blank\">Payment Result Codes for AVS</a> for possible values.",
"readOnly": true
},
"auth_cvv2_result": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 1 AN<br><strong>Description: </strong>CVV2 result from card issuer (if CVV2 data was sent in the request). Refer to <a href=\"/docs/api-conventions#payment-result-codes-for-cvv2\" target=\"_blank\">Payment Result Codes for CVV2</a> for possible values.",
"readOnly": true
},
"echo_fields": {
"type": "string",
"description": "<strong>Format: </strong>Variable length<br><strong>Description: </strong>Data that was provided in `echo_fields` in the 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-pgapi-verify-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.