Skip to navigation
Adapters

CheckoutCom

This page provides an overview of the payments methods provided by the CheckoutCom adapter in the IXOPAY platform. It also includes a full list of all configuration options available to you when integrating CheckoutCom within your payments landscape, as well as an overview of the parameters required when submitting a transaction via IXOPAY’s API.

Payment Methods

Payment MethodTransaction FlowsTransaction Types
CreditcardiFrame Form & payment.js IntegrationDebit, Register, Preauthorize, Capture, Void, Refund, Deregister
iDealFull-Page RedirectDebit, Refund
BizumServer-To-ServerDebit, Refund

iDeal

Additional Parameters

Debit

FieldRequired
descriptiontrue
billingCityfalse
ipAddressfalse
language (customer.extraData)false

Bizum

Additional Parameters

Debit

FieldTypeRequiredInfo
customer.extraData.countryCodestringtrueThe international country calling code. Checkout.com API field customer.phone.country_code
customer.extraData.phoneNumberstringtrueThe phone number. Checkout.com API field customer.phone.number

Credit card

Platform 1 - Payout Parameters

FieldTypeRequired
customer.firstNamestringtrue
customer.lastNamestringtrue

On behalf of another person or business:

FieldType
extraData.senderReferencestring
extraData.senderAccountNumberstring
extraData.senderFirstNamestring
extraData.senderLastNamestring
extraData.senderAddressLine1string
extraData.senderCitystring
extraData.senderStatestring
extraData.senderZipstring
extraData.senderCountrystring
extraData.senderSourceOfFundsstring

Platform 2 - Payout Parameters

Destination

FieldTypeRequiredInfo
extraData.accountHolderTypestringfalseDefaults to individual
customer.firstNamestringtrue
customer.lastNamestringtrue
customer.billingAddress1stringconditional
customer.billingAddress2stringfalse
customer.billingCitystringconditional
customer.billingStatestringconditional
customer.billingPostcodestringconditional
customer.billingCountrystringconditional
extraData.accountHolderCountryCodestringtrueInternational country calling code
customer.billingPhonestringtrue
extraData.accountHolderIdTypestringtrueaccount holder identification type: passport driving_license national_id company_registration tax_id
customer.nationalIdstringtrueaccount holder identification number
extraData.accountHolderIdCountrystringfalseaccount holder identification issuing country (two-letter ISO country code)
extraData.accountHolderIdExpirystringfalseaccount holder identification expiry
customer.emailstringfalse
customer.birthDatestringfalse
extraData.accountHolderCountryOfBirthstringfalsetwo-letter ISO country code

Sender

FieldTypeRequiredInfo
extraData.senderTypestringfalseDefaults to individual
extraData.senderFirstNamestringtrue
extraData.senderLastNamestringtrue
extraData.senderAddressLine1stringtrue
extraData.senderAddressLine2stringfalse
extraData.senderCitystringtrue
extraData.senderStatestringfalse
extraData.senderZipstringfalse
extraData.senderCountrystringtruetwo-letter ISO country code
extraData.senderReferencestringtrue
extraData.senderSourceOfFundsstringtrueMay be one of: credit debit prepaid deposit_account mobile_money_account cash
extraData.senderIdTypestringconditionalsender identification type
extraData.senderIdNumberstringconditionalsender identification number
extraData.senderIdIssuingCountrystringfalsesender identification issuing country
extraData.senderIdDateOfExpirystringfalsesender identification expiry
extraData.senderDateOfBirthstringfalse
extraData.senderCountryOfBirthstringfalse
extraData.senderNationalitystringfalse

Misc

FieldTypeRequiredInfo
extraData.fundsTransferTypestringfalseMay be one of AA PP FD FT LO OG C04 C07 C52 C55
extraData.purposestringconditionalMay be one of family_support expatriation travel_and_tourism education medical_treatment emergency_need leisure savings gifts donations financial_services it_services investment insurance loan_payment pension royalties other income
extraData.digitalGoods:typestringconditionalMay be one of cryptocurrency cbdc stablecoin blockchain NFT

Account Funding Transfer Parameters

