Versions Compared

Key

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

Introduction

For processing a purchase transaction in connection with session management or with initiating a subscription.

This request is only available with the version "Access".

Important notes

  • For the time-based settlement of goods or subscriptions you must first create offers in your merchant area.
  • You have the option to submit values that overwrite the settings for the offer used (e.g. price, term, etc.). These optional submitted values will be used for all following periods of this contract. The original offer is not changed.
  • If the time at which access is first granted is in the future or the initial term is free of charge, a reservation, which will later be cancelled automatically, is carried out. The amount for the reservation is one payment unit (e.g. 1 EUR). This procedure is simply used to verify the customer's payment data and to check the customer data using risk checks, provided that these are active. The first "real" booking will be effected at the start of the first period that requires a charge.
  • The periods (defined by “period_unit_trail”, “period_length_trail”, “period_unit_recurring”, “period_length_ recurring”) are limited to 60 months.


Request "createaccess"

Common Pararameter

RequiredFormatComment

aid

+


Excerpt Include
aid - definition
aid - definition
nopaneltrue

clearingtype

+


Excerpt Include
clearingtype - definition
clearingtype - definition
nopaneltrue

reference

+


Excerpt Include
reference - definition
reference - definition
nopaneltrue

productid

+


Excerpt Include
productid - definition
productid - definition
nopaneltrue

param

-


Excerpt Include
param contract - definition
param contract - definition
nopaneltrue

accessname

-


Excerpt Include
accessname - definition
accessname - definition
nopaneltrue

accesscode

-


Excerpt Include
accesscode - definition
accesscode - definition
nopaneltrue

access_starttime

-


Excerpt Include
access_starttime - definition
access_starttime - definition
nopaneltrue

access_expiretime

-


Excerpt Include
access_expiretime - definition
access_expiretime - definition
nopaneltrue

access_canceltime

-


Excerpt Include
access_canceltime - definition
access_canceltime - definition
nopaneltrue

amount_trail

o


Excerpt Include
amount_trail - definition
amount_trail - definition
nopaneltrue

period_unit_trail

-


Excerpt Include
period_unit_trail - definition
period_unit_trail - definition
nopaneltrue

period_length_trail

o


Excerpt Include
period_length_trail - definition
period_length_trail - definition
nopaneltrue

amount_recurring

o


Excerpt Include
amount_recurring - definition
amount_recurring - definition
nopaneltrue

period_unit_recurring

-


Excerpt Include
period_unit_recurring - definition
period_unit_recurring - definition
nopaneltrue

period_length_recurring

o


Excerpt Include
period_length_recurring - definition
period_length_recurring - definition
nopaneltrue

Parameter ( module billing )

vaccountname

+


Excerpt Include
vaccountname - definition
vaccountname - definition
nopaneltrue

settle_period_length

+


Excerpt Include
settle_period_length - definition
settle_period_length - definition
nopaneltrue

settle_period_unit

+


Excerpt Include
settle_period_unit - definition
settle_period_unit - definition
nopaneltrue

settletime

-


Excerpt Include
settletime - definition
settletime - definition
nopaneltrue

payout_open_balance

-


Excerpt Include
payout_open_balance - definition
payout_open_balance - definition
nopaneltrue

Parameter ( module Invoicing )

invoice_deliverymode

-


Excerpt Include
invoice_deliverymode - definition
invoice_deliverymode - definition
nopaneltrue

invoiceappendix

-


Excerpt Include
invoiceappendix - definition
invoiceappendix - definition
nopaneltrue

id_trail[n]

+


Excerpt Include
id_trail[n] - definition
id_trail[n] - definition
nopaneltrue

no_trail[n]

+


Excerpt Include
no_trail[n] - definition
no_trail[n] - definition
nopaneltrue

pr_trail[n]

+


Excerpt Include
pr_trail[n] - definition
pr_trail[n] - definition
nopaneltrue

de_trail[n]

+


Excerpt Include
de_trail[n] - definition
de_trail[n] - definition
nopaneltrue

va_trail[n]

-


Excerpt Include
va_trail[n] - definition
va_trail[n] - definition
nopaneltrue

ti_trail[n]

-


Excerpt Include
ti_trail[n] - definition
ti_trail[n] - definition
nopaneltrue

id_recurring[n]

+


Excerpt Include
id_recurring[n] - definition
id_recurring[n] - definition
nopaneltrue

no_recurring[n]

+


Excerpt Include
no_recurring[n] - definition
no_recurring[n] - definition
nopaneltrue

pr_recurring[n]

+


Excerpt Include
pr_recurring[n] - definition
pr_recurring[n] - definition
nopaneltrue

de_recurring[n]

+


Excerpt Include
de_recurring[n] - definition
de_recurring[n] - definition
nopaneltrue

va_recurring[n]

-


Excerpt Include
va_recurring[n] - definition
va_recurring[n] - definition
nopaneltrue

ti_recurring[n]

-


Excerpt Include
ti_recurring[n] - definition
ti_recurring[n] - definition
nopaneltrue

Parameter ( personal data )

customerid

-


Excerpt Include
customerid - definition
customerid - definition
nopaneltrue

userid

-


Excerpt Include
userid - definition
userid - definition
nopaneltrue

salutation

-


Excerpt Include
salutation - definition
salutation - definition
nopaneltrue

title

-


Excerpt Include
title - definition
title - definition
nopaneltrue

firstname

o


