v1

latestOpenAPI 3.0.12026-07-2421268219.4 KB

/v1/transactions

Initialize a transaction

Securely send all the needed parameters to the transaction initialization API. The result of this API call is a HTTP 201 status code with a transactionId in the response body and the Location header set. This call is required to proceed with our Redirect and Lightbox integration

post/v1/transactions

Request body

amountinteger

The amount of the transaction in the currency’s smallest unit. For example use 1000 for CHF 10.00. Can be omitted for use cases where only a registration should take place (if the payment method supports registrations)

currencystring required

3 letter <a href='https://en.wikipedia.org/wiki/ISO_4217' target='_blank'>ISO-4217</a> character code. For example CHF or USD

refnostring required

The merchant's reference number. It should be unique for each transaction.

refno2string

Optional customer's reference number. Supported by some payment methods or acquirers.

autoSettleboolean

Whether to automatically settle the transaction after an authorization or not. If not present with the init request, the settings defined in the dashboard ('Authorisation / Settlement' or 'Direct Debit') will be used. Those settings will only be used for web transactions and not for server to server API calls.

language'en' | 'de' | 'fr' | 'it' | 'es' | 'el' | 'fi' | 'hu' | 'ko' | 'nl' | 'no' | 'da' | 'pl' | 'pt' | 'ru' | 'ja' | 'sk' | 'sl' | 'sv' | 'tr' | 'zh'

This parameter specifies the language (language code) in which the payment page should be presented to the cardholder. The <a href='https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes' target='_blank'>ISO-639-1</a> two letter language codes listed above are supported

paymentMethodsstring[]

An array of payment method shortnames. For example ["VIS", "PFC"]. If omitted, all available payment methods will be displayed on the payment page. If the Mobile SDKs are used (returnMobileToken), this array is mandatory.

DVIDeltaVistaData

DVI has no specific request parameters but we need an empty object here to handle it as a DVI request.

accertifyAccertify

Accertify decision (Accepted, Review, Declined

extensionsExtension

An object for additional data for customized processes.

Example request

{
  "card": {
    "number": "4242424242424242"
  },
  "BON": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  },
  "ELV": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  },
  "ESY": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  },
  "INT": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  },
  "MDP": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  },
  "MFX": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  },
  "MPX": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  },
  "PAP": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  },
  "PFC": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  },
  "PFP": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  },
  "PLU": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  },
  "REK": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  },
  "SWP": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  },
  "TWI": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  }
}

Response

Transaction successfully initialized

transactionIdstring

The transactionId to be used when using Redirect- or Lightbox Mode. If no further action happens with the transactionId after initialization, it will be invalidated after 30 minutes.

mobileTokenstring

Mobile token which is needed to initialize the Mobile SDKs.

TWITwintResponse

Twint specific response parameters