Paygate interface
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) Abbreviation Description CND condition M mandatory O optional C conditional Notice: Please note that the names of parameters can be returned in upper or lower case.Definitions
Data formats
Abbreviations
Comment If a parameter is mandatory, then it must be present If a parameter is optional, then it can be present, but it is not required If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional
Query about available payment types (two-stage authorisation)
Riverty differentiates between one-stage and two-stage authorisation. One-stage authorisation is designed for merchants who only use the normal method of payment by invoice in their checkout. Two-stage authorisation permits, for a specific shopping basket, a query of the available payment types and a request for further information.
In order to process two-stage authorisation with Riverty via server-to-server communication, please use the following URL:
https://www.computop-paygate.com/afterpay.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:
Parameters for payments with Riverty
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
Result parameters for Riverty
The second stage involves the transfer of the customer and order data as well as payment type and, if relevant, further information relating to the payment type.
The second stage is triggered by using the following URL:
https://www.computop-paygate.com/afterpay.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:
Parameters for Riverty
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
Result parameters for Riverty
Calling the interface for one-stage authorisation
To process one-stage authorisation with Riverty, please use the following URL:
https://www.computop-paygate.com/afterpay.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:
Parameters for payments with Riverty
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
Result parameters for Riverty
Capture
Captures are possible via a Server-to-Server connection. To carry out a Capture for Riverty via a Server-to-Server connection, please use the following URL:
https://www.computop-paygate.com/capture.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:
Parameters for Riverty captures
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
Result parameters for Riverty captures
Credit with reference
Credits (refunds) are possible via a Server-to-Server connection. For a Credit with reference to a capture the amount of the Credit is limited to the amount of the previous capture. To carry out a credit with a reference transaction, please use the following URL:
https://www.computop-paygate.com/credit.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:
Parameters for credits of Riverty payments
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
Result parameters for credits of Riverty payments
Reverse
Reversals are possible via a Server-to-Server connection. In order to reverse an Riverty transaction, please use the following URL:
https://www.computop-paygate.com/reverse.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:
Parameters for reversals of Riverty payments
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
Result parameters for reversals of Riverty payments
Batch processing via the interface
Basic information about using Batch files and about their structure can be found in the Batch Manager manual. Within batch processing not alle functions are available which are usually available for the online interface.
This section describes the parameters which must be transferred within the data set (Record) for executing a Riverty payment and information can be found within the response file about the payment status.
Notice: Please note that partial captures, partial credits and partial reversals for Riverty are not possible with batch.
Following table gives an overview of all batch versions that are possible for a specific action and their specialities:
Description of the possible batch versions
The structure for a Riverty payment in a Batch file to be submitted is as follows:
HEAD,<MerchantID>,<Date>,<Version> AFTERPAY,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> AFTERPAY,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> AFTERPAY,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID> FOOT,<CountRecords>,<SumAmount>
Example for Master MID function:
HEAD,[Master]MerchantID,Date,2.x Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action) FOOT,CountRecords,SumAmount
The following table describes the individual fields and values used within the data set (record) in the batch file:
Description of fields within the record for Batch files
Â
The record area within the response file for Batch transactions looks as follows:
HEAD,<MerchantID>,<Date>,<Version> AFTERPAY,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> AFTERPAY,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> AFTERPAY,Reverse,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code> FOOT,<CountRecords>,<SumAmount>
The following table describes the individual fields and values used within the data set (record) in the batch file:
Description of result parameters within the record for Batch files
JSON Objects
The JavaScript Object Notation, JSON for short, is a compact data format in an easy-to-read text format for the purpose of exchanging data between applications. JSON does not depend on the programming language. Parsers exist in practically all widely used languages. You can find more information about JSON via this link:
Â
The next section describes JSON objects which are required for requests or returned in the response.
Notice: The JSON string can include special characters and so must also be Base64 encoded. Transfer problems may otherwise occur.
CustomerRisk
Risk-relevant data about the customer. Merchants can conduct external risk checks and send this information to Riverty.
Example CustomerRisk as JSON string
{ "existingCustomer" : true, "verifiedCustomerIdentification" : "true", "marketingOptIn" : "false", "customerSince" : "2015-11-20", "customerClassification" : "Classification", "acquisitionChannel" : “SearchEngine”, "hasCustomerCard" : true, "customerCardSince" : "2016-01-23", "customerCardClassification" : "Gold Member", "profileTrackingId" : "TrackingID123456", "ipAddress" : "201.18.14.2", "numberOfTransactions" : 27, "customerIndividualScore" : 98, "userAgent" : "", "amountOfTransactions" : 1, "otherPaymentMethods" : true }
Order
The order information is defined here.
OrderRisk
The order risk information is defined here.
OrderItem
The order information is defined here.
Example of Order as JSON string
{ "totalGrossAmount" : 12.40, "totalNetAmount" : 10.43, "currency" : "EUR", "risk" : { "channelType" : "Catalog", "deliveryType" : "Normal", "ticketDeliveryMethod" : "NotSet" }, "items" : [{ "productId" : "1", "description" : "Tablet Black", "type" : "PhysicalArticle", "grossUnitPrice" : 4.10, "netUnitPrice" : 3.45, "quantity" : 2.0, "vatAmount" : 0.65, "vatPercent" : 19.0 }, { "productId" : "2", "description" : "MusicPlayer Black", "type" : "PhysicalArticle", "grossUnitPrice" : 4.20, "netUnitPrice" : 3.53, "quantity" : 1.0, "vatAmount" : 0.67, "vatPercent" : 19.0 } ] }
AllowedPayMethods
The information about the allowed payment types is defined here in an array.
PaymentMethod
The article information is defined here.
AccountProduct
The AccountProduct information is defined here.
DirectDebitInfo
The DirectDebitInfo information is defined here.
CampaignInfo
The CampaignInfo information is defined here.
InstallmentInfo
The InstallmentInfo information is defined here.
Example of AllowedPaymentMethods as JSON string
"paymentMethods": [{ "type": "string", "title": "string", "tag": "string", "consumerFeeAmount": 1.00, "logo": "string", "account": { ... } , "directDebit": {"available": true}, "campaigns": { ... }, "installment": { "basketAmount": 1.00, "numberOfInstallments": 1, "installmentAmount": 1.00, "firstInstallmentAmount": 1.00, "lastInstallmentAmount": 1.00, "interestRate": 1.00, "effectiveInterestRate": 1.00, "effectiveAnnualPercentageRate": 1.00, "totalInterestAmount": 1.00, "startupFee": 1.00, "monthlyFee": 1.00, "totalAmount": 1.00, "installmentProfileNumber": 1, "readMore": "string" }, "legalInfo": { "requiresCustomerConsent": true, "termsAndConditionsUrl": "string", "privacyStatementUrl": "string", "bgb507Url": "string", "text": "string" }, }]
Address
The information about corrected billing address data is defined here in an array if necessary.
Example of Address as JSON string
{ [{ "countryCode" : "DE", "postalCode" : "10405", "street" : "Prenzlauer Allee", "streetNumber" : 20 "streetNumberAdditional" : "3. Stock", "postalPlace" : "Berlin", "addressType" : null, "careOf" : null } ] }
OrderSummary
The OrderSummary information is defined here.
Example of OrderSummary as JSON string
{ "totalGrossAmount" : 8.30, "currency" : "EUR", "items" : [{ "productId" : "1", "description" : "Tablet Black", "grossUnitPrice" : 4.10, "quantity" : 1.0 }, { "productId" : "2", "description" : "MusicPlayer Black", "grossUnitPrice" : 4.20, "quantity" : 1.0 } ] }
ShippingData
The information about dispatch is defined here in an array.
ShippingDetails
The ShippingDetails information is defined here.
Example of ShippingData as JSON string
{ "shippingDetails" : [{ "type" : "Shipment", "shippingCompany" : "DHL", "trackingId" : "234324234" }, { "type" : "Shipment", "shippingCompany" : "Hermes", "trackingId" : "687654" } ] }
RefundOrder
The information about the articles to be credited is defined here.
RefundOrderItem
The RefundOrderItem information is defined here.
Example of RefundOrder as JSON string
[ { "refundType" : "Return", "productId" : "1", "description" : "Tablet Black", "quantity" : 1.0, "grossUnitPrice" : 4.10, "netUnitPrice" : 3.45, "vatPercent" : 19.0, "vatAmount" : 0.65 } , { "refundType" : "Return", "productId" : "2", "description" : "MusicPlayer Black", "quantity" : 1.0, "grossUnitPrice" : 4.20, "netUnitPrice" : 3.53, "vatPercent" : 19.0, "vatAmount" : 0.67 } ]