Skip to end of metadata
Go to start of metadata


According to the configuration of your payment portal you will receive access status changes for accesses to your premium sector. You will only receive these status messages with payment portals of the "Access" version. You can use them to protect your premium sector or to receive information about a subscription. The data is submitted to the URL specified in the merchant area. The data transfer is based on simple HTTP-POST request (key/value pairs).

The SessionStatus is sent from the following IP addresses: 185.60.20.0/24 (i.e. 185.60.20.1 to 185.60.20.254). Please configure your firewall to allow incoming packets from these IP addresses.

SessionStatus

HTTP request from PAYONE to the merchant's server

Common Parameter

Required

Format

Comment

key

+

AN..32

Key can be selected freely (see options payment portal) as MD5 value (The key hash values is currently given as MD5. This currently still remains with MD5 and is subject to change in future to SHA2-384.)

clearingtype

+

Default

Type of payment used for this access.

elv

Debit payment

cc

Credit card

vor

Prepayment

rec

Invoice

sb

Online bank transfer

serverip

-

Default

payone.de

-> this parameter may be removed in future.

accessid[x]

+

N3..12

Access ID (PAYONE)

action[x]

+

Default

Event, which refers to one customer each.

"add" , "remove", "abocancel", "renew "cancel_reversal", "lock", "unlock" (see below)

portalid[x]

+

N..7

Payment portal ID

productid[x]

+

N..7

ID for the offer

expiretime[x]

+

N..12

Unix timestamp at which access expires

userid[x]

+

N..12

Debtor ID (PAYONE)

customerid[x]

-

AN1..20

Merchant's customer ID

accessname[x]

-

AN..32

Customer's user name

accesscode[x]

-

AN..32

Customer's password

ip[x]

-

AN..15

Customer IP

param[x]

-

AN..15

Individual parameter

Key

x

x

x

N..x

x

x

Numeric value (x characters maximum)

AN..x

x

x

Alphanumeric value (x characters maximum)

[x]

x

x

In this manner changes for several customers can be submitted simultaneously in one request.

[x] = position number, e.g. [0],[1],...)

Important note: Please note that new parameters may be added at any time without previous notice. Therefore, you should use the parameter name for the evaluation and not the sequence, which may be subject to change at any time!


Expected reply to the request:

As a reply to the request, the string "SSOK" is expected. Each request is repeated in a 1-hour cycle until it is answered with "SSOK". This procedure ensures that all requests will be processed by your system. Simply issue the "SSOK" in a script via the "print" command. Make sure that this character string is the first that is printed from this script, e.g. print ("SSOK");

Sequence of events

After the start of the initial term an "add" request is deployed to your system. Different pieces of information about this customer are submitted (see above). After the access has expired, you will receive a "remove" request.

List of events (action)

With each access status change you receive a request. Via the "action" variable you receive information about the status of the access.

ActionDescription

add

An access portal has been opened.

remove

Access has expired and will not be renewed.

renew

Access was renewed/reduced (e.g. renewal of a subscription).

abocancel

The customer has cancelled the subscription for this access portal.

lock

Access has been blocked.

unlock

Access has been unblocked.

cancel_reversal

The termination of the subscription has been revoked.

Content


  • No labels