Versions Compared

Version Old Version 1 New Version Current
Changes made by

Technical Writer

Technical Writer

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
stylenone

Endpoints

HTTP Method

API URL

API Version

POST

https://connect2.payxpert.com/transaction/prepare

>= 002

POST

https://connect2.payxpert.com/payment/prepare

>= 002.50

This call corresponds to the step 2 of the global workflow. It is used to initialize a payment with all the required data (excepting payment mean information).

The information for the payment are serialized in JSON format and are transmitted in the body of the
request.

Accepted parameters

Code Block
languageelixir
ASDF
Appsplus tabs lite macro
data{"theme":"Electric Blue","features":["titles","active","border","rounded","icons","ripples","fullscreen"],"padding":10,"height":600,"tabFont":"Atlassian","tabSize":15,"tabBold":true,"tabItalic":false,"tabUnderline":false,"tabColor":"#ffffff","tabColorBG":"#172b4d","type":"scrollable","opacity":100,"activeColor":"#ffffff","activeColorBG":"#0052cc","borderWidth":1,"borderColor":"#ebecf0","radius":5,"hoverColor":"#ffffff","hoverColorBG":"#0052cc","iconSize":"medium","iconInline":true,"iconPrimary":"#ffffff","iconSecondary":"#172b4d","separatorWidth":1,"separatorColor":"#42526E","indicatorPercent":5,"indicatorColor":"#ff5630","indicatorColorBG":"#0052cc","hide":false,"vertical":false,"preload":true,"animate":false,"uuid":"v6lREFRLWv","isNew":false,"loaded":false,"attachmentId":"att795508739"}
Info

3DSecure V2 is available at version 002.70

Info

While testing your 3DSv2 implementation, you can set the parameter shopper.account.suspicious as true to trigger a challenge. false should result in frictionless flow.

Info

In the case of a non subscription creation payment, paymentMode may only take Single or OnShipping as a value.

Info

In the case of a subscription creation payment:

  • If the merchant is allowed to do on the fly subscription, subscription details can be specified in the On the fly Subscription fields (don’t use offerID in this case)

  • If the merchant is not allowed to do on the fly subscription or wants to use a predefined offer, the offerID field allows to choose the subscription to initiate

  • paymentMode may only take Recurrent or InstalmentsPayments

Payment Methods and Networks

Some payment methods can have several networks. Adding the payment network parameter in the API call will make the application create a payment with the chosen payment network. Not providing the network field for multi-networks payment methods will generate an error.

Payment Method

Payment Network

Description

CreditCard

 

Credit Card (brands availability according to your contract)

WeChat

 

WeChat Pay

Alipay

 

Alipay

DirectDebit

 

SEPA Direct Debit

Bancontact

 

Bancontact

BankTransfer

sofort

Bank transfer using Klarna (Sofort)

BankTransfer

przelewy24

Bank transfer using Przelewy24 (Poland only)

BankTransfer

ideal

Bank transfer using iDeal

BankTransfer

giropay

Bank transfer using Giropay

BankTransfer

eps

Bank transfer using EPS

BankTransfer

poli

Bank transfer using POLi

BankTransfer

dragonpay

Bank transfer using DragonPay

BankTransfer

trustly

Bank transfer using Trustly

Line

 

Line Pay

Response

The body of the response to a transaction creation request is in JSON format.

The following fields are present in the response:

Name

Type

Description

API Version

code

String(3)

API response code (see response codes for possible values)

>= 002

message

String(128)

Human readable message associated with the code

>= 002

customerToken

String

The customer token to be used for payment processing (only present if payment creation was successful)

>= 002

merchantToken

String(32)

The merchant token to be used for payment status request (only present if payment creation was successful)

>= 002

Response codes

Here are the possible response code to a payment creation:

Response code

Response Message

200

Request processed successfully

400

Missing parameter

401

Missing parameter in request

402

Error during JSON deserialization of parameter

500

Error handling the request

501

Incorrect data in submitted request

Code Block
{
    "code": "200",
    "message": "Request processed successfully",
    "customerToken": "1234",
    "merchantToken": "1234"
}

Code samples

Appsplus tabs lite macro
data{"theme":"Electric Blue","features":["titles","active","border","rounded","icons","ripples","fullscreen"],"padding":10,"height":600,"tabFont":"Atlassian","tabSize":15,"tabBold":true,"tabItalic":false,"tabUnderline":false,"tabColor":"#ffffff","tabColorBG":"#172b4d","type":"scrollable","opacity":100,"activeColor":"#ffffff","activeColorBG":"#0052cc","borderWidth":1,"borderColor":"#ebecf0","radius":5,"hoverColor":"#ffffff","hoverColorBG":"#0052cc","iconSize":"medium","iconInline":true,"iconPrimary":"#ffffff","iconSecondary":"#172b4d","separatorWidth":1,"separatorColor":"#42526E","indicatorPercent":5,"indicatorColor":"#ff5630","indicatorColorBG":"#0052cc","hide":false,"vertical":false,"preload":true,"animate":false,"uuid":"vWMwcLYC6K","isNew":false,"loaded":false,"attachmentId":"att795115524"}