Page tree
Skip to end of metadata
Go to start of metadata

Introduction

Changing the contract data or cancelling a contract. 


Request "updateaccess"

Common Parameter

RequiredFormatComment

accessid

+


Access ID, defined by PAYONE

Format

NUMERIC(3..12)

action

+


Action to perform to given contract

Format

LIST 
ValueComment

update

Update access (default)

cancel

Cancel subscription

reverse_cancel

Revoke cancellation of sub­scription

lock

Block access

unlock

Unblock access

Parameter ( update )

clearingtype

-


only available with action=update

Format

LIST 
valueCommentDescription / Comments
elvDebit payment

According to the new regulation on the transfer of funds (Geldtransferverordnung) address data (name, street, zip, city) is mandatory for cross border bank transfers (EEA / EWR), e.g.: CH, SM, MC, PM, JE, GG. This is mandatory from 2017-11-19.

Please use request “updateuser” to update customers address data.

This means that the whole address for bank transfers needs to be provided.

ccCredit card
recInvoice
codCash on deliverynot allowed for vauthorization, createaccess, updateaccess
vorPrepaymentnot allowed for vauthorization, createaccess, updateaccess
sbOnline Bank Transfernot allowed for vauthorization, createaccess, updateaccess
wlte-walletnot allowed for vauthorization, createaccess, updateaccess
fncFinancingnot allowed for vauthorization, createaccess, updateaccess
cshCash or Hybrid Paymentsnot allowed for vauthorization, createaccess, updateaccess

access_starttime

-


Access starting date as Unixtimestamp

Format

Unixtimestamp

access_expiretime

-


Can be

  • either used with creating a new access (createaccess)
    -> Set expiry date/time of the initial term as Unixtimestamp (e.g. date of first renewal)

    • deprecated, should not be used. Please use “period_unit_trail”, “period_length_trail” instead.
    • do not use with “period_unit_trail”, “period_length_trail”
  • or used with updating an existing access (updateaccess)
    -> Update expiry date/time of the current term as Unixtimestamp (e.g. overwrite date of next renewal)



Format

Unixtimestamp

productid

-


ID for the offer

Format

NUMERIC(1..7)

amount_trail

-


Total gross amount for initial term

Must equal the sum (quantity x price) of all items for the initial term.

Required when item is submitted.

Amount can be "0" (e.g. for test period).

Format

NUMERIC(1..8), max. value 999 999 99

period_unit_trail

-


Time unit for initial term

Do not use with “access_expiretime”.

Do not exceed 5 years / 60 months.

Format

LIST 
valueComment

Y

Value “length” is in years

M

Value “length” is in months

D

Value “length” is in days

period_length_trail

-


Duration of the initial term. Can only be used in combination with period_unit_trail.

Required when period_unit_trail is submitted.

Do not use with “access_expiretime”

Format

NUMERIC(1..4)

amount_recurring

-


Total gross amount of all items of one period during the subsequent term

Must equal the sum (quantity x price) of all items during the subsequent term.

Required when item is submitted.

Amount must not be "0".


Format

NUMERIC(1..8), max. value 999 999 99

period_unit_recurring

-


Time unit for subsequent term

Do not exceed 5 years / 60 months.

Format

LIST 
valueComment

Y

Value “length” is in years

M

Value “length” is in months

D

Value “length” is in days

N

No subsequent term given

period_length_recurring

-


Duration of the subsequent term. Can only be used in combination with period_unit_recurring.

Required when period_length_recurring is submitted.

Format

NUMERIC(1..4)

Parameter ( update ) module invoicing

id_trail[n]

-


Product number, order number, etc. of this item (initial term)

Format

CHAR(1..32)

Array

Array elements [n] starting with [1]; serially numbered; max [100]

Permitted Symbols
[0-9][A-Z][a-z][()[]{} +-_#/:]

no_trail[n]

-


Quantity of this item (initial term)

Format

NUMERIC(5)

Array

Array elements [n] starting with [1]; serially numbered; max [100]

pr_trail[n]

-


Unit gross price of the item (initial term) in smallest unit.

Format

NUMERIC(8) max. 999 999 99

Array

Array elements [n] starting with [1]; serially numbered; max [100]

de_trail[n]

-


Description of this item (initial term)

Format

CHAR(1..255)

Array

Array elements [n] starting with [1]; serially numbered; max [100]

Example
de[1]=Product 1
de[2]=Product 2
de[3]=Product 3
...
de[100]=Product 100

va_trail[n]

-


VAT rate (% or bp) (first term)

Format

NUMERIC(4)

Array

Array elements [n] starting with [1]; serially numbered; max [100]

id_recurring[n]

-


Product number, order number, etc. of this item (subsequent term)

Format

CHAR(1..32)

Array

Array elements [n] starting with [1]; serially numbered; max [100]

Permitted Symbols
[0-9][A-Z][a-z][()[]{} +-_#/:]

no_recurring[n]

-


Quantity of this item (subsequent term)

Format

NUMERIC(5)

Array

Array elements [n] starting with [1]; serially numbered; max [100]

pr_recurring[n]

-


Unit gross price of the item (subsequent term) in smallest unit.

Format

NUMERIC(8) max. 999 999 99

Array

Array elements [n] starting with [1]; serially numbered; max [100]

de_recurring[n]

-


Description of this item (subsequent term)

Format

CHAR(1..255)

Array

Array elements [n] starting with [1]; serially numbered; max [100]

Example
de[1]=Product 1
de[2]=Product 2
de[3]=Product 3
...
de[100]=Product 100

va_recurring[n]

-


VAT rate (% or bp) (subsequent term)

Format

NUMERIC(4)

Array

Array elements [n] starting with [1]; serially numbered; max [100]

Parameter (cancel)

access_canceltime

-


Date of cancellation as Unixtimestamp if cancellation date is in the future, e.g. not until the next period. (After this date no further renewals will be carried out)

(Only possible if the order has not been cancelled already)

Response "updateaccess"

Common Parameter

Required

Format

Comment

status

+

Default

OK / ERROR

Parameter (ERROR)

errorcode

+


In case of error the PAYONE Platform returns an error code for your internal usage.

Format

NUMERIC(1..6)

errormessage

+


In case of error the PAYONE Platform returns an error message for your internal usage.

Format

CHAR(1..1024)


Content


  • No labels