API Reference
Login to SandboxCreate Account

Verify

post
https://api-test.qualpay.com/pg/verify

A Verify request returns success if the cardholder information was verified by the issuer. If AVS or CVV data is included in the message, the AVS or CVV result code will appear in the response. This is useful when you want to determine a card’s validity but are not ready to authorize the card.

Note: Vendor accounts need special permissions to use this operation; contact Qualpay Support to enable it.

Body Params

Payment Gateway Card Verify Request

int64
required

Format: Variable length, up to 12 N
Description: Unique identifier in our system.

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.
Conditional Requirement: Refer to Card or Bank Account Data Sources and Conditional Requirements

string

Format: Variable length, up to 19 N
Description: Cardholder's card number.
Conditional Requirement: Refer to Card or Bank Account Data Sources and Conditional Requirements

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 track 2 data in a single read, it is the responsibility of the implementer to send data for only one of the two tracks.
Conditional Requirement: Refer to Card or Bank Account Data Sources and Conditional Requirements

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 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.
Conditional Requirement: Refer to Card or Bank Account Data Sources and Conditional Requirements

string

Format: Fixed length, 9 N
Description: Bank transit/routing number. Applicable for ACH payments.
Conditional Requirement: Refer to Card or Bank Account Data Sources and Conditional Requirements

string

Format: Variable length, up to 17 N
Description: Owner's account number at the bank. Applicable for ACH payments.
Conditional Requirement: Refer to Card or Bank Account Data Sources and Conditional Requirements

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 issuing bank.

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.
Conditional Requirement: This field is required if avs_address is present.

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 and expiration date.

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:

  • tokenize (set to true),
  • either card_number or card_swipe,
  • customer_id, and
  • customer.

Cannot be used to update an existing customer_id.

string

Format: Variable length, up to 17 AN
Description: Reference code supplied by the cardholder to the merchant.

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 requires authorization, the value will be sent to the issuer for validation.

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 us. Suggested usage is softwareABCv1.0 or companyXYZv2.0.

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 of strings

Format:Variable length, AN
Description: An array of account holder email addresses.

email_address
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 this request.

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 data reported in Merchant Manager. This value will also be attached to any lifecycle transactions (e.g. retrieval requests and chargebacks) that may occur.

string

Format: Fixed length, 1 N
Default: 7
Description: Indicates the type of MOTO transaction. Possible values:

  • 0 - Card present (not MOTO/e-commerce)
  • 1 - One-time MOTO transaction
  • 2 - Recurring
  • 3 - Installment
  • 7 - E-commerce channel encrypted (SSL)

Conditional Requirement: Recurring transactions require moto_ecomm_ind set to 2.

string

Format: Variable length
Description: Apple Pay payload.

string

Format: Variable length
Description: Google Pay payload.

string

Format: Fixed length, 20 N
Description: Explicitly identifies which Payment Gateway profile should be used for the request.

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.

string

INTERNAL USE ONLY.

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 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.
Conditional Requirement: Refer to Card or Bank Account Data Sources and Conditional Requirements

string

Format: Fixed length, 1 AN
Default: C
Description: Bank Account Type. Applicable for ACH payments. Possible values are:

  • C = Personal checking account
  • S = Personal savings account
  • K = Business checking account
  • V = Business savings account

int64

INTERNAL USE ONLY.

int64

Format: Fixed length, 10 N
Description: Identifies the vendor to which this request applies.
Conditional Requirement: This field is required for Qualpay partner accounts.

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 in 10 minutes or when first used.

Responses

Updated 6 months ago

Language
Credentials
Basic
base64
:
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago