Integration Guide |
Version 6.9 |
As of 01.09.2019 |
Contents
Document history
Date | Name | Change |
|---|---|---|
01.09.2019 | Peter Posse | Original version |
Payment platform interface
Status inquiries via socket connections
Status inquiries based on PayID
Status inquiries within Payment platform 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:
Notice: For security reasons, Payment platform 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 | ID of merchant. Additionally this parameter has to be passed in plain language too. |
PayID | an32 | M | ID for identifying a transaction given by Payment platform |
TransID | ans..64 | M | TransactionID which should be unique for each payment |
Parameters for status inquiries via socket connections
The following table describes the Payment platform response parameters:
Parameter | Format | CND | Description | |
|---|---|---|---|---|
MID | ans..30 | M | ID of merchant | |
PayID | an32 | M | ID assigned by Payment platform for the payment, e.g. for referencing in batch files. | |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Payment platform | |
TransID | ans..64 | M | Merchant’s transaction number | |
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 Payment platform Response Codes Excel file | |
AmountAuth | n..10 | O | Approved amount | |
AmountCap | n..10 | O | Captured amount | |
AmountCred | n..10 | O | Credited amount | |
LastStatus | a..50 | O | Status 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.
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:
Notice: For security reasons, Payment platform 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 | ID of merchant. Additionally this parameter has to be passed in plain language too. |
TransID | ans..64 | M | TransactionID which should be unique for each payment |
Parameters for status inquiries via socket connections
The following table describes the Payment platform response parameters:
Parameter | Format | CND | Description |
|---|---|---|---|
MID | ans..30 | M | ID of merchant |
PayID | an32 | M | ID assigned by Payment platform for the payment, e.g. for referencing in batch files |
XID | an32 | M | ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Payment platform |
TransID | ans..64 | M | Merchant’s transaction number |
Status | a..50 | M | OK or FAILED as status of inquiry and not of the requested transaction |
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 of inquiry not of the requested transaction according to Paygate Response Codes Excel file |
AmountAuth | n..10 | O | Approved amount |
AmountCap | n..10 | O | Captured amount |
AmountCred | n..10 | O | Credited amount |
LastStatus | a..50 | O | Status of last transaction (Authorisation, Capture or Credit) |
LastXCode | n8 | O | Error code of last transaction according to Payment platform Response Codes Excel file |
LastXAmount | n..10 | O | Amount in the smallest currency unit (e.g. EUR Cent) |
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.