Maintenance Work Notice!

We will carry out maintenance work on this documentation on Tuesday, 15.06.2021 between 3 pm and 4 pm CEST. Thank you for your understanding.

Page tree

Search

Skip to end of metadata
Go to start of metadata

Paygate interface

Definitions

Data formats

Format

Description

a

alphabetical

as

alphabetical with special characters

n

numeric

an

alphanumeric

ans

alphanumeric with special characters

ns

numeric with special characters

bool

boolean expression (true or false)

3

fixed length with 3 digits/characters

..3

variable length with maximum 3 digits/characters

enum

enumeration of allowed values

dttm

ISODateTime (YYYY-MM-DDThh:mm:ss)


Abbreviations

Abbreviation

Description

Comment

CND

condition


M

mandatory

If a parameter is mandatory, then it must be present

O

optional

If a parameter is optional, then it can be present, but it is not required

C

conditional

If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional


Notice: Please note that the names of parameters can be returned in upper or lower case.


Changing Subscriptions

Calling the interface

The Computop Paygate can manage your subscriptions and make regular payments for you. The automatic creation of a subscription is possible only in conjunction with credit card payment.

In order to change an existing subscription via a server-to-server connection, go to the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

AboID

ans..32

M

ID assigned by Paygate for the subscription

Amount

n..12

O

Amount in the smallest currency unit (e.g. EUR Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

OrderDesc

ans..768

O

Description of purchased goods, unit prices etc.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

AboAction

a..10

M

Action. Always <Update> when changing

StartDate

n8

M

Start date of instalment payment in the format YYYYMMDD

EndDate

n8

M

Start date of instalment payment in the format YYYYMMDD

Interval

n..3

M

Interval to the next subscription payment in days: 1=daily, 7=weekly, 30=monthly, 90=quarterly, 180=bi-annually, 360=annually

Active

a..5

O

The value <true> activates the subscription. The value <false> deactivates the subscription.

Parameters for changing subscription via socket connections


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

AboID

ans..32

M

ID assigned by Paygate for the subscription

Status

a..50

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes Excel file (part of the software client from https://www.computop.com/us/downloads/)

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

Response parameters for changing subscription via socket connections

  • No labels