WorldLine/Acquiring
This page provides an overview of the payments methods provided by the WorldLine/Acquiring adapter in the IXOPAY platform. It also includes a full list of all configuration options available to you when integrating WorldLine/Acquiring 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 | Hosted payment page, payment.js, Server-to-server | Debit, Preauthorize |
Additional Parameters
Debit & Preauthorize
| Name | Type | Required | Value | Description |
|---|---|---|---|---|
| ["extraData"]["avsCheck"] | boolean | false (also has connector config) | If TRUE is sent, the customers postal code and billing address will be sent for verification. If nothing provided, the connector configuration will control behaviour | |
| ["extraData"]["WORLDLINE_MOTO_ENTRY_MODE"] | string | false (also has connector config) | MAIL / TELEPHONE | Specify the card entry mode for MOTO transaction. If nothing provided, the connector configuration will control default value |
| ["extraData"]["WORLDLINE_TRANSACTION_TYPE"] | string | false | (refer to WorldLine CardOnFile documentation) | Specify value of WorldLine request params cardPaymentData.cardOnFileData.initialCardOnFileData.transactionType & cardPaymentData.cardOnFileData.subsequentCardOnFileData.transactionType that are used for register and subsequent transactions. If nothing provided the UNSCHEDULED_CARD_ON_FILE will be used by default, except transactions with indicator INITIAL or RECURRING for which by default will be used RECURRING_FIXED |
| ["extraData"]["psp:request.cardPaymentData.cardOnFileData.initialCardOnFileData.futureUse"] | string | false (also has connector config) | MERCHANT_INITIATED / CARDHOLDER_INITIATED | Use for initial transactions to indicate the type of COF transactions expected to be performed referring to this transaction. If nothing provided, the connector configuration will control default value |
CoF / Subsequent transaction
By WorldLine Acquiring, it is required to define transaction initiator (Merchant/Cardholder) as for subsequent transaction, as for initial transaction.
The initial transaction initiator is definable using request extra data param extraData.psp:request.cardPaymentData.cardOnFileData.initialCardOnFileData.futureUse. If the value is not present in request, a fallback value will be taken from connector configurations if defined, otherwise MERCHANT_INITIATED will be used by default.
The subsequent transaction initiator will be set accordingly to following mapping that is based on transaction indicators:
| Transaction indicator | subsequentCardOnFileData.cardOnFileInitiator value |
|---|---|
RECURRING | MERCHANT |
MOTO | MERCHANT |
CARDONFILE_MERCHANT_INITIATED | MERCHANT |
CARDONFILE | CARDHOLDER |
| default (if by a mistake none of above indicators sent) | CARDHOLDER |
Preauthorize
| Name | Type | Required | Value | Description |
|---|---|---|---|---|
| ["extraData"]["psp:request.cardPaymentData.allowPartialApproval"] | boolean | false (also has connector config) | Allow an issuer to authorize less amount than requested. Refer to WorldLine partial approval documentation. If nothing provided, the connector configuration will control behaviour | |
| ["extraData"]["psp:request.authorizationType"] | string | false (also has connector config) | PRE_AUTHORIZATION / FINAL_AUTHORIZATION | Indicate the authorization type. If nothing provided, the connector configuration will control default value. (refer to WorldLine documentation) |
Capture
| Name | Type | Required | Description |
|---|---|---|---|
| ["extraData"]["isFinalCapture"] | boolean | false | Boolean parameter that can be sent with the `Capture' API request to indicate if it should be a final capture |
Result Extra Data
| Parameter | Value |
|---|---|
| avs_result | Mapped from the field cardPaymentData.ecommerceData.addressVerificationData. For possible values see WorldLine Address Verification Service reference |
| cvv_result | Mapped from the field cardPaymentData.ecommerceData.cardSecurityCodeResult. For possible values see WorldLine Card Security Code reference |