FieldTypeDescription
extraData.recipientAccountReferencestringRecipient’s account reference (<=34 characters)
extraData.recipientAddress1stringRecipient’s address1
extraData.recipientAddress2stringRecipient’s address2
extraData.recipientCitystringRecipient’s city
extraData.recipientCountrystringRecipient’s country
extraData.recipientStatestringRecipient’s state
extraData.recipientZipstringRecipient’s zip
extraData.recipientFirstNamestringRecipient’s first name
extraData.recipientLastNamestringRecipient’s last name
extraData.recipientDateOfBirthstringRecipient’s date of birth
extraData.senderDateOfBirthstringSender’s date of birth
customer.billingAddress1stringSender’s address 1
customer.billingAddress2stringSender’s address 2
customer.billingCitystringSender’s city
customer.billingCountrystringSender’s country
customer.billingStatestringSender’s state
customer.billingPostcodestringSender’s zip
customer.firstNamestringSender’s first name
customer.lastNamestringSender’s last name
customer.identificationstringSender reference

Level 2 & 3 Data

Supported on Platform 2 only

maximum of 50 item objects are allowed to be sent in a Level 3 Visa or Mastercard request American Express only supports Level 2 data maximum of 4 item objects are allowed to be sent in an American Express request

FieldTypeDescription
l2l3Data.vatRegistrationNumberstringThe customer’s value-added tax (VAT)
l2l3Data.taxAmountfloatThe total amount of sales tax on the total purchase amount
l2l3Data.discountAmountfloatThe discount amount applied to the transaction by the merchant
l2l3Data.dutyAmountfloatThe total charges for any import or export duty included in the transaction
l2l3Data.freightAmountfloatThe total charges for freight, shipping or handling included in the transaction
l2l3Data.freightTaxAmountfloatThe total amount of tax for the freight, shipping or handling charges
items[].l2l3Data.commodityCodestringThe code identifying a commodity for value-added tax (VAT) purposes
items[].l2l3Data.discountfloatThe discount applied to each invoice line item
items[].l2l3Data.taxAmountfloatThe total amount of sales tax or value-added tax (VAT) for the line item
items[].l2l3Data.unitstringThe unit of measure code used for the item in the transaction
items[].l2l3Data.unitPricefloatThe unit cost of the item purchased
items[].namestringThe description of the item purchased
items[].quantityintThe number of units purchased
item[].identificationstringThe merchant product identifier
items[].pricefloatThe total amount for the line item
customer.shippingCountrystringThe 2-letter destination country code
customer.shippingPostcodestringThe destination postal or zip code
extraData.senderZipCodestringThe origin postal or zip code mapped to from_address_zip
extraData.orderIdstringThe invoice number mapped to order_id

Ramp provider affiliate Parameters

FieldTypeDescription
extraData.affiliateIdstringYour unique identifier for the affiliate (<= 15 characters)
extraData.affiliateUrlstringAffiliate Url
extraData.purchaseCountrystringRequired to inform Visa of the affiliate’s country (either the same as, or different to the merchant’s country)

Risk / Device Session Parameters

Forwards the device fingerprint collected by the Checkout.com Risk SDK to the payment request. Only sent when the parameter is present.

FieldTypeRequiredDescription
extraData.device_session_idstringfalseDevice session id generated by the Checkout.com Risk SDK, mapped to the Checkout.com API field risk.device_session_id. Used for Debit, Preauthorize and Register transactions.

Account Name Inquiry (ANI)

Enable the accountNameInquiryEnabled connector setting to have Checkout.com verify the cardholder name during a card verification (Register) transaction.

Result Extra Data

ParameterValue
avs_resultMapped from the field avs_check. For possible values see Checkout.com API reference
cvv_resultMapped from the field cvv_check. For possible values see Checkout.com API reference
account_name_inquiryMapped from the field account_holder.account_name_inquiry. Only returned for Register (card verification) transactions when Account Name Inquiry is enabled on the connector. For possible values see Checkout.com ANI codes.

Merchant Advice Code Mapping

The merchant advice code is retrieved in following order from:

  • processing.partner_merchant_advice_code
  • processing.recommendation_code
  • recommendation_code

The merchant advice code is only parsed for processing.partner_merchant_advice_code:

CheckoutCom Merchant Advice CodeCheckoutCom DescriptionParsed Code returnData.parsedMerchantAdviceCodeParsed Code Description
01New Account Information available01Additional information needed.
04Token requirements not fulfilled for this token type01Additional information needed.
02Try again later02Try again later.
24Retry after 1 hour02Try again later.
25Retry after 24 hours02Try again later.
26Retry after 2 days02Try again later.
27Retry after 4 days02Try again later.
28Retry after 6 days02Try again later.
29Retry after 8 days02Try again later.
30Retry after 10 days02Try again later.
31Retry later (max 15 attempts in 30 day period)02Try again later.
03Do not try again03Do not try again.
21Recurring Payment Cancellation Service (the new fee applies with this one)03Do not try again.
22Merchant does not qualify for product code03Do not try again.