Qualpay · Schema
AddBillingCardRequest
PaymentsPayment ProcessingMerchant ServicesB2B PaymentsReportingTokenization
Properties
| Name | Type | Description |
|---|---|---|
| billing_firm_name | string | Format: Variable length, up to 64 AN Description: Business name, if applicable. Conditional Requirement: When adding an ACH payment method, th |
| billing_first_name | string | Format: Variable length, up to 32 AN Description: Billing first name. Conditional Requirement: When adding an ACH payment method, the followin |
| billing_last_name | string | Format: Variable length, up to 32 AN Description: Billing last name. Conditional Requirement: When adding an ACH payment method, the following |
| card_id | string | Format: Fixed length, 32 AN Description: Card ID received from a tokenization request. `card_id` may be used in place of `card_number` or `card_swipe`. Duplicate c |
| card_number | string | Format: Variable length, up to 16 AN Description: The full card number. When a card is added, it is immediately tokenized, and a `card_id` value is generated and s |
| exp_date | string | Format: Fixed length, 4 N, MMYY format Description: Expiration date of the cardholder's card number. Conditional Requirement: When adding a bil |
| tr_number | string | Format: Fixed length, 9 N Description: Bank transit/routing number. Applicable for ACH account numbers. Conditional Requirement: When adding a |
| dda_number | string | Format: Variable length, up to 17 N Description: Owner's account number at the bank. Applicable for ACH account numbers. Conditional Requirement: |
| billing_addr1 | string | Format: Variable length, up to 128 AN Description: Billing street address. This address will also be used for AVS verification if AVS verification is enabled. |
| billing_addr2 | string | Format: Variable length, up to 128 AN Description: Billing address line 2. |
| billing_city | string | Format: Variable length, up to 64 AN Description: Billing city. |
| billing_state | string | Format: Variable length, up to 3 AN Description: Billing state. |
| billing_zip | string | Format: Variable length, up to 10 AN Description: Billing zip code. This field will also be used for AVS verification if AVS verification is enabled. C |
| billing_zip4 | string | Format: Fixed length, 4 N Description: Billing zip+4 code if applicable. |
| billing_country | string | Format: Variable length, up to 128 AN Description: Billing country. |
| billing_country_code | string | Format: Fixed length, 3 AN Description: ISO numeric country code for the billing address. Refer to Country Codes for |
| billing_email | array | Format: Variable length, up to 128 AN Description: An array of billing email addresses. |
| 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 where |
| merchant_id | integer | Format: Variable length, up to 16 AN Description: Identifies the merchant to whom this request applies. Optional field, applicable only if the request is sent on b |
| primary | boolean | Description: Set this field to `true` if this should be the default card. The default card will be used in recurring billing payments. Default: false |
| type_id | string | Format: Fixed length, 1 AN Description: Bank account type. Applicable for ACH account numbers. Possible values:
|
| verify | boolean | Description: Set this field to `true` if `card_number` or `card_id` should be verified by the issuer before adding to Customer Vault. When this field is set to `true`, the customer is |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/qualpay/json-schema/qualpay-add-billing-card-request-schema.json",
"title": "AddBillingCardRequest",
"x-generated": "2026-11-04",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/qualpay-customer-vault-api-openapi.yml#/components/schemas/AddBillingCardRequest",
"required": [
"billing_zip"
],
"type": "object",
"properties": {
"billing_firm_name": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 64 AN<br><strong>Description: </strong>Business name, if applicable. <br><strong>Conditional Requirement:</strong> When adding an ACH payment method, the following is required:<br> (a) `tr_number`, `dda_number`, `billing_first_name`, and `billing_last_name`, or<br> (b) `tr_number`, `dda_number`, and `billing_firm_name`."
},
"billing_first_name": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 32 AN<br><strong>Description: </strong>Billing first name. <br><strong>Conditional Requirement:</strong> When adding an ACH payment method, the following is required:<br> (a) `tr_number`, `dda_number`, `billing_first_name`, and `billing_last_name`, or<br> (b) `tr_number`, `dda_number`, and `billing_firm_name`."
},
"billing_last_name": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 32 AN<br><strong>Description: </strong>Billing last name. <br><strong>Conditional Requirement:</strong> When adding an ACH payment method, the following is required:<br> (a) `tr_number`, `dda_number`, `billing_first_name`, and `billing_last_name`, or<br> (b) `tr_number`, `dda_number`, and `billing_firm_name`."
},
"card_id": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 32 AN<br><strong>Description: </strong>Card ID received from a tokenization request. `card_id` may be used in place of `card_number` or `card_swipe`. Duplicate cards are not permitted for a customer in the system. The `card_id` should be permanent. If a single-use `card_id` should be used, set the `verify` field to `true`, which makes the `card_id` permanent.<br><strong>Conditional Requirement:</strong> When adding a billing card, the following is required: <br> (a) `card_number`, `exp_date`, and `billing_zip`, or<br> (b) `card_id` and `billing_zip`."
},
"card_number": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 16 AN<br><strong>Description: </strong>The full card number. When a card is added, it is immediately tokenized, and a `card_id` value is generated and stored in Vault. Duplicate cards are not permitted for a customer in the system.<br><strong>Conditional Requirement:</strong> When adding a billing card, the following is required: <br> (a) `card_number`, `exp_date`, and `billing_zip`, or<br> (b) `card_id` and `billing_zip`."
},
"exp_date": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 4 N, MMYY format<br><strong>Description: </strong>Expiration date of the cardholder's card number.<br><strong>Conditional Requirement:</strong> When adding a billing card, the following is required: <br> (a) `card_number`, `exp_date`, and `billing_zip`, or<br> (b) `card_id` and `billing_zip`."
},
"tr_number": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 9 N<br><strong>Description: </strong>Bank transit/routing number. Applicable for ACH account numbers. <br><strong>Conditional Requirement:</strong> When adding an ACH payment method, the following is required:<br> (a) `tr_number`, `dda_number`, `billing_first_name`, and `billing_last_name`, or<br> (b) `tr_number`, `dda_number`, and `billing_firm_name`."
},
"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 account numbers. <br><strong>Conditional Requirement:</strong> When adding an ACH payment method, the following is required:<br> (a) `tr_number`, `dda_number`, `billing_first_name`, and `billing_last_name`, or<br> (b) `tr_number`, `dda_number`, and `billing_firm_name`."
},
"billing_addr1": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 128 AN<br><strong>Description: </strong>Billing street address. This address will also be used for AVS verification if AVS verification is enabled. "
},
"billing_addr2": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 128 AN<br><strong>Description: </strong>Billing address line 2."
},
"billing_city": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 64 AN<br><strong>Description: </strong>Billing city."
},
"billing_state": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 3 AN<br><strong>Description: </strong>Billing state."
},
"billing_zip": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 10 AN<br><strong>Description: </strong>Billing zip code. This field will also be used for AVS verification if AVS verification is enabled. <br><strong>Conditional Requirement:</strong> When adding a billing card, the following is required: <br> (a) `card_number`, `exp_date`, and `billing_zip`, or<br> (b) `card_id` and `billing_zip`."
},
"billing_zip4": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 4 N<br><strong>Description: </strong>Billing zip+4 code if applicable."
},
"billing_country": {
"type": "string",
"description": "<strong>Format: </strong>Variable length, up to 128 AN<br><strong>Description: </strong>Billing country."
},
"billing_country_code": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 3 AN<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_email": {
"type": "array",
"description": "<strong>Format: </strong>Variable length, up to 128 AN<br><strong>Description: </strong>An array of billing email addresses.",
"items": {
"type": "string"
}
},
"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 where `verify` is set to `true`, the value will be sent to the issuer for validation. This field is not stored in Customer Vault."
},
"merchant_id": {
"type": "integer",
"description": "<strong>Format: </strong>Variable length, up to 16 AN<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.",
"format": "int64"
},
"primary": {
"type": "boolean",
"description": "<strong>Description: </strong>Set this field to `true` if this should be the default card. The default card will be used in recurring billing payments.<br><strong>Default: </strong>false"
},
"type_id": {
"type": "string",
"description": "<strong>Format: </strong>Fixed length, 1 AN<br><strong>Description: </strong>Bank account type. Applicable for ACH account numbers. Possible values: <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><p><strong>Default: </strong>C</p>"
},
"verify": {
"type": "boolean",
"description": "<strong>Description: </strong>Set this field to `true` if `card_number` or `card_id` should be verified by the issuer before adding to Customer Vault. When this field is set to `true`, the customer is added to Customer Vault regardless of whether verification succeeds.<br><strong>Default: </strong>false"
}
}
}
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-billing-card-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.