The request must have the following headers:
Content-Type: application/json
Accept-Language: en-US
Origin: { Origin }
We use cookies (our own and those of third parties) to make our websites easier for you to use in accordance with your browser settings. By continuing to use our websites, you consent to the use of cookies. Please see our Cookie Policy for more information on cookies and information on how you can change your browser's cookie settings: Cookie Policy.
Last changes: 12-20-2022
This API method enabes you as a Merchant to initiate the Checkout.
The request must have the following headers:
Content-Type: application/json
Accept-Language: en-US
Origin: { Origin }
Field | Mandatory | Description | Type | Length |
cardDetails | Yes | Tokenized card details | Object | Object |
exemptionFlag | Yes | If received, defines the reason for the frictionless flow (without 3DS challenge) | String | 2 |
payment | Yes | The payment amount to be charged against the payment option. | Payment | Object |
billingAddress | Yes | Billing address of the consumer. | Address | Object |
shippingAddress | No | Shipping address of the consumer. | Address | Object |
consumer | Yes | Consumer's personal information. | Person | Object |
extraInfo | No | Payment extra information to define the product group, to display different set of payment options (Card, SEPA, PayPal...) for different products. | Extra Info | Object |
deviceInfo | No | Details of the device used to perform the payment | Device Info | Object |
Financial institution's risk management is applicable on storing and verifying payment options, even though no charge is made at that point in time. Therefore, your consumer's personal information is already required within this initialization request.
Please refer to our data model for details regarding the referenced objects.
Path:
POST {Base URL}/payment/init-token-payment
Header:
Content-Type:
application/json
Accept-Language:
en-US
{
"merchantKey": "3227a1df-1033-46fd-93bd-x01777339e5b",
"excemptionFlag":"07",
"payment": {
"currencyCode": "EUR",
"amount": 40.11,
"description": "Purchase 1x product ABC"
},
"billingAddress": {
"customerFullName": "Hells Butcher",
"emailAddress": "hells.butcher_001@mail.com",
"address": "Leopoldstrasse",
"number": "244",
"city": "Munich",
"postCode": "80807",
"countryCode": "DE"
},
"shippingAddress": {
"address": "Leopoldstrasse",
"number": "244",
"city": "Munich",
"postCode": "80807",
"countryCode": "DE"
},
"consumer": {
"emailAddress": "hells.butcher_001@mail.com",
"customerGroupId": "VIP",
"gender": "m",
"lastName": "Hells",
"firstName": "Butcher",
"middleName": "fon",
"title":"Mr",
"culture": "de-de",
"timezone": "<EXAMPLE>",
"dateOfBirth": "2000-01-01",
"mobilePhone": "015xx22-2135466",
"isBusinessUser": false,
"taxId": "00745948504594"
},
"cardDetails": {
"cardBrand": "visa",
"cardHolder": "Jimmy Rogers",
"cardToken": "LLVOXVAJINJWPDDPZA",
"cvvToken": "VDODFNMCXWMPSQBXJW",
"cardExpiryMonth": 12,
"cardExpiryYear": 2024
}
}
The Create Tokenized Payment response includes the 3DS details that enables you to complete the 3D secure process.
{
"transactionId": "234d514f-70ef-4980-9b76-6bc86b0268f4",
"status": "AUTHORIZATION_INITIALIZED",
"creationDate": "2022-12-19T16:30:05.857Z",
"threeDSChallenge": "3DSv1",
"threeDSv1": {
"url": "https://test.ppipe.net/connectors/demo/simulator.link?ndcid=8ac7a4c872ea49770172eae841fe0597_931ecffdbcb24749a192eb3ac6ea701d",
"connector": "THREEDSECURE",
"MD": "8ac7a4a1852afebd01852b389b342e14",
"PaReq": "IT8ubu+5z4YupUCOEHKsbiPep8UzIAcPKJEjpwGlzD8#NDExMTExMTExMTExMTExMSMzMzc5LjIwIEVVUiM",
"TermUrl": "https://test.ppipe.net/connectors/asyncresponse_simulator;jsessionid=02860A292BC003BA3B511328D0185F62.uat01-vm-con02?asyncsource=THREEDSECURE&ndcid=8ac7a4c872ea49770172eae841fe0597_931ecffdbcb24749a192eb3ac6ea701d"
}
}
{
"transactionId": "149a82f1-58d2-42c4-bf39-aa76511b00fc",
"status": "AUTHORIZATION_INITIALIZED",
"creationDate": "2022-12-19T16:35:21.450Z",
"threeDSChallenge": "3DSv2",
"threeDSv2": {
"url": "https://test.ppipe.net/connectors/asyncresponse_simulator;jsessionid=38A49519B81F9CCD0DE55AC7C31A39C5.uat01-vm-con03?asyncsource=ACI_3DS_2&type=methodRedirect&cdkForward=true&ndcid=8ac7a4c872ea49770172eae841fe0597_bfb4848a69004a9f8dfcdf29d60c2bfc",
"origin": "iframe#hidden",
"waitUntil": "iframe#load",
"description": "Hidden iframe post for 3D Secure 2.0",
"methodDataUrl": "https://test.ppipe.net/connectors/demo/submit?action=ACI3DS2AccessControlServer&acsRequest=METHOD",
"method": "POST",
"threeDSMethodData": "eyJ0aHJlZURTTWV0aG9kTm90aWZpY2F0aW9uVVJMIjoiaHR0cHM6Ly90ZXN0LnBwaXBlLm5ldC9jb25uZWN0b3JzL2FyX3NpbXVsYXRvci8zZHMyO2pzZXNzaW9uaWQ9MzhBNDk1MTlCODFGOUNDRDBERTU1QUM3QzMxQTM5QzUudWF0MDEtdm0tY29uMDM_YXN5bmNzb3VyY2U9QUNJXzNEU18yJnR5cGU9bWV0aG9kTm90aWZpY2F0aW9uJm5kY2lkPThhYzdhNGM4NzJlYTQ5NzcwMTcyZWFlODQxZmUwNTk3X2JmYjQ4NDhhNjkwMDRhOWY4ZGZjZGYyOWQ2MGMyYmZjIiwidGhyZWVEU1NlcnZlclRyYW5zSUQiOiJhNWI2N2U3Yi0xZGM2LTQzOTctYTdmZS1hMjM0ODY2NzFlZTcifQ"
}
}
If you receive an HTTP status other then 2xx, the request failed. Please try to interpret the response message to correct your request and contact customer support in case of further questions.
Document version 1.0 - 2022-12-19