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 Method | Transaction Flows | Transaction Types |
|---|---|---|
| Creditcard | iFrame Form & payment.js Integration | Debit, Register, Preauthorize, Capture, Void, Refund, Deregister |
| iDeal | Full-Page Redirect | Debit, Refund |
| Bizum | Server-To-Server | Debit, Refund |
Additional Parameters
iDeal Debit
| Field | Required |
|---|---|
| description | true |
| billingCity | false |
| ipAddress | false |
| language (customer.extraData) | false |
Bizum Debit
| Field | Type | Required | Info |
|---|---|---|---|
| customer.extraData.countryCode | string | true | The international country calling code. Checkout.com API field customer.phone.country_code |
| customer.extraData.phoneNumber | string | true | The phone number. Checkout.com API field customer.phone.number |
Payout parameters
Platform 1
| Field | Type | Required |
|---|---|---|
| customer.firstName | string | true |
| customer.lastName | string | true |
On behalf of another person or business:
| Field | Type |
|---|---|
| extraData.senderReference | string |
| extraData.senderAccountNumber | string |
| extraData.senderFirstName | string |
| extraData.senderLastName | string |
| extraData.senderAddressLine1 | string |
| extraData.senderCity | string |
| extraData.senderState | string |
| extraData.senderZip | string |
| extraData.senderCountry | string |
| extraData.senderSourceOfFunds | string |
Platform 2
Destination
| Field | Type | Required | Info |
|---|---|---|---|
| extraData.accountHolderType | string | false | Defaults to individual |
| customer.firstName | string | true | |
| customer.lastName | string | true | |
| customer.billingAddress1 | string | conditional | |
| customer.billingAddress2 | string | false | |
| customer.billingCity | string | conditional | |
| customer.billingState | string | conditional | |
| customer.billingPostcode | string | conditional | |
| customer.billingCountry | string | conditional | |
| extraData.accountHolderCountryCode | string | true | International country calling code |
| customer.billingPhone | string | true | |
| extraData.accountHolderIdType | string | true | account holder identification type: passport driving_license national_id company_registration tax_id |
| customer.nationalId | string | true | account holder identification number |
| extraData.accountHolderIdCountry | string | false | account holder identification issuing country (two-letter ISO country code) |
| extraData.accountHolderIdExpiry | string | false | account holder identification expiry |
| customer.email | string | false | |
| customer.birthDate | string | false | |
| extraData.accountHolderCountryOfBirth | string | false | two-letter ISO country code |
Sender
| Field | Type | Required | Info |
|---|---|---|---|
| extraData.senderType | string | false | Defaults to individual |
| extraData.senderFirstName | string | true | |
| extraData.senderLastName | string | true | |
| extraData.senderAddressLine1 | string | true | |
| extraData.senderAddressLine2 | string | false | |
| extraData.senderCity | string | true | |
| extraData.senderState | string | false | |
| extraData.senderZip | string | false | |
| extraData.senderCountry | string | true | two-letter ISO country code |
| extraData.senderReference | string | true | |
| extraData.senderSourceOfFunds | string | true | May be one of: credit debit prepaid deposit_account mobile_money_account cash |
| extraData.senderIdType | string | conditional | sender identification type |
| extraData.senderIdNumber | string | conditional | sender identification number |
| extraData.senderIdIssuingCountry | string | false | sender identification issuing country |
| extraData.senderIdDateOfExpiry | string | false | sender identification expiry |
| extraData.senderDateOfBirth | string | false | |
| extraData.senderCountryOfBirth | string | false | |
| extraData.senderNationality | string | false |
Misc
| Field | Type | Required | Info |
|---|---|---|---|
| extraData.fundsTransferType | string | false | May be one of AA PP FD FT LO OG C04 C07 C52 C55 |
| extraData.purpose | string | conditional | May 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 |
Account Funding Transfer parameters
| Field | Type | Description |
|---|---|---|
| extraData.recipientAccountReference | string | Recipient's account reference (<=34 characters) |
| extraData.recipientAddress1 | string | Recipient's address1 |
| extraData.recipientAddress2 | string | Recipient's address2 |
| extraData.recipientCity | string | Recipient's city |
| extraData.recipientCountry | string | Recipient's country |
| extraData.recipientState | string | Recipient's state |
| extraData.recipientZip | string | Recipient's zip |
| extraData.recipientFirstName | string | Recipient's first name |
| extraData.recipientLastName | string | Recipient's last name |
| extraData.recipientDateOfBirth | string | Recipient's date of birth |
| extraData.senderDateOfBirth | string | Sender's date of birth |
| customer.billingAddress1 | string | Sender's address 1 |
| customer.billingAddress2 | string | Sender's address 2 |
| customer.billingCity | string | Sender's city |
| customer.billingCountry | string | Sender's country |
| customer.billingState | string | Sender's state |
| customer.billingPostcode | string | Sender's zip |
| customer.firstName | string | Sender's first name |
| customer.lastName | string | Sender's last name |
| customer.identification | string | Sender 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
| Field | Type | Description |
|---|---|---|
| l2l3Data.vatRegistrationNumber | string | The customer's value-added tax (VAT) |
| l2l3Data.taxAmount | float | The total amount of sales tax on the total purchase amount |
| l2l3Data.discountAmount | float | The discount amount applied to the transaction by the merchant |
| l2l3Data.dutyAmount | float | The total charges for any import or export duty included in the transaction |
| l2l3Data.freightAmount | float | The total charges for freight, shipping or handling included in the transaction |
| l2l3Data.freightTaxAmount | float | The total amount of tax for the freight, shipping or handling charges |
| items[].l2l3Data.commodityCode | string | The code identifying a commodity for value-added tax (VAT) purposes |
| items[].l2l3Data.discount | float | The discount applied to each invoice line item |
| items[].l2l3Data.taxAmount | float | The total amount of sales tax or value-added tax (VAT) for the line item |
| items[].l2l3Data.unit | string | The unit of measure code used for the item in the transaction |
| items[].l2l3Data.unitPrice | float | The unit cost of the item purchased |
| items[].name | string | The description of the item purchased |
| items[].quantity | int | The number of units purchased |
| item[].identification | string | The merchant product identifier |
| items[].price | float | The total amount for the line item |
| customer.shippingCountry | string | The 2-letter destination country code |
| customer.shippingPostcode | string | The destination postal or zip code |
| extraData.senderZipCode | string | The origin postal or zip code mapped to from_address_zip |
| extraData.orderId | string | The invoice number mapped to order_id |
Result Extra Data for Credit Card
| Parameter | Value |
|---|---|
| avs_result | Mapped from the field avs_check. For possible values see Checkout.com API reference |
| cvv_result | Mapped from the field cvv_check. For possible values see Checkout.com API reference |