• DeutschEnglish

Customer Data Storage

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 on 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

We can setup a notification URL provided by you. For each change of the Customer Data Storage (CDS) Data you will get a notification message containing the CustomerReferenceId. This can then be used to request these data from CDS.

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.

Sequence Diagram

The Customer Data Storage is addressed via CustomerId and is embedded into Paygate payment processing.

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 an 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.

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

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

Key

Format

CND

Description

CustomerReferenceId

an..32

M

Unique ID assigned by Paygate for the customer data

Type

enum

M

Type of data referenced in Customer Data Storage (CDS)

Type

Description

CreditCard

Credit card data are referenced

Action

enum

M

Action in Customer Data Storage (CDS)

Action

Description

Create

A new Customer Data Storage record has been created

Delete

An existing Customer Data Storage record has been deleted by consumer via payment form

Customer Data Storage (CDS) inquiries – GetDetails

CDS request

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

https://www.computop-paygate.com/customer.aspx

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:

Key

REST

Format

CND

Description

MerchantID

BasicAuth.Username

ans..30

M

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

EventToken

tbd

enum

M

Type

Description

GetDetails

Return CDS details

CustomerId

tbd

an1..64

C

Reference Customer Data Storage data by CustomerId

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

(either CustomerId or CustomerReferenceId must be used)

CustomerReferenceId

tbd

an32

C

Reference Customer Data Storage data by CustomerReferenceId

(either CustomerId or CustomerReferenceId must be used)

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

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

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

Key

REST

Format

CND

Description

Status

tbd

a..50

M

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

Code

tbd

n8

M

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

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

CustomerId

tbd

an1..64

O

CustomerId of Customer Data Storage record

CustomerReferenceId

tbd

an32

O

CustomerReferenceId of Customer Data Storage record

CustomerInfos

tbd

JSON

O

Base64 encoded string containing JSON structure with CDS data

Response parameters in the case of CDS inquiries via socket connections

CustomerInfos details (Type: CreditCard), Base64 decoded

1
{
2
"CustomerReferenceId": "5912cfe4abbb453499120bf71f85be6f",
3
"CustomerId": "123123",
4
"MID": "Your_MerchantId",
5
"Scope": "Your_Scope",
6
"Created": "2023-12-21T12:10:58.087",
7
"Changed": "2023-12-21T12:10:58.087",
8
"CustomerDataInfos": [
9
{
10
"CCNrMasked": "411111xxxxxx1111",
11
"Expiry": "202701",
12
"Holder": "John Doe",
13
"Brand": "VISA",
14
"PCNr": "0605262127687111",
15
"Type": "CreditCard",
16
"CustomerDataId": "9de5132163cf4c838ffd7695e2d6b542",
17
"CustomerReferenceId": "5912cfe4abbb453499120bf71f85be6f",
18
"Scope": "Your_Scope",
19
"Active": true,
20
"LastUsed": "2023-12-21T12:10:58.087",
21
"Created": "2023-12-21T12:10:58.087",
22
"Changed": "2023-12-21T12:10:58.087"
23
}
24
]
25
}

CDS GetDetails request / response, sample

