Introduction

The idea of Paygate is to store customer data like credit card data, billing / shipping address in a secure way within Paygate and to re-use these data based on CustomerId.

The Customer Data Storage (CDS) refers to a Scope which can be used to share the same CDS data with multiple of your MerchantIds.

After Customer Data Storage has been activated for your MerchantId within Paygate:

  • initial usage / consumer has no data stored yet
    • you can send CustomerId in Paygate-request
    • the consumer will be asked on Hosted Payment Page / Credit Card Form (PaySSL) whether the payment data should be stored
    • payment request is completed
    • and you will be notified for updates on Customer Data Storage
  • subsequent usage / consumer has already data stored
    • you still send CustomerId in Paygate-request
    • the credit card data will be prefilled Hosted Payment Page / Credit Card Form (PaySSL)
    • the consumer needs to add CVC, only - as CVC must not be stored at any time
    • payment request is completed

(info)  Currently storage of credit card data is supported, only. Support for other payment data and other consumer data may be added in a later stage.


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.


Notifications on Customer Data Storage updates

With activation of Customer Data Storage (CDS) by Computop Helpdesk you will need to provide a URL to receive notifications for CDS updates. The data will be sent as POST-request and data are part of request-body.

Notifications for CDS-updates are not encrypted, because they do not contain sensitive data.

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

 

Key

Format

CND

Description

Beschreibung

CustomerReferenceId

an..32

M

Unique ID assigned by Paygate for the customer data.


TypeenumM

Type of data referenced in Customer Data Storage (CDS)

TypeDescription
CreditCard Credit card data are referenced

ActionenumM

Action in Customer Data Storage (CDS)

ActionDescription
Create A new CDS record has been created
DeleteAn existing CDS record has been deleted by consumer via payment form

Customer Data Storage (CDS) inquiries

CDS request

CDS inquiries within Paygate return stored CDS data for a given CustomerId or CustomerReferenceId. 

 

Notice: For security reasons, Computop 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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyRESTFormatCNDDescriptionBeschreibung

MerchantID

BasicAuth.Username

ans..30

M

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

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

KeyRESTFormatCNDDescriptionBeschreibung
TransID"transactionId": "..."

ans..64

MTransactionID provided by you which should be unique for each paymentIhre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Key

REST

Format

CND

Description

Beschreibung

EventToken

tbd

enum

M

TypeDescription
GetDetailsReturn CDS details


CustomerIdtbdan 1..64M

Reference CDS data by CustomerId

allowed characters: A-Z,a-z,0-9, minus, underscore

(either CustomerId or CustomerReferenceId must be used)


CustomerReferenceIdtbdan32M

Reference CDS data by CustomerReferenceId

(either CustomerId or CustomerReferenceId must be used)


Actiontbdan..30M

Action in Customer Data Storage (CDS)

ActionDescription
Create A new CDS record has been created
DeleteAn existing CDS record has been deleted by consumer via payment form

Parameters for CDS inquiries via socket connections

 

CDS response

The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

 

Key

REST

Format

CND

Description

Beschreibung

Status

tbd

a..50

M

OK or FAILED as status of inquiry and not of the requested transaction

OK oder FAILED als Status der Abfrage, nicht der angefragten Transaktion
Codetbdn8M

Error code according to Paygate Response Codes (A4 Error codes).

If CustomerId/CustomerReferenceId is not found Code=23341536 will be returned.

Fehlercode gemäß Paygate Antwort-Codes (A4 Fehlercodes). Bezieht sich auf die Abfrage und nicht auf die angefragte Transaktion.

CustomerId

tbdan 1..64OCustomerId of CDS record
 

CustomerReferenceId

tbdan32OCustomerReferenceId of CDS record 

CustomerInfos

tbd, JSON
OBase64 encoded string containing JSON structure with CDS data
 

Response parameters in the case of CDS inquiries via socket connections

CDS details (Type: CreditCard)

{
  "CustomerReferenceId": "5912cfe4abbb453499120bf71f85be6f",
  "CustomerId": "123123",
  "MID": "Your_MerchantId",
  "Scope": "Your_Scope",
  "Created": "2023-12-21T12:10:58.087",
  "Changed": "2023-12-21T12:10:58.087",
  "CustomerDataInfos": [
    {
      "CCNrMasked": "411111xxxxxx1111",
      "Expiry": "202701",
      "Holder": "John Doe",
      "Brand": "VISA",
      "PCNr": "0605262127687111",
      "Type": "CreditCard",
      "CustomerDataId": "9de5132163cf4c838ffd7695e2d6b542",
      "CustomerReferenceId": "5912cfe4abbb453499120bf71f85be6f",
      "Scope": "Your_Scope",
      "Active": true,
      "LastUsed": "2023-12-21T12:10:58.087",
      "Created": "2023-12-21T12:10:58.087",
      "Changed": "2023-12-21T12:10:58.087"
    }
  ]
}