Cybersource PCI
This page provides an overview of the payments methods provided by the Cybersource PCI adapter in the IXOPAY platform. It also includes a full list of all configuration options available to you when integrating Cybersource PCI 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 | Payment Form & payment.js Integration | Register, Deregister, Debit, Pre-authorise, Capture, Void, Refund |
Adapter Config
The following fields are required depending on the used features:
| Parameter | Allowed values | Description |
|---|---|---|
| MerchantID | required | |
| APIKey | required | |
| sharedSecret | required | |
| Use Decision Manager | required if Cybersource Decision Manager is used. | |
| Enable Incremental Authorization | required if Incremental Authorizations are used (check with Cybersource if it's available for you) |
General Transaction extraData
The following extraData fields are required or optional for ALL transactions:
| Parameter | Allowed values | Description |
|---|---|---|
| extraData.purchaseLevel | 3 | required if LEVEL III Data is sent |
| extraData.purchaseOrderNumber | additional LEVEL III Data value | |
| extraData.reconciliationID | ReconciliationId |
Capture Transactions
The following extraData fields are required for capture transactions:
| Parameter | Allowed values | Description |
|---|---|---|
| extraData.captureSequenceNumber | The Capture sequence number for multiple partial captures. | |
| extraData.totalCaptureCount | The total amount of Captures that will be done. |
Recurring Transactions
The following extraData fields are required for recurring transactions:
| Parameter | Allowed values | Description |
|---|---|---|
| extraData.recurringEndDate | required - YYYY-MM-DD | |
| extraData.recurringFrequency | required 28 days * Month - 6 month = 168 | |
| extraData.recurringNumberOfPayments | optional | |
| extraData.recurringOriginalPurchaseDate | YYYY-MM-DDTHH:MM:SSZ - empty = currentDate | |
| extraData.recurringSequenceNumber | This field is mandatory for Cartes Bancaires recurring transactions on Credit Mutuel-CIC - (1st, 2, 3, ..) | |
| extraData.recurringType | (1,2,3,4) => (Registration/First transaction, Subsequent transaction, Modification, Cancellation) | |
| extraData.recurringOccurrence | 01-12 - see Cybsersource documentation for description of the values | |
| extraData.recurringValidationIndicator | 0,1 | |
| extraData.recurringAmountType | 1 = Fixed amount, 2 = Recurring with maximum amount | |
| extraData.recurringMaximumAmount | Maximum amount. Refer to Cybersource documentation. |
Debit/Authorization/Incremental Authorization Transactions
| Parameter | Required | Description |
|---|---|---|
| extraData.MITReason | false | Merchant initiated Transaction reason. |
| extraData.originalAmount | false | Original amount of the preauthorize. |
| customer.billingAddress1 | true | Mapped to billTo.address1 |
| customer.billingAddress2 | false | Mapped to billTo.address2 |
| customer.billingState | true | Mapped to billTo.administrativeArea |
| customer.billingCountry | true | Mapped to billTo.country |
| customer.email | true | Mapped to billTo.email |
| customer.firstName | true | Mapped to billTo.firstName |
| customer.lastName | true | Mapped to billTo.lastName |
| customer.billingCity | true | Mapped to billTo.locality |
| customer.billingPostcode | true | Mapped to billTo.postalCode |
| customer.billingPhone | false | Mapped to billTo.phoneNumber |
| customer.shippingAddress1 | false | Mapped to shipTo.address1 |
| customer.shippingAddress2 | false | Mapped to shipTo.address2 |
| customer.shippingState | false | Mapped to shipTo.administrativeArea |
| customer.shippingCountry | false | Mapped to shipTo.country |
| customer.shippingFirstname | false | Mapped to shipTo.firstName |
| customer.shippingLastname | false | Mapped to shipTo.lastName |
| customer.shippingCity | false | Mapped to shipTo.locality |
| customer.shippingPostCode | false | Mapped to shipTo.postalCode |
| customer.shippingPhone | false | Mapped to shipTo.phoneNumber |
| customer.extraData.shippingEmail | false | Mapped to shipTo.email |
| customer.extraData.buyerVatRegistrationNumber | false | buyerInformation.vatRegistrationNumber |
| customer.extraData.companyTaxId | false | buyerInformation.companyTaxId |
| customer.extraData.language | false | buyerInformation.language |
| customer.gender | false | buyerInformation.gender |
| customer.extraData.buyerMobilePhone | false | buyerInformation.mobilePhone |
| customer.extraData.personalIdentificationType | false | buyerInformation.personalIdentification.type |
| customer.extraData.personalIdentificationId | false | buyerInformation.personalIdentification.id |
| customer.extraData.personalIdentificationIssuedBy | false | buyerInformation.personalIdentification.issuedBy |
| customer.identification | false | buyerInformation.merchantCustomerId |
| customer.ipAddress | false | deviceInformation.ipAddress |
Decision Manager
The following extraData fields are necessary or optional for the Cybersource Decision Manager
(Please refer to the Cybersource Documentation for the possible values and the requirements):
| Parameter | Allowed values | Description |
|---|---|---|
| extraData.useDecisionManager | true | Required if DM is used. Send true if you want to send the decision manager data to cybersource. |
| extraData.dm_profile | Decision manager profile name not needed if default profile is used. | |
| extraData.dm_lastChangeDate | last change of account data | |
| extraData.dm_creationHistory | GUEST, NEW_ACCOUNT, EXISTING_ACCOUNT | |
| extraData.dm_modificationHistory | IF EXISTING_ACCOUNT = ACCOUNT_UPDATED_NOW or ACCOUNT_UPDATED_PAST | |
| extraData.dm_passwordHistory | PASSWORD_CHANGED_NOW, PASSWORD_CHANGED_PAST, PASSWORD_NEVER_CHANGED | |
| extraData.dm_createDate | IF EXISTING_ACCOUNT = creation Date | |
| extraData.dm_pwChangeDate | IF PASSWORD_CHANGED_PAST = change Date | |
| extraData.dm_firstUseOfShippingAddress | IF not GUEST = true/false | |
| extraData.dm_shippingAddressUsageDate | Current date if not GUEST and firstUseOfShippingAddress is false | |
| extraData.dm_accountPurchases | Number of Purchases | |
| extraData.dm_addCardAttempts | Number of add card attempts in last 24 hours. | |
| extraData.dm_suspiciousActivities | Indicates previous suspicious activities recogniced by the merchant. | |
| extraData.dm_paymentAccountHistory | PAYMENT_ACCOUNT_EXISTS, PAYMENT_ACCOUNT_ADDED_NOW (only for NEW_ACCOUNT and EXISTING_ACCOUNT) | |
| extraData.dm_paymentAccountDate | IF PAYMENT_ACCOUNT_EXISTS add date | |
| extraData.dm_transactionCountDay | Number of transactions in last 24 hours. (Success & abandoned) | |
| extraData.dm_transactionCountYear | Number of transactions in the last year. (Success & abandoned) | |
| extraData.dm_auxiliaryData | List of Key value pairs. E.g key1=value1&key2=value2 |
Japan Payment Options
This page provides an overview of the payments methods provided by the Japan Payment Options adapter in the IXOPAY platform. It also includes a full list of all configuration options available to you when integrating Japan Payment Options within your payments landscape, as well as an overview of the parameters required when submitting a transaction via IXOPAY's API.
| Parameter | Required | Description |
|---|---|---|
| extraData.japanPaymentOptionPaymentMethod | false | For possible values see Cybersource API reference |
| extraData.japanPaymentOptionBonuses | false | For possible values see Cybersource API reference |
| extraData.japanPaymentOptionBonusMonth | false | For possible values see Cybersource API reference |
| extraData.japanPaymentOptionSecondBonusMonth | false | For possible values see Cybersource API reference |
| extraData.japanPaymentOptionBonusAmount | false | For possible values see Cybersource API reference |
| extraData.japanPaymentOptionSecondBonusAmount | false | For possible values see Cybersource API reference |
| extraData.japanPaymentOptionPreapprovalType | false | For possible values see Cybersource API reference |
| extraData.japanPaymentOptionInstallments | false | For possible values see Cybersource API reference |
| extraData.japanPaymentOptionTerminalId | false | For possible values see Cybersource API reference |
| extraData.japanPaymentOptionFirstBillingMonth | false | For possible values see Cybersource API reference |
| extraData.japanPaymentOptionBusinessName | false | For possible values see Cybersource API reference |
| extraData.japanPaymentOptionBusinessNameKatakana | false | For possible values see Cybersource API reference |
| extraData.japanPaymentOptionJis2TrackData | false | For possible values see Cybersource API reference |
| extraData.japanPaymentOptionBusinessNameAlphaNumeric | false | For possible values see Cybersource API reference |
Transaction Indicators Mapping
Be aware that we have a special converter for this adapter, which converts our Transaction Indicators to Cybersource.
| IXOPAY Transaction Indicator | Cybersource parameter processingInformation.commerceIndicator |
|---|---|
| SINGLE | internet |
| INITIAL | internet |
| RECURRING | recurring |
| FIRST-CARDONFILE | internet |
| CARDONFILE | internet |
| CARDONFILE-MERCHANT-INITIATED | internet |
| MOTO | moto |