Please try searching something.
Payment Methods
Cards
Description
Virtual Terminal allows you to accept debit and credit card payments on your PC, smartphone or tablet, as long as you have internet access. A virtual payment terminal is an ID assigned to the merchant (MID) which allows you to accept the following card types in your e-commerce store or application:
- Visa, Mastercard, UPI.
Integration Options
- Host2Host
- Direct Post
- Full Page
- Payform JS SDK
Payment Scenarios
- One-Step Payment
- Two-Step Payment
- Zero-Amount Payment
- Recurring
- One-Click
- Full Refund
- Partial Refund
- Reversal
- Payouts: A2A
- Payouts: B2P
- Payouts: P2P
- Payouts: OG
- Payouts: SDWO
Additional Capabilities
- Payment Method Saving
- Use of Travel Data
- Use of Account Funding details
- Use of Dynamic Descriptor
- QCash
- MOTO
- SDWO Funding Payments
- SDWO Purchase Payments
- Automatic Billing Updater
Markets
Afghanistan, Albania, Algeria, American Samoa, Andorra, Angola, Anguilla, Antarctica, Antigua and Barbuda, Argentina, Armenia, Aruba, Australia, Austria, Azerbaijan, Bahamas, Bahrain, Bangladesh, Barbados, Belarus, Belgium, Belize, Benin, Bermuda, Bhutan, Bolivia, Bonaire, Bosnia and Herzegovina, Botswana, Bouvet Island, Brazil, British Indian Ocean Territory, Brunei, Bulgaria, Burkina Faso, Burundi, Cabo Verde, Cambodia, Cameroon, Canada, Cayman Islands, Central African Republic, Chad, Chile, China, Christmas Island, Cocos (Keeling) Islands, Colombia, Comoros, Congo, The Democratic Republic of the Congo, Cook Islands, Costa Rica, Croatia, Cuba, Curaçao, Cyprus, Czech Republic, Côte d'Ivoire, Denmark, Djibouti, Dominica, Dominican Republic, Ecuador, Egypt, El Salvador, Equatorial Guinea, Eritrea, Estonia, Ethiopia, Falkland Islands, Faroe Islands, Fiji, Finland, France, French Guiana, French Polynesia, French Southern Territories, Gabon, Gambia, Georgia, Germany, Ghana, Gibraltar, Greece, Greenland, Grenada, Guadeloupe, Guam, Guatemala, Guernsey, Guinea, Guinea-Bissau, Guyana, Haiti, Heard Island and McDonald Islands, Honduras, Hong Kong, Hungary, Iceland, India, Indonesia, Iran, Iraq, Ireland, Isle of Man, Israel, Italy, Jamaica, Japan, Jersey, Jordan, Kazakhstan, Kenya, Kiribati, North Korea, South Korea, Kuwait, Kyrgyzstan, Laos, Latvia, Lebanon, Lesotho, Liberia, Libya, Liechtenstein, Lithuania, Luxembourg, Macao, Macedonia, Madagascar, Malawi, Malaysia, Maldives, Mali, Malta, Marshall Islands, Martinique, Mauritania, Mauritius, Mayotte, Mexico, Micronesia, Moldova, Monaco, Mongolia, Montenegro, Montserrat, Morocco, Mozambique, Myanmar, Namibia, Nauru, Nepal, Netherlands, New Caledonia, New Zealand, Nicaragua, Niger, Nigeria, Niue, Norfolk Island, Northern Mariana Islands, Norway, Oman, Pakistan, Palau, Palestine, Panama, Papua New Guinea, Paraguay, Peru, Philippines, Pitcairn, Poland, Portugal, Puerto Rico, Qatar, Romania, Russian Federation, Rwanda, Réunion, Saint Barthélemy, Saint Helena, Saint Kitts and Nevis, Saint Lucia, Saint Martin (French part), Saint Pierre and Miquelon, Saint Vincent and the Grenadines, Samoa, San Marino, Sao Tome and Principe, Saudi Arabia, Senegal, Serbia, Seychelles, Sierra Leone, Singapore, Sint Maarten (Dutch part), Slovakia, Slovenia, Solomon Islands, Somalia, South Africa, South Georgia and the South Sandwich Islands, South Sudan, Spain, Sri Lanka, Sudan, Suriname, Svalbard and Jan Mayen, Swaziland, Sweden, Switzerland, Syria, Taiwan, Tajikistan, Tanzania, Thailand, Timor-Leste, Togo, Tokelau, Tonga, Trinidad and Tobago, Tunisia, Turkey, Turkmenistan, Turks and Caicos Islands, Tuvalu, Uganda, Ukraine, United Arab Emirates, United Kingdom, United States, United States Minor Outlying Islands, Uruguay, Uzbekistan, Vanuatu, Vatican, Venezuela, Vietnam, British Virgin Islands, U.S. Virgin Islands, Wallis and Futuna, Western Sahara, Yemen, Zambia, Zimbabwe, Åland Islands.
Currencies
USD, GBP, EUR, RUB, AUD, SEK, CAD, CHF, DKK, JPY, PLN, CZK, NOK, AED, BYN, CNY, KZT, NZD, UAH, AZN, GEL, KGS, UZS, ZAR, AMD, ARS, BGN, BRL, CLP, EGP, HKD, HRK, HUF, IDR, ILS, INR, ISK, KES, KRW, LKR, MAD, MDL, MKD, MOP, MUR, MXN, MYR, NGN, PEN, PHP, QAR, RON, RSD, SAR, SGD, THB, TJS, TMT, TRY, TWD, UYU, VND, ZWL.
Transaction Limits
Transaction limits differ for each currency and market. If you want to find out more about a particular market or currency, contact your Cardaq account manager.
How to Enable Card Payments
Sign up here to create your Cardaq account. No additional steps are required to enable card payments.
Payment Flow
Payment flow examples can be found here:
Recurring Payment Scenarios
Additionl Capabilities
Payout Flow
Apple Pay
Description
We support Host2Host, Full Page, and Payform JS SDK integrations for Apple Pay. If you are using Host2Host, then you as a merchant are responsible for the interactions with the Apple Pay API. Once you have completed those interactions, we will consume the payment data. With Host2Host integration, you are in complete charge of how to integrate Apple Pay into your website or app; therefore, we do not control, nor provide assistance for it. You can find the design guidelines and the information about Apple Pay button usage in the Apple Pay Human Interface Guidelines The information about server requirements for Apple Pay on the web can be found in the Apple Developer Portal.
Please note that your customers will be able to choose Apple Pay as a payment method option only when they:
- Are located in a region where Apple Pay is supported (see the full list here);
- Have an existing card added to their Apple Pay wallet;
- Use Safari browser when paying on the website;
- Use an Apple Pay compatible device.
There are two options for handling Apple Pay payments with Cardaq:
- Cardaq handles the decryption:
- Provide the encrypted Apple Pay payload to Cardaq;
- Cardaq will decrypt and process the payment.
- Handle the decryption yourself (only allowed for PCI-compliant merchants):
- Decrypt the Apple Pay payload yourself;
- Send the decrypted data to Cardaq for processing.
Before you start enabling this payment method, make sure that your Cardaq account manager has given you Apple Pay permission.
Integration Options
- Host2Host
- Full Page
- Payform JS SDK
Payment Scenarios
- One-Step Payment
- Two-Step Payment
- Full Refund
- Partial Refund
- Reversal
- Recurring
Additional Capabilities
- Payment Method Saving
- Use of Travel Data
- Use of Account Funding details
- Automatic Billing Updater
Markets
South Africa, Australia, China (mainland), Hong Kong, Japan, Macao, New Zealand, Singapore, Taiwan, Armenia, Austria, Azerbaijan, Belarus, Belgium, Bulgaria, Croatia, Cyprus, Czech Republic, Denmark, Estonia, Faroe Islands, Finland, France, Georgia, Germany, Greece, Greenland, Guernsey, Hungary, Iceland, Ireland, Isle of Man, Italy, Kazakhstan, Jersey, Latvia, Liechtenstein, Lithuania, Luxembourg, Malta, Monaco, Montenegro, Netherlands, Norway, Poland, Portugal, Romania, Russian Federation, San Marino, Serbia, Slovakia, Slovenia, Spain, Sweden, Switzerland, Ukraine, United Kingdom, Vatican, Argentina, Colombia, Costa Rica, Brazil, Mexico, Peru, Bahrain, Israel, Palestine, Qatar, Saudi Arabia, United Arab Emirates, Canada, United States.
Currencies
USD, GBP, EUR, RUB, AUD, SEK, CAD, CHF, DKK, JPY, PLN, CZK, NOK, AED, BYN, CNY, KZT, NZD, UAH, AZN, GEL, KGS, UZS, ZAR, AMD, ARS, BGN, BRL, CLP, EGP, HKD, HRK, HUF, IDR, ILS, INR, ISK, KES, KRW, LKR, MAD, MDL, MKD, MOP, MUR, MXN, MYR, NGN, PEN, PHP, QAR, RON, RSD, SAR, SGD, THB, TJS, TMT, TRY, TWD, UYU, VND, ZWL.
Transaction Limits
Transaction limits differ for each currency and market. If you want to find out more about a particular market or currency, contact your Cardaq account manager.
How to Enable Apple Pay
Full Page
- Go to your Cardaq Gate account;
- Navigate to Settings, then select the Payment Methods section, and click the "Configure" button for Apple Pay;
- Select the option “Use the Gateway’s Apple Developer certificate”;
- Click the "Enable" button from the action column;
- Verify that the status has changed to Enabled. Once confirmed, you will be authorized to process Apple Pay transactions.
Payform JS SDK
- Go to your Cardaq Gate account, select Settings, then the Payment Methods section and click the "Configure" button for Apple Pay;
- Choose “Use the Gateway’s Apple Developer certificate“;
- Click to “Add a domain“ button;
- Enter your domain;
- Download the domain verification file;
- Add the downloaded file to your domain to the path:
/.well-known/apple-developer-merchantid-domain-association; - Click the "Enable" button from the action column;
- Make sure that the status is changed to Enabled. If it is, you are now able to perform Apple Pay transactions.
Host2Host
- Log in to your Apple Developer account and follow the instructions to create a merchant identifier and merchant identity certificate (assigned to the identifier);
- Go to your Cardaq Gate account, select Settings, then the Payment Methods section and click on the "Configure" button for Apple Pay;
- Click on the “Add new certificate", select the appropriate website, enter the domain name, and then click "Add";
- After adding a new certificate, it will appear in the Apple Pay Certificates section with status pending. In order to activate it, click on the Actions menu and choose to upload a certificate. A new view will be presented where you download the CSR file. Then, go to your Apple Developer account and follow these instructions to create a payment processing certificate.
NB: Make sure you use the same merchant identifier as in the previous steps. When you are asked to upload a Certificate Signing Request, select the CSR you just downloaded from the Merchant Portal. Then, download and save the generated payment processing certificate as a .cer file. Now you can upload the certificate you received from Apple in the Merchant Portal. Once that is done, click “Add”; - You will now see the certificate attached to your application. The status - pending or active - indicates whether the certificate is active. If it is, you are now able to perform Apple Pay transactions with Cardaq;
This step is required only if you are integrating Apple Pay with your app. Ignore this step, if you intend to integrate Apple Pay with your website only.
In order to enable Apple Pay for an app, log in to your Apple Developer account and follow these instructions.
Payment Flow
Common Order Request Example
Once you have successfully enabled Apple Pay for your account, you can start to initiate payments. You as a merchant create the initial order. Example:
{
"client": {
"email": "adam.smith@company.com"
},
"products": [
{
"price": 0.30,
"title": "My Product"
}
]
}
Full Page
If you are using the Cardaq hosted payment page, no technical changes are required from your side. After you redirect your customer to the appropriate URL and their device is compatible, they will be able to choose whether to pay by card or by Apple Pay. All communication with Apple Pay during the payment process is handled by Cardaq.
Payform JS SDK
If you are using the Cardaq Payform JS SDK, no technical changes are required from your side. Customers will be able to choose on the payform whether to pay by card or by Apple Pay. All communication with Apple Pay during the payment process is handled by Cardaq.
Host2Host
Once you have successfully implemented Apple Pay on your website or app, Cardaq Gate can now start consuming the payment data:
Whenever your customer finishes authorizing the Apple Pay payment, you will receive the Apple Pay payment result that contains Apple Pay payment token. To let Cardaq handle token decryption, Apple Pay token can be provided as the request body to Cardaq Gate Apple Pay api_do_applepay endpoint. This endpoint is used for completing the Apple Pay transaction. It accepts data from the payment token and then processes the payment. More information on the payment token and its format can be found here.
Send the Apple Pay token you got from the Apple Pay Pay API and provide it in your request to Cardaq Gate Apple Pay api_do_applepay endpoint. Example:
{ "data": "...", "version": "...", "signature": "...", "ephemeralPublicKey": "...", "publicKeyHash": "...", "transactionId": "...", "applicationData": "...", "ip_address": "127.0.0.1" }After successfully proceeded payment, the payment status is updated for the merchant by Cardaq and the appropriate webhook about the status is sent out.
Once you have successfully implemented Apple Pay on your website or app, Cardaq Gate can now start consuming the payment data:
Whenever your customer finishes authorizing the Apple Pay payment, you will receive the Apple Pay payment result that contains Apple Pay payment token. Now you decrypt the Apple Pay token yourself. More information on the payment token and its format can be found here.
Provide the data from decrypted payload in your request to Cardaq Gate api_do_url endpoint. Example:
{ "card_number": "...", "exp_month": "...", "exp_year": "...", "eci": "...", //optional "cavv": "...", "wallet": "applepay", "merchant_url": "..." }After successfully proceeded payment, the payment status is updated for the merchant by Cardaq and the appropriate webhook about the status is sent out.
Google Pay™
Description
We support Host2Host, Full Page, and Payform JS SDK integrations for Google Pay. If you are using Host2Host, then you as a merchant are responsible for the interactions with the Google Pay API. Once you have completed those interactions, we will consume the payment data. Follow the Google Pay guidelines to integrate your web or Android application:
- Web: Google Pay Web developer documentation, Google Pay Web integration checklist, and Google Pay Web brand guidelines;
- Android: Google Pay Android developer documentation, Google Pay Android integration checklist, and Google Pay Android brand guidelines.
Google Pay offers and we support two authentication modes:
PAN_ONLY- the card is stored on file within your customer's Google account and not bound to an Android device. 3DS/Authentication is handled automatically by the Cardaq Gate;CRYPTOGRAM_3DS- The card is stored in the Google Pay wallet on an Android device. Transactions include a cryptogram generated by the device, which adds an extra layer of security. These payments are often considered authenticated by issuers but liability shift is not guaranteed and depends on the issuer and card scheme rules.
Supported networks:
We support VISA and Mastercard card networks with the Google Pay API. You can define these values in the allowedCardNetworks property and find the appropriate values in Google Pay Web developer documentation and Google Pay Android developer documentation.
There are two options for handling Google Pay payments with Cardaq:
- Cardaq handles the decryption:
- Provide the encrypted Google Pay payload to Cardaq;
- Cardaq will decrypt and process the payment.
- Handle the decryption yourself (only allowed for PCI-compliant merchants):
- Decrypt the Google Pay payload yourself;
- Send the decrypted data to Cardaq for processing.
Before you start enabling this payment method, make sure that your Cardaq account manager has given you Google Pay permission.
Integration Options
- Host2Host
- Full Page
- Payform JS SDK
Payment Scenarios
- One-Step Payment
- Two-Step Payment
- Full Refund
- Partial Refund
- Reversal
- Recurring
Additional Capabilities
- Payment Method Saving
- Use of Travel Data
- Use of Account Funding details
- Automatic Billing Updater
Markets
Afghanistan, Albania, Algeria, Andorra, Angola, Antigua and Barbuda, Argentina, Armenia, Australia, Austria, Azerbaijan, Bahamas, Bahrain, Bangladesh, Barbados, Belarus, Belgium, Belize, Benin, Bhutan, Bolivia, Bosnia and Herzegovina, Botswana, Brazil, Brunei, Bulgaria, Burkina Faso, Burundi, Cambodia, Cameroon, Canada, Cape Verde, Central African Republic, Chad, Chile, Colombia, Comoros, Costa Rica, Côte d'Ivoire, Croatia, Cyprus, Czech Republic, Democratic Republic of the Congo, Denmark, Djibouti, Dominica, Dominican Republic, Ecuador, Egypt, El Salvador, Equatorial Guinea, Eritrea, Estonia, Eswatini, Ethiopia, Fiji, Finland, France, Gabon, Gambia, Georgia, Germany, Ghana, Greece, Grenada, Guatemala, Guinea, Guinea-Bissau, Guyana, Haiti, Holy See, Honduras, Hong Kong, Hungary, Iceland, India, Iraq, Ireland, Israel, Italy, Jamaica, Japan, Jordan, Kazakhstan, Kenya, Kiribati, Kuwait, Kyrgyzstan, Laos, Latvia, Lebanon, Lesotho, Liberia, Libya, Liechtenstein, Lithuania, Luxembourg, Macau, Madagascar, Malawi, Malaysia, Maldives, Mali, Malta, Marshall Islands, Mauritania, Mauritius, Mexico, Micronesia, Moldova, Monaco, Mongolia, Montenegro, Morocco, Mozambique, Myanmar, Namibia, Nauru, Nepal, Netherlands, New Zealand, Nicaragua, Niger, Nigeria, North Macedonia, Norway, Oman, Pakistan, Palau, Palestine, Panama, Papua New Guinea, Paraguay, Peru, Poland, Portugal, Qatar, Republic of the Congo, Romania, Rwanda, Saint Kitts and Nevis, Saint Lucia, Saint Vincent and the Grenadines, Samoa, San Marino, Sao Tome and Principe, Saudi Arabia, Senegal, Sierra Leone, Serbia, Seychelles, Singapore, Slovakia, Slovenia, Solomon Islands, Somalia, South Africa, South Sudan, Spain, Sri Lanka, Sudan, Suriname, Sweden, Switzerland, Taiwan, Tajikistan, Tanzania, Thailand, Timor-Leste, Togo, Tonga, Trinidad and Tobago, Tunisia, Turkey, Turkmenistan, Tuvalu, Uganda, Ukraine, United Arab Emirates, United Kingdom and outlying territories, United States and outlying territories, Uruguay, Uzbekistan, Vanuatu, Venezuela, Vietnam, Yemen, Zambia, Zimbabwe
Currencies
USD, GBP, EUR, RUB, AUD, SEK, CAD, CHF, DKK, JPY, PLN, CZK, NOK, AED, BYN, CNY, KZT, NZD, UAH, AZN, GEL, KGS, UZS, ZAR, AMD, ARS, BGN, BRL, CLP, EGP, HKD, HRK, HUF, IDR, ILS, INR, ISK, KES, KRW, LKR, MAD, MDL, MKD, MOP, MUR, MXN, MYR, NGN, PEN, PHP, QAR, RON, RSD, SAR, SGD, THB, TJS, TMT, TRY, TWD, UYU, VND, ZWL
Transaction Limits
Transaction limits differ for each currency and market. If you want to find out more about a particular market or currency, contact your Cardaq account manager.
How to Enable Google Pay
Contact your Cardaq account manager to enable this payment method.
Payment Flow
Common Order Request Example
Once you have successfully enabled Google Pay for your account, you can start to initiate payments. You as a merchant create the initial order. Example:
{
"client": {
"email": "adam.smith@company.com"
},
"products": [
{
"price": 0.30,
"title": "My Product"
}
]
}
Full Page
If you are using the Cardaq hosted payment page, no technical changes are required from your side. After you redirect your customer to the appropriate URL and their device is compatible, they will be able to select whether to pay by card or by Google Pay. All communication with Google Pay during the payment process is going to be handled by Cardaq.
Payform JS SDK
If you are using the Cardaq Payform JS SDK, no technical changes are required from your side. Customers will be able to select on the payform whether to pay by card or by Google Pay. All communication with Google Pay during the payment process is going to be handled by Cardaq.
Host2Host
Once you have set up Google Pay for your account, you can start to accept Google Pay payments.
NB: When you submit a payment data request to the Google API, be sure to include the following parameters:
- 'gateway': 'cardaq'
- gatewayMerchantId': '<your merchant website ID>'
Submit a payment data request to the Google API. Example:
{ "type": "CARD", "parameters": { "allowedAuthMethods": ["PAN_ONLY", "CRYPTOGRAM_3DS"], "allowedCardNetworks": ["MASTERCARD", "VISA"] }, "tokenizationSpecification": { "type": "PAYMENT_GATEWAY", "parameters": { "gateway": "<gateway_name>", "gatewayMerchantId": "<YOUR_MERCHANT_WEBSITE_ID>" } } }If your gateway account is set up to process card authorisation requests with AVS checks, you can request BillingAddressParameters in your Google Pay API request (it is advised to request the FULL version of the billing address). If you do not request a billing address through Google Pay, you still have the option to use the address you have on file.
Use the
api_do_googlepayendpoint (returned during the Initial Order creation) to process the payment. Send the full PaymentData object received from Google Pay to this endpoint to allow Cardaq to handle the decryption and following steps. Example:{ "signature": "...", "intermediateSigningKey": { "signedKey": "...", "signatures": [...] }, "protocolVersion": "...", "signedMessage": "...", "ip_address": "127.0.0.1" }Response example in case of
CRYPTOGRAM_3DS:{ "processing_status": "000" }Response example in case of
PAN_ONLY:{ "threed_check_url":"<https://transactions.decta.com/p/a03b5962-1218-4dfd-b78c-1b5ec686ef22/EbbM%252FxU4j8YMDnjAD9qKYTT7%252BcZizmxD51yPZPZj09jTRvePwybnCoOz3Exj%252B%252Bfo8iKX8nP0FdsS1LNBrrXusl%252BPr3rviH38CtLalnRpU38kRRiIU0Qq8TBMQLsXAPreZ8o%252BKYN/3d/>" }Analyze the response:
- In case you receive a
processing_status, wait for a webhook about the final status from the Cardaq Gate; - In case you receive a
threed_check_url, redirect the shopper to this link to complete the 3D Secure authentication and wait for a webhook about the final status from the Cardaq Gate.
- In case you receive a
Once you have set up Google Pay for your account, you can start to accept Google Pay payments.
Make a request to process the Google Pay payment. After you have created the initial request as shown above in the Common Order Request example, as a response from Cardaq you have received a parameter called
api_do_urlto send decrypted payload data. Send the data from the decrypted payload in your request to Cardaq Gate api_do_url endpoint.Example, if decrypted payload is
CRYPTOGRAM_3DS:{ "card_number": "...", "exp_month": "...", "exp_year": "...", "eci": "...", // optional "cavv": "...", "wallet": "googlepay" }Example, if decrypted payload is
PAN_ONLY:{ "card_number": "...", "exp_month": "...", "exp_year": "...", "wallet": "googlepay" }Note that in case when the decrypted payload is
PAN_ONLY, all of the 3DS authentication options (i.e. Automatic, Partly Automatic, Third Party MPI, and Manual 3DS Handling) are supported.Response example in case of
CRYPTOGRAM_3DS:{ "processing_status": "000" }If the decrypted message contains
PAN_ONLY, the response depends on the 3DS Authentication option (i.e. there response may be either an URL tothreed_check_url, an immediate result withprocessing_status, or an URL to perform the manual 3DS).Analyze the response:
- In case you receive a
processing_status, wait for a webhook about the final status from the Cardaq Gate; - In case you receive a
threed_check_url, redirect the shopper to this link to complete the 3D Secure authentication and wait for a webhook about the final status from the Cardaq Gate.
- In case you receive a
Visa Instalments
Description
Visa Installments allow eligible cardholders the flexibility to pay for a purchase in equal payments over a defined period. You can learn more about Visa Instalments.
Before you start enabling this payment method, make sure that your Cardaq account manager has given you Visa Instalments permission.
Integration Options
- Host2Host
- Full Page
- Payform JS SDK
Payment Scenarious
- One-Step Payment
- Two-Step Payment
- Full Refund
- Partial Refund
- Reversal
Additional Capabilities
- Use of Travel Data
- Use of Dynamic Descriptor
- Use of Service Location details
- Address Verification System
Customer Markets
United Kingdom
Currencies
GBP
Transaction Limits
| GBP | |
|---|---|
| Minimum amount per transaction | £ 50 |
| Maximum amount per transaction | Contact your account manager regarding the maximum limit |
How to Enable Visa Instalments
Contact your Cardaq account manager to enable this payment method.
Payment Flow
Common Order Request Example
Once you have successfully enabled Visa Instalments for your account, you can start to accept Visa Instalment payments. You as a merchant create the initial order. Example:
{
//required
"client":{
"email": "adam.smith@company.com"
},
"products": [
{
"quantity": "1",
"price": "50",
"title": "My Product"
}
],
}
Full Page
If you are using the Cardaq hosted payment page, no technical changes are required from your side. After you redirect your customer to the appropriate URL, they will see if their card is eligable for instalments. If it is, then the customer can select either to pay all amount in full or choose a plan and pay in instalments. Payment processing is the same as for regular orders.
Payform JS SDK
If you are using the Cardaq Payform JS SDK, no technical changes are required from your side. Once you customer has submitted their card data, they will see if their card is eligable for instalments. If it is, then the customer can select either to pay all amount in full or choose a plan and pay in instalments. Payment processing is the same as for regular orders.
Host2Host
- Check if the card is eligible for Visa Instalments and request Instalment plans by sending Visa card number in the request to Cardaq Gate
instalment_plansendpoint.
Request example:
{
"card_number": "411111******1111"
}
Response example if the plans are available:
{
"instalment_request_id": 12,
"instalment_plans": [
{
"id": "string",
"frequency": "string",
"number_of_instalments": 3,
"terms_conditions": [
{
"url": "string",
"version": 4,
"text": "string",
"language": "string"
}
],
"annual_percentage_rate": 3.0,
"total_amount": 353.5,
"total_fee": 3.51,
"amount": 117.83,
"fee": 1.17
}
]
}
Response example if the plans are not avaible:
{
"instalment_request_id": "12345",
"instalment_plans": []
}
- If the plans are available and the cardholder has selected the desired plan, certain fields from the
instalment_plansresponse should be sent inapi_do_urlrequest.
Request example:
{
"cardholder_name": "GATETEST123",
"card_number": "411111******1111",
"exp_month": "05",
"exp_year": "24",
"csc": "***",
"instalment_plan":{
"instalment_request_id": 123, //taken from /instalment_plans response - mandatory for Instalment plans
"id": "...", //taken from /instalment_plans response - mandatory for Instalment plans
"version": 4, //taken from /instalment_plans response - mandatory for Instalment plans
"language": "eng" //taken from /instalment_plans response - mandatory for Instalment plans
}
}
- As a response you will receive either a payment status or a link to the 3DS check.