1 1cs Online Payment System interface

1.1 Definitions

1.1.1 Data formats:

FormatDescription
aalphabetical
asalphabetical with special characters
nnumeric
analphanumeric
ansalphanumeric with special characters
nsnumeric with special characters
boolboolean expression (true oder false)
3fixed length with 3 digits/characters
..3variable length with maximum 3 digits/characters
enumenumeration of allowed values
dttmISODateTime (YYYY-MM-DDThh:mm:ss)

1.1.2 Abbreviations:

AbbreviationDescriptionComment
CNDBedingung (condition) 
MPflicht (mandatory)If a parameter is mandatory, then it must be present
OoptionalIf a parameter is optional, then it can be present, but it is not required
Cbedingt (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.

2 Status inquiries via socket connections

2.1 Status inquiries based on PayID

Status inquiries within the 1cs Online Payment System give detailed information about the amounts that are actually authorized, captured or credited. Especially before executing reversals via the interface reverse.aspx it is recommended to check the transaction status with inquire.aspx, because Reverse.aspx reverses not only authorizations but ALWAYS THE LAST TRANSACTION STEP.

Inquiries of transaction status based on PayID are possible via a Server-to-Server connection. In order to inquire about the status of a transaction via a Server-to-Server connection, please use the following URL:

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

Notice: For security reasons, the 1cs Online Payment System 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:

KeyFormatCNDDescription
MerchantIDans..30MMerchantID, assigned by First Cash Solution. Additionally this parameter has to be passed in plain language too.
PayIDan32MID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request.
TransIDans..64MTransactionID which should be unique for each payment

Parameters for status inquiries via socket connections

The following table describes the result parameters with which the 1cs Online Payment System 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

KeyFormatCNDDescription
MIDans..30MMerchantID, assigned by First Cash Solution
PayIDan32MID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request.
XIDan32MID for all single transactions (authorisation, capture, credit note) for one payment assigned by the 1cs Online Payment System
TransIDans..64MTransactionID provided by you which should be unique for each payment
Statusa..50MOK or FAILED as status of inquiry and not of the requested transaction
Descriptionans..1024MFurther details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Coden8MError code according to the 1cs Online Payment System Response Codes Excel file
AmountAuthn..10OApproved amount
AmountCapn..10OCaptured amount
AmountCredn..10OCredited amount
Currencya3OCurrency code, three digits DIN / ISO 4217. For payment types that don´t have the “Currency” parameter nothing will be returned.
LastStatusa..50OStatus of last transaction (Authorisation, Capture or Credit)

Response parameters in the case of status inquiries via socket connections

Notice: The LastStatus parameter is not sufficient to determine the status because it supplies the status of only the last transaction. For example LastStatus delivers the status Failed if a credit has failed although the previous authorisation and capture were successful. The fields AmountAuth, AmountCap and AmountCred give the precise status.

1.2 Status inquiries based on TransID

Inquiries of transaction status based on TransID are possible via a Server-to-Server connection. In order to inquire about the status of a transaction via a Server-to-Server connection, please use the following URL:

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

Notice: For security reasons, the 1cs Online Payment System 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:

KeyFormatCNDDescription
MerchantIDans..30MMerchantID, assigned by First Cash Solution. Additionally this parameter has to be passed in plain language too.
TransIDans..64MTransactionID which should be unique for each payment

Parameters for status inquiries via socket connections

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

KeyFormatCNDDescription
MIDans..30MMerchantID, assigned by First Cash Solution
PayIDan32MID assigned by the 1cs Online Payment System for the payment, e.g. for referencing in batch files as well as for capture or credit request.
XIDan32MID for all single transactions (authorisation, capture, credit note) for one payment assigned by the 1cs Online Payment System
TransIDans..64MTransactionID provided by you which should be unique for each payment
Statusa..50MOK or FAILED as status of inquiry and not of the requested transaction
Descriptionans..1024MFurther details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Coden8MError code according to Paygate Response Codes (A4 Error codes). It relates to the inquiry and not to the requested transaction.
AmountAuthn..10OApproved amount
AmountCapn..10OCaptured amount
AmountCredn..10OCredited amount
Currencya3OCurrency code, three digits DIN / ISO 4217. For payment types that don´t have the “Currency” parameter nothing will be returned.
LastStatusa..50OStatus of last transaction (Authorisation, Capture or Credit)
LastXCoden8OError code of last transaction according to the 1cs Online Payment System Response Codes Excel file
LastXAmountn..10OAmount in the smallest currency unit (e.g. EUR Cent)
CCBranda..22OCredit card brand (e.g. Visa, MasterCard, Maestro etc.)
Returned only after configuration by Merchant Services (Computop Helpdesk).

Response parameters in the case of status inquiries via socket connections
 

Notice: The LastStatus parameter is not sufficient to determine the status because it supplies the status of only the last transaction. For example LastStatus delivers the status Failed if a credit has failed although the previous authorisation and capture were successful. The fields AmountAuth, AmountCap and AmountCred give the precise status.