Legacy parameters - Direct properties mapping
To process transactions with Direct, you need to provide certain information in your request. For legacy, you use a set of parameters for each integration method. In Direct, these parameters translate to properties in JSON format. To help you setting up your new integration, have a look at this mapping.
Find detailed information about these and all other available properties in our API reference.
Direct Properties Mapping
| Legacy parameter | Direct |
|---|---|
|
PSPID |
N/A PSPID routing is covered by the SDK initialisation/By replacing {merchantId} in the API resource. Learn more in our dedicated Authentication guide. |
|
ORDERID |
order.references.merchantReference Not mandatory for Direct. If omitted, our platform will generate a random string. |
|
CURRENCY |
amountOfMoney.currencyCode |
|
AMOUNT |
amountOfMoney.amount |
|
LANGUAGE |
hostedCheckoutSpecificInput.locale Not mandatory for Direct. |
|
SHASIGN |
N/A Authentication is covered by the SDK initialisation/manual authentication for requests sent directly to our API. Learn more in our dedicated Authentication guide. |
|
cardPaymentMethodSpecificInput.authorizationMode (for card payments) redirectPaymentMethodSpecificInput.requiresApproval (for non-card payments, i.e. Paypal) If undefined, our platform processes transactions as authorisations by default. Mind that Direct ignores the Back Office setting Configuration > Technical information > Global transaction parameters > Default operation code. Learn more about how to outsource Back Office settings to the Direct API in our dedicated guide. |
|
|
ACCOUNT.PSPID |
N/A PSPID routing is covered by the SDK initialisation/By replacing {merchantId} in the API resource. Learn more in our dedicated Authentication guide. |
|
ALIAS.ALIASID |
cardPaymentMethodSpecificInput.token |
|
ALIAS.ORDERID |
N/A |
|
ALIAS.STOREPERMANENTLY |
askConsumerConsent |
|
CARD.PAYMENTMETHOD |
N/A |
|
LAYOUT.TEMPLATENAME |
variant |
|
PARAMETERS.ACCEPTURL |
N/A Is covered by cardPaymentMethodSpecificInput.returnUrl/hostedCheckoutSpecificInput.returnUrl. |
|
PARAMETERS.EXCEPTIONURL |
N/A Is covered by cardPaymentMethodSpecificInput.returnUrl/hostedCheckoutSpecificInput.returnUrl. |
|
SHASIGNATURE.SHASIGN |
N/A Authentication is covered by the SDK initialisation/manual authentication for requests sent directly to our API. Learn more in our dedicated Authentication guide. |
|
CARD.BRAND |
N/A |
|
CARD.PAYMENTMETHOD |
N/A |
|
LAYOUT.LANGUAGE |
locale |
|
USERID |
N/A Authentication is covered by the SDK initialisation/manual authentication for requests sent directly to our API. Learn more in our dedicated Authentication guide. |
|
PSWD |
N/A Authentication is covered by the SDK initialisation/manual authentication for requests sent directly to our API. Learn more in our dedicated Authentication guide. |
|
CARDNO |
cardPaymentMethodSpecificInput.card.cardNumber |
|
ED |
cardPaymentMethodSpecificInput.card.expiryDate |
|
CN |
cardPaymentMethodSpecificInput.card.cardholderName |
|
CVC |
cardPaymentMethodSpecificInput.card.cvv |
|
browserAcceptHeader |
order.customer.device.acceptHeader |
|
browserColorDepth |
order.customer.device.browserData.colorDepth |
|
browserJavaEnabled |
order.customer.device.browserData.javaEnabled |
|
browserLanguage |
order.customer.device.locale |
|
browserScreenHeight |
order.customer.device.browserData.screenHeight |
|
browserScreenWidth |
order.customer.device.browserData.screenWidth |
|
browserTimeZone |
order.customer.device.timezoneOffsetUtcMinutes |
|
browserUserAgent |
order.customer.device.userAgent |
|
ACCEPTURL |
cardPaymentMethodSpecificInput.threeDSecure.redirectionData.returnUrl / hostedCheckoutSpecificInput.returnUrl Direct uses one redirection URL for all possible outcomes. Adapt the returnUrl at runtime based on our platform's transaction feedback. |
|
DECLINEURL |
|
|
EXCEPTIONURL |
|
|
FLAG3D |
cardPaymentMethodSpecificInput.threeDSecure.skipAuthentication |