Excerpt Include
firstname - definition
firstname - definition
nopaneltrue

lastname

+


Excerpt Include
lastname - definition
lastname - definition
nopaneltrue

company

-


Excerpt Include
company - definition
company - definition
nopaneltrue

street

-


Excerpt Include
street - definition
street - definition
nopaneltrue

addressaddition

-


Excerpt Include
addressaddition - definition
addressaddition - definition
nopaneltrue

zip

-


Excerpt Include
zip - definition
zip - definition
nopaneltrue

city

-


Excerpt Include
city - definition
city - definition
nopaneltrue

country

+


Excerpt Include
country - definition
country - definition
nopaneltrue

email

-


Excerpt Include
email - definition
email - definition
nopaneltrue

telephonenumber

-


Excerpt Include
telephonenumber - definition
telephonenumber - definition
nopaneltrue

birthday

-


Excerpt Include
birthday - definition
birthday - definition
nopaneltrue

language

-


Excerpt Include
language - definition
language - definition
nopaneltrue

vatid

-


Excerpt Include
vatid - definition
vatid - definition
nopaneltrue

ip

-


Excerpt Include
ip - definition
ip - definition
nopaneltrue

Parameter ( debit payment )

iban

o


Excerpt Include
iban - definition
iban - definition
nopaneltrue

bic

o


Excerpt Include
bic - definition
bic - definition
nopaneltrue

bankcountry

o


Excerpt Include
bankcountry - definition
bankcountry - definition
nopaneltrue

bankaccount

o


Excerpt Include
bankaccount - definition
bankaccount - definition
nopaneltrue

bankcode

o


Excerpt Include
bankcode - definition
bankcode - definition
nopaneltrue

bankaccountholder

-


Excerpt Include
bankaccountholder - definition
bankaccountholder - definition
nopaneltrue

mandate_identification

o


Excerpt Include
mandate_identification - definition
mandate_identification - definition
nopaneltrue

Parameter ( credit card )

cardpan

+


Excerpt Include
cardpan - definition
cardpan - definition
nopaneltrue

cardtype

+


Excerpt Include
cardtype - definition
cardtype - definition
nopaneltrue

cardexpiredate

+


Excerpt Include
cardexpiredate - definition
cardexpiredate - definition
nopaneltrue

cardcvc2

o


Excerpt Include
cardcvc2 - definition
cardcvc2 - definition
nopaneltrue

cardissuenumber

-


Excerpt Include
cardissuenumber - definition
cardissuenumber - definition
nopaneltrue

cardholder

-


Excerpt Include
cardholder - definition
cardholder - definition
nopaneltrue

pseudocardpan

o


Excerpt Include
pseudocardpan - definition
pseudocardpan - definition
nopaneltrue

Parameter ( 3-D Secure )

xid

+


Excerpt Include
xid - definition
xid - definition
nopaneltrue

cavv

-


Excerpt Include
cavv - definition
cavv - definition
nopaneltrue

eci

-


Excerpt Include
eci - definition
eci - definition
nopaneltrue

customer_is_presento

Excerpt Include
customer_is_present - definition
customer_is_present - definition
nopaneltrue

successurlo
  • either "xid" (from previous 3dscheck)
  • or "successurl", "errorurl ", "backurl" must be given
  • or default "successurl" and "backurl" for a portal are configured within PMI

Excerpt Include
successurl - definition
successurl - definition
nopaneltrue

errorurl+
  • either "xid" (from previous 3dscheck)
  • or "successurl", "errorurl", "backurl" must be given.-


    Excerpt Include
    errorurl - definition
    errorurl - definition
    nopaneltrue

    backurlo
    • either "xid" (from previous 3dscheck)
    • or "successurl", "errorurl", "backurl" must be given
    • or default "successurl" and "backurl" for a portal are configured within PMI

    Excerpt Include
    backurl - definition
    backurl - definition
    nopaneltrue



    Response "createaccess"

    Common Parameter

    Required

    Format

    Comment

    status

    +

    Default

    APPROVED / REDIRECT / PENDING / ERROR

    Parameter (APPROVED)

    txid

    +


    Excerpt Include
    txid - definition
    txid - definition
    nopaneltrue

    userid

    +


    Excerpt Include
    userid - definition
    userid - definition
    nopaneltrue

    accessid

    +


    Excerpt Include
    accessid - definition
    accessid - definition
    nopaneltrue

    Parameter (REDIRECT)

    txid+

    Excerpt Include
    txid - definition
    txid - definition
    nopaneltrue

    userid+

    Excerpt Include
    userid - definition
    userid - definition
    nopaneltrue

    redirecturl+

    Excerpt Include
    redirecturl - definition
    redirecturl - definition
    nopaneltrue

    Parameter (PENDING)

    txid

    +


    Excerpt Include
    txid - definition
    txid - definition
    nopaneltrue

    userid

    +


    Excerpt Include
    userid - definition
    userid - definition
    nopaneltrue

    accessid

    +


    Excerpt Include
    accessid - definition
    accessid - definition
    nopaneltrue

    Parameter (ERROR)

    errorcode

    +


    Excerpt Include
    errorcode - definition
    errorcode - definition
    nopaneltrue

    errormessage

    +


    Excerpt Include
    errormessage - definition
    errormessage - definition
    nopaneltrue

    customermessage

    -


    Excerpt Include
    customermessage - definition
    customermessage - definition
    nopaneltrue




    Content

    Table of Contents
    excludeContent