1
Plain Request Data before encryption:
2
MerchantId=Your_MerchantId&EventToken=GetDetails&CustomerId=123123
3
4
Request with encrypted Len / Data:
5
customer.aspx?MerchantID=Your_MerchantId&Len=89&Data=fb0f6ee9876fea46a955f793eb3dada7c316aa2a25334716e82c4ca92fe726c818463b88bca2b98b3724e560dcc6bf8528ac66c97ddad557432b9abdd87e598793ed2cd281b3258f4677444a4e0e494e338d3f281f82c0b4a71746e79f191e36
6
7
Response with plain data:
8
Status=OK&Code=00000000&CustomerId=123123&CustomerReferenceId=5912cfe4abbb453499120bf71f85be6f&CustomerInfos=eyJDdXN0b21lclJlZmVyZW5jZUlkIjoiNTkxMmNmZTRhYmJiNDUzNDk5MTIwYmY3MWY4NWJlNmYiLCJDdXN0b21lcklkIjoiMTIzMTIzIiwiTUlEIjoiamtpbGxtZXJfdGVzdCIsIlNjb3BlIjoiamtpbGxtZXJfdGVzdCIsIkNyZWF0ZWQiOiIyMDIzLTEyLTIxVDEyOjEwOjU4LjA4NyIsIkNoYW5nZWQiOiIyMDIzLTEyLTIxVDEyOjEwOjU4LjA4NyIsIkN1c3RvbWVyRGF0YUluZm9zIjpbeyJDQ05yTWFza2VkIjoiNDExMTExeHh4eHh4MTExMSIsIkV4cGlyeSI6IjIwMjQwMSIsIkhvbGRlciI6ImFzIGRhc2QiLCJCcmFuZCI6IlZJU0EiLCJQQ05yIjoiMDYwNTI2MjEyNzY4NzExMSIsIlR5cGUiOiJDcmVkaXRDYXJkIiwiQ3VzdG9tZXJEYXRhSWQiOiI5ZGU1MTMyMTYzY2Y0YzgzOGZmZDc2OTVlMmQ2YjU0MiIsIkN1c3RvbWVyUmVmZXJlbmNlSWQiOiI1OTEyY2ZlNGFiYmI0NTM0OTkxMjBiZjcxZjg1YmU2ZiIsIlNjb3BlIjoiamtpbGxtZXJfdGVzdCIsIkFjdGl2ZSI6dHJ1ZSwiTGFzdFVzZWQiOiIyMDIzLTEyLTIxVDEyOjEwOjU4LjA4NyIsIkNyZWF0ZWQiOiIyMDIzLTEyLTIxVDEyOjEwOjU4LjA4NyIsIkNoYW5nZWQiOiIyMDIzLTEyLTIxVDEyOjEwOjU4LjA4NyJ9XX0=
9
10
CustomerInfos Base64-decoded:
11
{
12
"CustomerReferenceId": "5912cfe4abbb453499120bf71f85be6f",
13
"CustomerId": "123123",
14
"MID": "Your_MerchantId",
15
"Scope": "Your_Scope",
16
"Created": "2023-12-21T12:10:58.087",
17
"Changed": "2023-12-21T12:10:58.087",
18
"CustomerDataInfos": [
19
{
20
"CCNrMasked": "411111xxxxxx1111",
21
"Expiry": "202701",
22
"Holder": "John Doe",
23
"Brand": "VISA",
24
"PCNr": "0605262127687111",
25
"Type": "CreditCard",
26
"CustomerDataId": "9de5132163cf4c838ffd7695e2d6b542",
27
"CustomerReferenceId": "5912cfe4abbb453499120bf71f85be6f",
28
"Scope": "Your_Scope",
29
"Active": true,
30
"LastUsed": "2023-12-21T12:10:58.087",
31
"Created": "2023-12-21T12:10:58.087",
32
"Changed": "2023-12-21T12:10:58.087"
33
}
34
]
35
}

Customer Data Storage (CDS) inquiries – Delete

CDS request

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

https://www.computop-paygate.com/customer.aspx

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:

Key

REST

Format

CND

Description

MerchantID

BasicAuth.Username

ans..30

M

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

EventToken

tbd

enum

M

Type

Description

Delete

Delete CDS details

Type

tbd

enum

M

Type

Description

CreditCard

Delete CreditCard details

CustomerId

tbd

an1..64

C

Reference Customer Data Storage data by CustomerId

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

(either CustomerId or CustomerReferenceId must be used)

CustomerReferenceId

tbd

an32

C

Reference Customer Data Storage data by CustomerReferenceId

(either CustomerId or CustomerReferenceId must be used)

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

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

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

Key

REST

Format

CND

Description

Type

tbd

enum

M

Type

Description

CreditCard

Delete CreditCard details

Status

tbd

a..50

M

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

Code

tbd

n8

M

Error code according to Paygate Response Codes (A4 Error codes).If CustomerId/CustomerReferenceId is not found Code=23341536 will be returned.

CustomerId

tbd

an 1..64

O

CustomerId of Customer Data Storage record

CustomerReferenceId

tbd

an32

O

CustomerReferenceId of Customer Data Storage record

Response parameters in the case of CDS inquiries via socket connections

CDS Delete request / response, sample

1
Plain Request Data before encryption:
2
MerchantId=Your_MerchantId&EventToken=Delete&Type=CreditCard&CustomerId=123123
3
4
Request with encrypted Len / Data:
5
customer.aspx?MerchantID=Your_MerchantId&Len=105&Data=fb0f6ee9876fea46a955f793eb3dada7c316aa2a25334716a536631bea13cce510fb7a1a56e24d876e714ba96978f97319132f7e74107871feb6cda906601cde234084083f75eb4b4fd521f3596430cb5c627b4874101ecabfde860934bbd5da62fc286af93b1c65248
6
7
Response with plain data:
8
CustomerId=123456xxxx&Type=CreditCard&Code=00000000&Description=Deleted&Status=OK

Supported templates

Currently these templates are supporting

  • storing credit card data in Customer Data Storage – if no data are stored for the specific CustomerId yet

  • prefilling

Template names:

  • ct_responsive

  • ct_cards_v1

Samples

Customer enters credit card data initially

  • Customer enters credit card data initially

  • and agrees to store these data for future purchases

COO 6505 1000 13 7411835

COO 6505 1000 14 7411849

COO 6505 1000 11 7411863

Paygate

Documentation (EN)

Dokumentation (DE)

Paygate Status