Qualpay · Schema
PGApiVerifyRequest
PaymentsPayment ProcessingMerchant ServicesB2B PaymentsReportingTokenization
Properties
| Name | Type | Description | ||
|---|---|---|---|---|
| merchant_id | integer | Format: Variable length, up to 12 N Description: Unique identifier in our system. |
||
| card_id | string | Format: Variable length, up to 32 AN Description: Card ID received from a tokenization request. This may be used in place of a card number or card swipe. | ||
| card_number | string | Format: Variable length, up to 19 N Description: Cardholder's card number. Conditional Requirement: Refer to card_swipe |
string | Format: Variable length, up to 79 AN Description: Contains either track 1 or track 2 magnetic stripe data. If the magnetic stripe reader provides both track 1 and |
| exp_date | string | Format: Fixed length, 4 N, MMYY format Description: Expiration date of cardholder’s card number. When the field `card_number` is present in the request, this is re |
||
| tr_number | string | Format: Fixed length, 9 N Description: Bank transit/routing number. Applicable for ACH payments. Conditional Requirement: Refer to dda_number |
string | Format: Variable length, up to 17 N Description: Owner's account number at the bank. Applicable for ACH payments. Conditional Requirement: Refe |
| avs_address | string | Format: Variable length, up to 20 AN Description: Street address of the cardholder. If present, it will be included in the authorization request sent to the issuin |
||
| avs_zip | string | Format: Variable length, up to 9 N Description: Zip code of the cardholder. If present, it will be included in the authorization request sent to the issuing bank.< |
||
| cardholder_name | string | Format: Variable length, up to 64 AN Description: When provided in a tokenize request, the cardholder's name will be stored along with the cardholder's card number |
||
| client_ip | string | Format: Variable length AN Description: The cardholder's IP address. |
||
| customer | object | Description: In an authorization, credit, force, sale, or verify, the payment gateway stores customer data when the merchant sends the following:
|
||
| customer_code | string | Format: Variable length, up to 17 AN Description: Reference code supplied by the cardholder to the merchant. |
||
| cvv2 | string | Format: Variable length, up to 4 N Description: CVV2 or CID value from the signature panel on the back of the cardholder's card. If present during a request that r |
||
| developer_id | string | Format: Variable length, up to 32 AN Description: Use to indicate which company developed the integration or the name of the payment solution that is connected to |
||
| echo_fields | string | Format: Variable length Description: This field contains a JSON array of field data that will be echoed back in the response message. |
||
| email_address | array | Format:Variable length, AN Description: An array of account holder email addresses. |
||
| loc_id | string | Format: Variable length, up to 4 N Description: When a merchant has more than one location using the same currency, this value is used to specify the location for |
||
| merch_ref_num | string | Format: Variable length, up to 128 AN Description: A merchant-provided reference value that will be stored with the transaction and included with the transaction |
||
| moto_ecomm_ind | string | Format: Fixed length, 1 N Default: 7 Description: Indicates the type of MOTO transaction. Possible values:
|
||
| payload_apple_pay | string | Format: Variable length Description: Apple Pay payload. |
||
| payload_google_pay | string | Format: Variable length Description: Google Pay payload. |
||
| profile_id | string | Format: Fixed length, 20 N Description: Explicitly identifies which Payment Gateway profile should be used for the request. |
||
| report_data | string | Format: Variable length Description: This field contains a JSON array of field data that will be included with the transaction data reported in Merchant Manager. |
||
| session_id | string | INTERNAL USE ONLY. | ||
| tokenize | boolean | Default: false Description: In an authorization, credit, force, sale, or verify request, the merchant can set `tokenize` to `true`. The payment gateway then stores |
||
| type_id | string | Format: Fixed length, 1 AN Default: C Description: Bank Account Type. Applicable for ACH payments. Possible values are:
|
||
| user_id | integer | INTERNAL USE ONLY. | ||
| vendor_id | integer | Format: Fixed length, 10 N Description: Identifies the vendor to which this request applies. Conditional Requirement: This field is required f |
||
| single_use | boolean | Default: false Description: In a Tokenize request, setting the `single_use` field to `true` will cause a single-use token to be generated. This token will expire i |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/qualpay/json-schema/qualpay-pgapi-verify-request-schema.json",
"title": "PGApiVerifyRequest",
"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/PGApiVerifyRequest",
"type": "object",
"required": [
"merchant_id"
],
"properties": {
"merchant_id": {
"type": "integer",
"format": "int64",
"description": "<strong>Format: </strong>Variable length, up to 12 N<br><strong>Description: </strong>Unique identifier in our system."
},
"card_id": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 32 AN<br><strong>Description: </strong>Card ID received from a tokenization request. This may be used in place of a card number or card swipe.<br><strong>Conditional Requirement: </strong>Refer to <a href=\"/docs/about-our-api#card-or-bank-account-data-sources-and-conditional-requirements\" target=\"_blank\"> Card or Bank Account Data Sources and Conditional Requirements</a>"
},
"card_number": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 19 N<br><strong>Description: </strong>Cardholder's card number.<br><strong>Conditional Requirement: </strong>Refer to <a href=\"/docs/about-our-api#card-or-bank-account-data-sources-and-conditional-requirements\" target=\"_blank\">Card or Bank Account Data Sources and Conditional Requirements</a>"
},
"card_swipe": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 79 AN<br><strong>Description: </strong>Contains either track 1 or track 2 magnetic stripe data. If the magnetic stripe reader provides both track 1 and track 2 data in a single read, it is the responsibility of the implementer to send data for only one of the two tracks. <br><strong>Conditional Requirement: </strong>Refer to <a href=\"/docs/about-our-api#card-or-bank-account-data-sources-and-conditional-requirements\" target=\"_blank\">Card or Bank Account Data Sources and Conditional Requirements</a>"
},
"exp_date": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 4 N, MMYY format<br><strong>Description: </strong>Expiration date of cardholder’s card number. When the field `card_number` is present in the request, this is required. When `card_swipe` is present, this must NOT be present. When `card_id` or `customer_id` is present, this field may also be present; if it is not, the saved expiration date used.<br><strong>Conditional Requirement: </strong>Refer to <a href=\"/docs/about-our-api#card-or-bank-account-data-sources-and-conditional-requirements\" target=\"_blank\">Card or Bank Account Data Sources and Conditional Requirements</a>"
},
"tr_number": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 9 N<br><strong>Description: </strong>Bank transit/routing number. Applicable for ACH payments.<br><strong>Conditional Requirement: </strong>Refer to <a href=\"/docs/about-our-api#card-or-bank-account-data-sources-and-conditional-requirements\" target=\"_blank\">Card or Bank Account Data Sources and Conditional Requirements</a>"
},
"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. Applicable for ACH payments.<br><strong>Conditional Requirement: </strong>Refer to <a href=\"/docs/about-our-api#card-or-bank-account-data-sources-and-conditional-requirements\" target=\"_blank\">Card or Bank Account Data Sources and Conditional Requirements</a>"
},
"avs_address": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 20 AN<br><strong>Description: </strong>Street address of the cardholder. If present, it will be included in the authorization request sent to the issuing bank."
},
"avs_zip": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 9 N<br><strong>Description: </strong>Zip code of the cardholder. If present, it will be included in the authorization request sent to the issuing bank.<br><strong>Conditional Requirement: </strong>This field is required if `avs_address` is present."
},
"cardholder_name": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 64 AN<br><strong>Description: </strong>When provided in a tokenize request, the cardholder's name will be stored along with the cardholder's card number and expiration date."
},
"client_ip": {
"type": "string",
"description": "<strong>Format: </strong>Variable length AN<br><strong>Description: </strong>The cardholder's IP address."
},
"customer": {
"description": "<strong>Description: </strong>In an authorization, credit, force, sale, or verify, the payment gateway stores customer data when the merchant sends the following: <ul><li>`tokenize` (set to `true`),</li> <li> either `card_number` or `card_swipe`,</li> <li> `customer_id`, and </li> <li> `customer`.</li></ul> <p>Cannot be used to update an existing `customer_id`.</p>",
"$ref": "#/$defs/Customer"
},
"customer_code": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 17 AN<br><strong>Description: </strong>Reference code supplied by the cardholder to the merchant."
},
"cvv2": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 4 N<br><strong>Description: </strong>CVV2 or CID value from the signature panel on the back of the cardholder's card. If present during a request that requires authorization, the value will be sent to the issuer for validation."
},
"developer_id": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 32 AN<br><strong>Description: </strong>Use to indicate which company developed the integration or the name of the payment solution that is connected to us. Suggested usage is `softwareABCv1.0` or `companyXYZv2.0`."
},
"echo_fields": {
"type": "string",
"description": "<strong>Format: </strong>Variable length<br><strong>Description: </strong>This field contains a JSON array of field data that will be echoed back in the response message."
},
"email_address": {
"type": "array",
"description": "<strong>Format:</strong>Variable length, AN<br><strong>Description: </strong>An array of account holder email addresses.",
"items": {
"type": "string"
}
},
"loc_id": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 4 N<br><strong>Description: </strong>When a merchant has more than one location using the same currency, this value is used to specify the location for this request."
},
"merch_ref_num": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 128 AN<br><strong>Description: </strong> A merchant-provided reference value that will be stored with the transaction and included with the transaction data reported in Merchant Manager. This value will also be attached to any lifecycle transactions (e.g. retrieval requests and chargebacks) that may occur."
},
"moto_ecomm_ind": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 1 N<br><strong>Default: </strong>7<br><strong>Description: </strong>Indicates the type of MOTO transaction. Possible values: <ul><li>`0` - Card present (not MOTO/e-commerce)</li><li>`1` - One-time MOTO transaction</li><li>`2` - Recurring </li><li>`3` - Installment </li><li>`7` - E-commerce channel encrypted (SSL)</li></ul> <p><strong>Conditional Requirement:</strong> Recurring transactions require `moto_ecomm_ind` set to `2`.</p>"
},
"payload_apple_pay": {
"type": "string",
"description": "<strong>Format: </strong>Variable length<br><strong>Description: </strong>Apple Pay payload."
},
"payload_google_pay": {
"type": "string",
"description": "<strong>Format: </strong>Variable length<br><strong>Description: </strong>Google Pay payload."
},
"profile_id": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 20 N<br><strong>Description: </strong>Explicitly identifies which Payment Gateway profile should be used for the request."
},
"report_data": {
"type": "string",
"description": "<strong>Format: </strong>Variable length<br><strong>Description: </strong>This field contains a JSON array of field data that will be included with the transaction data reported in Merchant Manager."
},
"session_id": {
"type": "string",
"description": "INTERNAL USE ONLY."
},
"tokenize": {
"type": "boolean",
"description": "<strong>Default: </strong>false<br><strong>Description: </strong>In an authorization, credit, force, sale, or verify request, the merchant can set `tokenize` to `true`. The payment gateway then stores the cardholder data and provides a `card_id` in the response. If the `card_number` or `card_id` in the request is already tokenized, this flag instructs the payment gateway to update the associated data (e.g. `avs_address`, `avs_zip`, `exp_date`) if present.<br><strong>Conditional Requirement: </strong>Refer to <a href=\"/docs/about-our-api#card-or-bank-account-data-sources-and-conditional-requirements\" target=\"_blank\">Card or Bank Account Data Sources and Conditional Requirements</a>"
},
"type_id": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 1 AN<br><strong>Default: </strong>C<br><strong>Description: </strong>Bank Account Type. Applicable for ACH payments. Possible values are: <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>"
},
"user_id": {
"type": "integer",
"format": "int64",
"description": "INTERNAL USE ONLY."
},
"vendor_id": {
"type": "integer",
"format": "int64",
"description": "<strong>Format: </strong>Fixed length, 10 N<br><strong>Description: </strong>Identifies the vendor to which this request applies. <br><strong>Conditional Requirement: </strong>This field is required for Qualpay partner accounts."
},
"single_use": {
"type": "boolean",
"description": "<strong>Default: </strong>false<br><strong>Description: </strong>In a Tokenize request, setting the `single_use` field to `true` will cause a single-use token to be generated. This token will expire in 10 minutes or when first used."
}
},
"$defs": {
"Customer": {
"type": "object",
"properties": {
"billing_addr1": {
"type": "string",
"description": "<strong>Format: </strong>Variable length<br><strong>Description: </strong>Customer billing address street."
},
"billing_addr2": {
"type": "string",
"description": "<strong>Format: </strong>Variable length<br><strong>Description: </strong>Customer billing address, line 2."
},
"billing_city": {
"type": "string",
"description": "<strong>Format: </strong>Variable length<br><strong>Description: </strong>Customer billing city."
},
"billing_country": {
"type": "string",
"description": "<strong>Format: </strong>Variable length<br><strong>Description: </strong>Customer billing country."
},
"billing_country_code": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 3 N<br><strong>Description: </strong>ISO numeric country code for the billing address. Refer to <a href=\"/docs/references\" target=\"_blank\">Country Codes</a> for a list of country codes."
},
"billing_state": {
"type": "string",
"description": "<strong>Format: </strong>Variable length<br><strong>Description: </strong>Customer billing state (abbreviated)."
},
"billing_zip": {
"type": "string",
"description": "<strong>Format: </strong>Variable length<br><strong>Description: </strong>Customer billing zip code."
},
"billing_zip4": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 4 N<br><strong>Description: </strong>Customer billing zip+4 code if applicable."
},
"customer_email": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 64 AN<br><strong>Description: </strong>Customer email address."
},
"customer_firm_name": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 64 AN<br><strong>Description: </strong>Customer business name if applicable.<br><strong>Conditional Requirement: </strong>Either customer first and last name or firm name is required. "
},
"customer_first_name": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 32 AN<br><strong>Description: </strong>Customer first name.<br><strong>Conditional Requirement: </strong>Either customer first and last name or firm name is required. "
},
"customer_last_name": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 32 AN<br><strong>Description: </strong>Customer last name.<br><strong>Conditional Requirement: </strong>Either customer first and last name or firm name is required. "
},
"customer_phone": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 16 N<br><strong>Description: </strong>Customer phone number."
},
"shipping_addresses": {
"type": "array",
"description": "List of shipping addresses for customer.",
"items": {
"$ref": "#/$defs/PGShippingAddress"
}
}
}
},
"PGShippingAddress": {
"type": "object",
"required": [
"shipping_addr1",
"shipping_city",
"shipping_first_name",
"shipping_last_name",
"shipping_state",
"shipping_zip"
],
"properties": {
"primary": {
"type": "boolean",
"description": "<strong>Default: </strong>false<br><strong>Description: </strong>Identifies the primary shipping address when there are multiple shipping addresses."
},
"shipping_addr1": {
"type": "string",
"description": "<strong>Format: </strong>Variable length<br><strong>Description: </strong>Customer shipping address line 1."
},
"shipping_addr2": {
"type": "string",
"description": "<strong>Format: </strong>Variable length<br><strong>Description: </strong>Customer shipping address line 2."
},
"shipping_city": {
"type": "string",
"description": "<strong>Format: </strong>Variable length<br><strong>Description: </strong>Customer shipping city."
},
"shipping_country": {
"type": "string",
"description": "<strong>Format: </strong>Variable length<br><strong>Description: </strong>Customer shipping country."
},
"shipping_country_code": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 3 N<br><strong>Description: </strong>ISO numeric country code for the shipping address. Refer to <a href=\"/docs/references\" target=\"_blank\">Country Codes</a> for a list of country codes. If `shipping_country_code` is provided, `shipping_country` will be updated to match the country code. "
},
"shipping_firm_name": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 64 AN<br><strong>Description: </strong>Business name if applicable. "
},
"shipping_first_name": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 32 AN<br><strong>Description: </strong>Customer shipping first name."
},
"shipping_last_name": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 32 AN<br><strong>Description: </strong>Customer shipping last name."
},
"shipping_state": {
"type": "string",
"description": "<strong>Format: </strong>Variable length<br><strong>Description: </strong>Customer shipping state (abbreviated)."
},
"shipping_zip": {
"type": "string",
"description": "<strong>Format: </strong>Variable length<br><strong>Description: </strong>Customer shipping zip code."
},
"shipping_zip4": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 4 N<br><strong>Description: </strong>Customer shipping zip+4 code if applicable."
}
}
}
}
}
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-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.