About Riverty
General information about Riverty
Logo |
|
Info | Riverty offers purchase on account after delivery. Buyers can pay for articles by invoice, direct debit or installment. There is no risk of fraud or payment default for the merchant. After a credit check, Riverty assumes the entire end customer payment default risk for each transaction. |
Type |
Further information can be found on the website of Riverty (https://www.riverty.com/en/).
Process Flow Chart
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.
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:
MerchantID_REST
PARAMETER TransID_request_REST
PARAMETER RefNr_request_REST
PARAMETER PayID_REST
PARAMETER InvoiceNr_REST
Amount_REST
Currency_REST
MAC_REST
PARAMETER EventToken_REST
PARAMETER AddrCountryCode_REST
PARAMETER Order_REST
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
MID_REST
PayID_REST
XID_REST
PARAMETER TransID_REST
PARAMETER RefNr_REST
Status_REST
Description_REST
Code_REST
UserData_REST
PARAMETER CodeExt_REST
PARAMETER ErrorText_REST
PARAMETER AllowedPayMethods_REST
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:
MerchantID_REST
PayID_REST
PARAMETER TransID_REST AS ABOVE
PARAMETER RefNr_REST AS ABOVE
Amount_REST
Currency_REST
MAC_REST
PARAMETER PayType_REST
PARAMETER bdCompanyOrPerson_REST
PARAMETER SocialSecurityNumber_REST
PARAMETER LegalForm_REST
PARAMETER AddrCountryCode_step2_REST
PARAMETER AddrZip_REST
PARAMETER AddrStreet_REST
PARAMETER AddrStreetNr_REST
PARAMETER AddrStreetNr2_REST
PARAMETER AddrCity_REST
PARAMETER careOf_REST
PARAMETER FirstName_REST
PARAMETER LastName_REST
PARAMETER CustomerID_REST
PARAMETER Salutation_REST
PARAMETER bdEmail_REST
PARAMETER bdPhone_REST
PARAMETER bdMobileNo_REST
PARAMETER DateOfBirth_REST
PARAMETER bdCompany_REST
PARAMETER VatID_REST
PARAMETER CustomerRisk_REST
PARAMETER Language_REST
PARAMETER CompanyOrPerson_REST
PARAMETER sdCountryCode_REST
PARAMETER sdZip_REST
PARAMETER sdStreet_REST
PARAMETER sdStreetNr_REST
PARAMETER sdStreetNr2_REST
PARAMETER sdCity_REST
PARAMETER sdcareOf_REST
PARAMETER ShippingMethod_REST
PARAMETER sdFirstName_REST
PARAMETER sdLastName_REST
PARAMETER sdSalutation_REST
PARAMETER Email_REST
PARAMETER Phone_REST
PARAMETER MobileNo_REST
PARAMETER sdCompany_REST
PARAMETER BIC_REST
PARAMETER IBAN_REST
PARAMETER ProductNr_REST
PARAMETER InvoiceDate_REST
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
MID_REST
PayID_REST
XID_REST
PARAMETER TransID_REST AS ABOVE
PARAMETER RefNr_REST AS ABOVE
PARAMETER Status_REST
Description_REST
Code_REST
UserData_REST
PARAMETER CodeExt_REST AS ABOVE
PARAMETER ErrorText_REST AS ABOVE
PARAMETER BillingAddress_REST
PARAMETER ShippingAddress_REST
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:
MerchantID_REST
PARAMETER TransID_REST AS ABOVE
PARAMETER RefNr_REST AS ABOVE
Amount_REST
Currency_REST
MAC_REST
PARAMETER PayType_onestage_REST
PARAMETER BIC_REST AS ABOVE
PARAMETER IBAN_REST AS ABOVE
PARAMETER bdCompanyOrPerson_onestage_REST
PARAMETER SocialSecurityNumber_REST AS ABOVE
PARAMETER LegalForm_REST AS ABOVE
PARAMETER AddrCountryCode_REST AS ABOVE
PARAMETER AddrZip_REST AS ABOVE
PARAMETER AddrStreet_REST AS ABOVE
PARAMETER AddrStreetNr_REST AS ABOVE
PARAMETER AddrStreetNr2_REST AS ABOVE
PARAMETER AddrCity_REST AS ABOVE
PARAMETER careOf_REST AS ABOVE
PARAMETER FirstName_REST AS ABOVE
PARAMETER LastName_REST AS ABOVE
PARAMETER CustomerID_REST AS ABOVE
PARAMETER Salutation_REST AS ABOVE
PARAMETER bdEmail_REST AS ABOVE
PARAMETER bdPhone_REST AS ABOVE
PARAMETER bdMobileNo_REST AS ABOVE
PARAMETER DateOfBirth_REST AS ABOVE
PARAMETER bdCompany_onestage_REST
PARAMETER VatID_REST AS ABOVE
PARAMETER CustomerRisk_REST AS ABOVE
PARAMETER Language_REST AS ABOVE
PARAMETER CompanyOrPerson_REST AS ABOVE
PARAMETER sdCountryCode_REST AS ABOVE
PARAMETER sdZip_REST AS ABOVE
PARAMETER sdStreet_REST AS ABOVE
PARAMETER sdStreetNr_REST AS ABOVE
PARAMETER sdStreetNr2_REST AS ABOVE
PARAMETER sdCity_REST AS ABOVE
PARAMETER sdcareOf_REST AS ABOVE
PARAMETER ShippingMethod_REST AS ABOVE
PARAMETER sdFirstName_REST AS ABOVE
PARAMETER sdLastName_REST AS ABOVE
PARAMETER sdSalutation_REST AS ABOVE
PARAMETER Email_REST AS ABOVE
PARAMETER Phone_REST AS ABOVE
PARAMETER MobileNo_REST AS ABOVE
PARAMETER sdCompany_REST AS ABOVE
PARAMETER Order_REST
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
MID_REST
PayID_REST
XID_REST
PARAMETER TransID_REST AS ABOVE
PARAMETER RefNr_REST AS ABOVE
Status_OK_FAILED_REST
Description_REST
Code_REST
UserData_REST
PARAMETER CodeExt_REST AS ABOVE
PARAMETER ErrorText_REST AS ABOVE
PARAMETER BillingAddress_REST AS ABOVE
PARAMETER ShippingAddress_REST AS ABOVE
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:
MechantID_REST
PayID_Capture_REST
PARAMETER TransID_REST AS ABOVE
PARAMETER RefNr_REST AS ABOVE
Amount_REST
Currency_REST
MAC_REST
PARAMETER OrderDesc_REST
ReqId-ans..32_REST
UserData_REST
PARAMETER Order_capture_REST
PARAMETER InvoiceNr_capture_REST
PARAMETER ShippingData_REST
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
MID_REST
PayID_REST
XID_REST
PARAMETER TransID_REST AS ABOVE
PARAMETER RefNr_REST AS ABOVE
PARAMETER Status_capture_REST
Description_REST
Code_REST
UserData_REST
PARAMETER InvoiceNumber_REST
PARAMETER CodeExt_REST AS ABOVE
PARAMETER ErrorText_REST AS ABOVE
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:
MerchantID_REST
PayID_Credit_REST
PARAMETER TransID_REST AS ABOVE
PARAMETER RefNr_REST AS ABOVE
Amount_REST
Currency_REST
MAC_REST
PARAMETER OrderDesc_REST AS ABOVE
UserData_REST
ReqId-ans..32_REST
PARAMETER Order_credit_REST
PARAMETER InvoiceNr_credit_REST
PARAMETER RefundType_REST
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
MID_REST
PayID_REST
XID_REST
PARAMETER TransID_REST AS ABOVE
PARAMETER RefNr_REST AS ABOVE
Status_OK_FAILED_REST
Description_REST
Code_REST
UserData_REST
PARAMETER CodeExt_REST AS ABOVE
PARAMETER ErrorText_REST AS ABOVE
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:
MerchantID_REST
PayID_Reverse_REST
PARAMETER TransID_REST AS ABOVE
Amount_REST
Currency_REST
MAC_REST
UserData_REST
ReqId-ans..32_REST
PARAMETER Order_reverse_REST
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
MID_REST
PayID_REST
XID_REST
PARAMETER TransID_REST AS ABOVE
Amount_REST
Currency_REST
Status_OK_FAILED_REST
Description_REST
Code_REST
UserData_REST
PARAMETER CodeExt_REST AS ABOVE
PARAMETER ErrorText_REST AS ABOVE
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:
Action | Version | Description |
Capture | 1.0 / 2.0 | Standard version without return of parameter Code |
1.x / 2.x | with RefNr (valid for all versions other than 1.0) | |
Credit | 1.0 / 2.0 | Standard version without return of parameter Code |
1.x / 2.x | with RefNr (valid for all versions other than 1.0) | |
Reverse | 1.0 / 2.0 | Standard version without return of parameter Code |
1.x / 2.x | with RefNr (valid for all versions other than 1.0) |
Description of the possible batch versions
The structure for a Riverty payment in a Batch file to be submitted is as follows:
CODEBLOCK batch_structure
Example for Master MID function:
CODEBLOCK batch_MasterMid
The following table describes the individual fields and values used within the data set (record) in the batch file:
PARAMETER Type
PARAMETER Action
Amount
Currency
PARAMETER TransID
PARAMETER RefNr
PayID_Batch
Description of fields within the record for Batch files
The record area within the response file for Batch transactions looks as follows:
CODEBLOCK batch_structure_response
The following table describes the response parameters which the Batch Manager saves in the Record area for each transaction (standard parameters not explained here, such as <TransID> or <RefNR> and request parameters are returned unchanged and correspond to the call as specified before):
PARAMETER Action AS ABOVE
PayID_Batch
Status_OK_FAILED
Code
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:
https://wiki.selfhtml.org/wiki/JavaScript/JSON
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.
PARAMETER CustomerRisk_existingCustomer
PARAMETER CustomerRisk_verifiedCustomerIdentification
PARAMETER CustomerRisk_marketingOptIn
PARAMETER CustomerRisk_customerSince
PARAMETER CustomerRisk_customerClassification
PARAMETER CustomerRisk_acquisitionChannel
PARAMETER CustomerRisk_hasCustomerCard
PARAMETER CustomerRisk_customerCardSince
PARAMETER CustomerRisk_customerCardClassification
PARAMETER CustomerRisk_profileTrackingId
PARAMETER CustomerRisk_ipAddress
PARAMETER CustomerRisk_numberOfTransactions
PARAMETER CustomerRisk_customerIndividualScore
PARAMETER CustomerRisk_userAgent
PARAMETER CustomerRisk_amountOfTransactions
PARAMETER CustomerRisk_otherPaymentMethods
Example CustomerRisk as JSON string
CODEBLOCK JSON_CustomerRisk_example
Order
The order information is defined here.
PARAMETER Order_totalGrossAmount
PARAMETER Order_currency
PARAMETER Order_risk
PARAMETER Order_items
PARAMETER Order_totalNetAmount
PARAMETER Order_imageUrl
OrderRisk
The order risk information is defined here.
PARAMETER OrderRisk_channelType
PARAMETER OrderRisk_deliveryType
PARAMETER OrderRisk_ticketDeliveryMethod
OrderItem
The order information is defined here.
PARAMETER OrderItem_productId
PARAMETER OrderItem_description
PARAMETER OrderItem_type
PARAMETER OrderItem_quantity
PARAMETER OrderItem_grossUnitPrice
PARAMETER OrderItem_grouId
PARAMETER OrderItem_netUnitPrice
PARAMETER OrderItem_unitCode
PARAMETER OrderItem_vatCategory
PARAMETER OrderItem_vatPercent
PARAMETER OrderItem_vatAmount
PARAMETER OrderItem_imageUrl
PARAMETER OrderItem_googleProductCategoryId
PARAMETER OrderItem_googleProductCategory
PARAMETER OrderItem_merchantProductType
PARAMETER OrderItem_lineNumber
PARAMETER OrderItem_discountAmount
PARAMETER OrderItem_productUrl
PARAMETER OrderItem_marketPlaceSellerId
Example of Order as JSON string
CODEBLOCK JSON_Order_example
AllowedPayMethods
The information about the allowed payment types is defined here in an array.
PaymentMethod
The article information is defined here.
PARAMETER PaymentMethod_type
PARAMETER PaymentMethod_account
PARAMETER PaymentMethod_directDebit
PARAMETER PaymentMethod_campaigns
PARAMETER PaymentMethod_Installment
PARAMETER PaymentMethod_legalInfo
AccountProduct
The AccountProduct information is defined here.
PARAMETER AccountProduct_profileNo
DirectDebitInfo
The DirectDebitInfo information is defined here.
PARAMETER DirectDebitInfo_Available
CampaignInfo
The CampaignInfo information is defined here.
PARAMETER CampaignInfo_campaignNo
PARAMETER CampaignInfo_description
InstallmentInfo
The InstallmentInfo information is defined here.
PARAMETER InstallmentInfo_basketAmount
PARAMETER InstallmentInfo_numberOfInstallments
PARAMETER InstallmentInfo_installmentAmount
PARAMETER InstallmentInfo_firstInstallmentAmount
PARAMETER InstallmentInfo_lastInstallmentAmount
PARAMETER InstallmentInfo_interestRate
PARAMETER InstallmentInfo_effectiveInterestRate
PARAMETER InstallmentInfo_effectiveAnnualPercentageRate
PARAMETER InstallmentInfo_totalInterestAmount
PARAMETER InstallmentInfo_startupFee
PARAMETER InstallmentInfo_monthlyFee
PARAMETER InstallmentInfo_totalAmount
PARAMETER InstallmentInfo_installmentProfileNumber
PARAMETER InstallmentInfo_readMore
LegalInfo
The LegalInfo information is defined here.
PARAMETER LegalInfo_requiresCustomerConsent
PARAMETER LegalInfo_termsAndConditionsUrl
PARAMETER LegalInfo_privacyStatementUrl
PARAMETER LegalInfo_bgb507Url
PARAMETER LegalInfo_text
Example of AllowedPaymentMethods as JSON string
CODEBLOCK JSON_AllowedPaymentMethods_example
Address
The information about corrected billing address data is defined here in an array if necessary.
PARAMETER Address_countryCode
PARAMETER Address_postalCode
PARAMETER Address_postalPlace
PARAMETER Address_Street
PARAMETER Address_streetNumber
PARAMETER Address_streetNumberAdditional
PARAMETER Address_careOf
Example of Address as JSON string
CODEBLOCK JSON_Address_example
OrderSummary
The OrderSummary information is defined here.
PARAMETER OrderSummary_totalGrossAmount
PARAMETER OrderSummary_currency
PARAMETER OrderSummary_items
PARAMETER OrderSummary_totalNetAmount
PARAMETER OrderSummary_imageUrl
PARAMETER OrderSummary_googleAnalyticsUserId
PARAMETER OrderSummary_googleAnalyticsClientId
PARAMETER OrderSummary_discountAmount
Example of OrderSummary as JSON string
CODEBLOCK JSON_OrderSummary_example
ShippingData
The information about dispatch is defined here in an array.
PARAMETER ShippingData_shippingDetails
ShippingDetails
The ShippingDetails information is defined here.
PARAMETER ShippingDetails_type
PARAMETER ShippingDetails_shippingCompany
PARAMETER ShippingDetails_trackingId
Example of ShippingData as JSON string
CODEBLOCK JSON_ShippingData_example
RefundOrder
The information about the articles to be credited is defined here.
PARAMETER RefundOrder_orderItems
RefundOrderItem
The RefundOrderItem information is defined here.
PARAMETER RefundOrderItem_refundType
PARAMETER RefundOrderItem_productId
PARAMETER RefundOrderItem_description
PARAMETER RefundOrderItem_quantity
PARAMETER RefundOrderItem_grossUnitPrice
PARAMETER RefundOrderItem_groupId
PARAMETER RefundOrderItem_netUnitPrice
PARAMETER RefundOrderItem_unitCode
PARAMETER RefundOrderItem_vatCategory
PARAMETER RefundOrderItem_vatPercent
PARAMETER RefundOrderItem_vatAmount
PARAMETER RefundOrderItem_imageUrl
PARAMETER RefundOrderItem_googleProductCategoryId
PARAMETER RefundOrderItem_googleProductCategory
PARAMETER RefundOrderItem_merchantProductType
PARAMETER RefundOrderItem_lineNumber
PARAMETER RefundOrderItem_discountAmount
PARAMETER RefundOrderItem_productUrl
PARAMETER RefundOrderItem_marketPlaceSellerId
Example of RefundOrder as JSON string
CODEBLOCK JSON_RefundOrder_example