About Riverty (AfterPay) SCA

General information about Riverty (AfterPay) SCA

Logo

Info

Riverty (AfterPay) SCA 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

Payments by Invoice and Installments

Further information can be found on the website of Riverty (https://www.riverty.com/en/).

interface

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:

afterpay.aspx

Key	Format	CND	Description
TransID	ans..18	C	TransactionID which should be unique for each payment. The parameter is not required for EventToken="Return".
RefNr	ns..30	C	Unique reference number. The parameter is not required for EventToken="Return".
PayID	an32	C	ID assigned by for the payment in scope of which goods were returned. The parameter is required only for EventToken="Return".
InvoiceNr	ans..30	C	Invoice number that is displayed within Riverty portal. An order can contain more than one invoice. The parameter is required only for EventToken="Return".

Key

Format

CND

Description

EventToken

a..19

M

The two-stage process is triggered by the transfer of "PAYMENTMETHODS".

Value "Return" triggers return notification (merchant notifies Riverty that a customer has returned some goods, and a payment from the customer should not be expected by Riverty).

AddrCountryCode

a2

M

Country code

„NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”

Order

ans..1024

M

Order information as JSON string in Base64 format.

See JSON object: Order

For EventToken="Return", see JSON object RefundOrder

Parameters for payments with Riverty (AfterPay) SCA

Key	Format	CND	Description
TransID	ans..18	M	TransactionID which should be unique for each payment
RefNr	ns..30	O	Unique reference number

Key

Format

CND

Description

CodeExt

n..10

O

Error code from Riverty, if agreed with

ErrorText

ans..1024

O

Error text from Riverty, if agreed with

AllowedPayMethods

ans..1024

O

Permissible payment methods as JSON string in the Base64 format

(see JSON objects: AllowedPayMethods)

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.

To complete the second step, please use the following URL:

afterpaySCA.aspx

Key	Format	CND	Description
TransID	ans..18	M	TransactionID which should be unique for each payment
RefNr	ns..30	O	Unique reference number

Key	Format	CND	Description
PayType	a..19	M	Payment method: "Invoice" for Invoice "Account" for flexible payment plan "Installment" for payment by instalment "ConsolidatedInvoice" for consolidated invoice For Direct Debit option parameter PayType has to be set to "Invoice" and parameter IBAN has to be filled.
bdCompanyOrPerson	a..7	M	Customer category: „Company“ „Person“ (default value)
SocialSecurityNumber	ans..16	C	Required: FI, NO, SE. Optional: AT, BE, CH, DE, DK, NL. Social security number for a person in Sweden. Registration number in case of a company. This parameter is linked to the parameter bdCompanyOrPerson.
LegalForm	ans..50	O	Legal form of company. This parameter is linked to the parameter bdCompanyOrPerson. Possible values: For Germany: AG, AG & Co. KG, eG, EK, e.V., GbR, GmbH, GmbH & Co. KG, KG, OHG, UG For Austria: AG, AG & Co. KG, eG, EK, e.V., GesbR, GmbH, GmbH & Co. KG, KG, OHG, UG For Switzerland: AG, eG, e.V.
AddrCountryCode	a2	O	Country code: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”
AddrZip	ans..10	M	Postcode
AddrStreet	ans..80	M	Street name or packstation
AddrStreetNr	a..50	O	Street number or packstation number
AddrStreetNr2	ans..10	O	Street number addition
AddrCity	ans..100	M	City
careOf	ans..50	O	Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”). This field has to be used for company, authority and organization names as well – e. g. "Sportverein Blau-Weiß e.V."
FirstName	ans..50	M	First name
LastName	ans..50	M	Last name
CustomerID	ans..20	O	Unique customer number
Salutation	a..4	O	Salutation: „Mr“ „Mrs“ „Miss“
bdEmail	ans..100	M	E-mail address
bdPhone	ns..20	O	Telephone number
bdMobileNo	ns..20	M	Mobile number
DateOfBirth	an10	M	Date of birth in the format YYYY-MM-DD. Not applicable to companies.
bdCompany	ans..255	C	Purchasing company name. Required if bdCompanyOrPerson is 'Company'.
VatID	ans..50	C	VAT registration number, the unique number that identifies a business. The field is mandatory for processing B2B transactions for Germany.
CustomerRisk	ans..1024	M	Risk-relevant data as JSON string in Base64 format (see JSON objects: CustomerRisk) Merchants can conduct external risk checks and send this information to Riverty.
Language	a2	O	Language: "NO", "SE", "FI", "DK”, "EN”, "DE”, "NL”, "FR” permitted
CompanyOrPerson	a..7	C	Customer category for delivery address: „Company“ „Person“ (default value) Requred if any of sd-fields (refer below) is provided.
sdCountryCode	a2	O	Country code of the delivery address: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”
sdZip	ans..10	O	Postcode in the delivery address
sdStreet	ans..80	O	Street name or packstation of the delivery address
sdStreetNr	a..50	O	Street number or packstation number of the delivery address
sdStreetNr2	ans..10	O	Street number addition of the delivery address
sdCity	ans..100	O	Town/city of the delivery address
sdcareOf	ans..50	O	Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”). This field has to be used for company, authority and organization names as well – e. g. "Sportverein Blau-Weiß e.V."
ShippingMethod	ans..50	O	Address type. Possible values: "Standard" (default value), "PickUpPoint", "InStore"
sdFirstName	ans..50	O	First name in the delivery address
sdLastName	ans..50	O	Last name in the delivery address
sdSalutation	a..4	O	Salutation in the delivery address „Mr“ „Mrs“ „Miss“ Valid for AddrCountryCode = „DE“, „DK“,“NL“, „BE“, „AT“ or „CH“
Email	ans..100	O	E-mail address of the delivery address
Phone	ns..50	C	Phone number in the delivery address and mandatory request data if the merchant will process the OTP/SCA flow. (currently Riverty support only OTP instead of SCA for DE).
MobileNo	ns..50	C	Mobile number of the delivery address and mandatory request data if the merchant will process the SCA flow.
sdCompany	ans..50	C	Delivery company name. Required if CompanyOrPerson is 'Company'. Everything over 50 characters will be truncated.
BIC	ans..11	O	Bank Identifier Code (valid for AddrCountryCode = “DE”)
IBAN	ans..34	C	International Bank Account Number (valid for AddrCountryCode = “DE”). Please note, that IBAN is mandatory if PayTape=invoice or PayType=installment.
ProductNr	n..8	C	Profile number Obligatory for PayType = "Account" or "Installment"
InvoiceDate	an10	O	Date of invoice in the format YYYY-MM-DD. Only for PayType = "ConsolidatedInvoice"

Parameters for Riverty

Key	Format	CND	Description
TransID	ans..18	M	TransactionID which should be unique for each payment
RefNr	ns..30	O	Unique reference number
Status	a..50	M	AUTHORIZE_REQUEST or FAILED

Key	Format	CND	Description
CodeExt	n..10	O	Error code from Riverty, if agreed with
ErrorText	ans..1024	O	Error text from Riverty, if agreed with
BillingAddress	ans..1024	O	If necessary corrected billing address as JSON string in the Base64 format (see JSON objects: Address)
ShippingAddress	ans..1024	O	If necessary corrected shipping address as JSON string in the Base64 format (see JSON objects: Address)

Result parameters for Riverty

Calling the interface for one-stage authorisation

To process one-stage authorisation with Riverty, please use the following URL:

afterpaySCA.aspx

Key	Format	CND	Description
TransID	ans..18	M	TransactionID which should be unique for each payment
RefNr	ns..30	O	Unique reference number

Key	Format	CND	Description
PayType	a..19	M	Payment method: "Invoice" for Invoice For Direct Debit option parameter PayType has to be set to "Invoice" and parameter IBAN has to be filled.
BIC	ans..11	O	Bank Identifier Code (valid for AddrCountryCode = “DE”)
IBAN	ans..34	C	International Bank Account Number (valid for AddrCountryCode = “DE”). Please note, that IBAN is mandatory if PayTape=invoice or PayType=installment.
bdCompanyOrPerson	a..7	O	Customer category: „Company“ „Person“ (default value)
SocialSecurityNumber	ans..16	C	Required: FI, NO, SE. Optional: AT, BE, CH, DE, DK, NL. Social security number for a person in Sweden. Registration number in case of a company. This parameter is linked to the parameter bdCompanyOrPerson.
LegalForm	ans..50	O	Legal form of company. This parameter is linked to the parameter bdCompanyOrPerson. Possible values: For Germany: AG, AG & Co. KG, eG, EK, e.V., GbR, GmbH, GmbH & Co. KG, KG, OHG, UG For Austria: AG, AG & Co. KG, eG, EK, e.V., GesbR, GmbH, GmbH & Co. KG, KG, OHG, UG For Switzerland: AG, eG, e.V.
AddrCountryCode	a2	O	Country code: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”
AddrZip	ans..10	M	Postcode
AddrStreet	ans..80	M	Street name or packstation
AddrStreetNr	a..50	O	Street number or packstation number
AddrStreetNr2	ans..10	O	Street number addition
AddrCity	ans..100	M	City
careOf	ans..50	O	Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”). This field has to be used for company, authority and organization names as well – e. g. "Sportverein Blau-Weiß e.V."
FirstName	ans..50	M	First name
LastName	ans..50	M	Last name
CustomerID	ans..20	O	Unique customer number
Salutation	a..4	O	Salutation: „Mr“ „Mrs“ „Miss“
bdEmail	ans..100	M	E-mail address
bdPhone	ns..20	O	Telephone number
bdMobileNo	ns..20	M	Mobile number
DateOfBirth	an10	M	Date of birth in the format YYYY-MM-DD. Not applicable to companies.
bdCompany	ans..50	C	Purchasing company name. Required if bdCompanyOrPerson is 'Company'. Everything over 50 characters will be truncated.
VatID	ans..50	C	VAT registration number, the unique number that identifies a business. The field is mandatory for processing B2B transactions for Germany.
CustomerRisk	ans..1024	M	Risk-relevant data as JSON string in Base64 format (see JSON objects: CustomerRisk) Merchants can conduct external risk checks and send this information to Riverty.
Language	a2	O	Language: "NO", "SE", "FI", "DK”, "EN”, "DE”, "NL”, "FR” permitted
CompanyOrPerson	a..7	C	Customer category for delivery address: „Company“ „Person“ (default value) Requred if any of sd-fields (refer below) is provided.
sdCountryCode	a2	O	Country code of the delivery address: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”
sdZip	ans..10	O	Postcode in the delivery address
sdStreet	ans..80	O	Street name or packstation of the delivery address
sdStreetNr	a..50	O	Street number or packstation number of the delivery address
sdStreetNr2	ans..10	O	Street number addition of the delivery address
sdCity	ans..100	O	Town/city of the delivery address
sdcareOf	ans..50	O	Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”). This field has to be used for company, authority and organization names as well – e. g. "Sportverein Blau-Weiß e.V."
ShippingMethod	ans..50	O	Address type. Possible values: "Standard" (default value), "PickUpPoint", "InStore"
sdFirstName	ans..50	O	First name in the delivery address
sdLastName	ans..50	O	Last name in the delivery address
sdSalutation	a..4	O	Salutation in the delivery address „Mr“ „Mrs“ „Miss“ Valid for AddrCountryCode = „DE“, „DK“,“NL“, „BE“, „AT“ or „CH“
Email	ans..100	O	E-mail address of the delivery address
Phone	ns..50	O	Phone number in the delivery address
MobileNo	ns..50	O	Mobile number of the delivery address
sdCompany	ans..50	C	Delivery company name. Required if CompanyOrPerson is 'Company'. Everything over 50 characters will be truncated.
Order	ans..1024	M	Order information as JSON string in Base64 format. See JSON object: Order

Parameters for payments with Riverty

Key	Format	CND	Description
TransID	ans..18	M	TransactionID which should be unique for each payment
RefNr	ns..30	O	Unique reference number

Key	Format	CND	Description
CodeExt	n..10	O	Error code from Riverty, if agreed with
ErrorText	ans..1024	O	Error text from Riverty, if agreed with
BillingAddress	ans..1024	O	If necessary corrected billing address as JSON string in the Base64 format (see JSON objects: Address)
ShippingAddress	ans..1024	O	If necessary corrected shipping address as JSON string in the Base64 format (see JSON objects: Address)

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:

capture.aspx

Key	Format	CND	Description
TransID	ans..18	M	TransactionID which should be unique for each payment
RefNr	ns..30	O	Unique reference number

Key	Format	CND	Description
OrderDesc	ans..768	O	Description of purchased goods, unit prices, merchant’s comment etc.

Key

Format

CND

Description

Order

ans..1024

C

Mandatory for partial capture or if order information have changed with the same total amount.

Order information as JSON string in Base64 format.

See JSON object: Order

InvoiceNr

ans..30

O

Is considered only if Order is also transferred.

Invoice number that is displayed within Riverty portal. An order can contain more than one invoice.

ShippingData

ans..1024

O

Is considered only if Order is also transferred.

Shipping information as JSON string in Base64 format.

(see JSON objects: ShippingData)

Parameters for Riverty captures

Key	Format	CND	Description
TransID	ans..18	M	TransactionID which should be unique for each payment
RefNr	ns..30	O	Unique reference number
Status	a..50	M	OK, CAPTURE_REQUEST or FAILED

Key	Format	CND	Description
InvoiceNumber	ans..30	O	Booking number: generated by merchant or, if not available, by Riverty. Is necessary for partial credits.
CodeExt	n..10	O	Error code from Riverty, if agreed with
ErrorText	ans..1024	O	Error text from Riverty, if agreed with

Result parameters for Riverty captures

Credit with reference

credit.aspx

Key	Format	CND	Description
TransID	ans..18	M	TransactionID which should be unique for each payment
RefNr	ns..30	O	Reference number (e.g. invoice number) which must be unique for each return shipment

Key	Format	CND	Description
OrderDesc	ans..768	O	Description of purchased goods, unit prices, merchant’s comment etc.

Key

Format

CND

Description

Order

ans..1024

C

Mandatory for partial credits

Order information as JSON string in Base64 format.

See JSON object: RefundOrder

InvoiceNr

ans..30

C

Is considered only if Order is also transferred, but then it is mandatory.

Invoice number that is displayed within Riverty portal. An order can contain more than one invoice.

RefundType

enum

O

Type or credit: Possible values are "Refund“ and "Return"

Is necessary only for a full credit.

Parameters for credits of Riverty payments

Key	Format	CND	Description
TransID	ans..18	M	TransactionID which should be unique for each payment
RefNr	ns..30	O	Merchant’s unique reference number

Key	Format	CND	Description
CodeExt	n..10	O	Error code from Riverty, if agreed with
ErrorText	ans..1024	O	Error text from Riverty, if agreed with

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:

reverse.aspx

Key	Format	CND	Description
TransID	ans..18	M	TransactionID which should be unique for each payment

Key

Format

CND

Description

Order

ans..1024

C

Mandatory for partial reversals

Order information as JSON string in Base64 format.

See JSON object: Order

Parameters for reversals of Riverty payments

Key	Format	CND	Description
TransID	ans..18	M	TransactionID which should be unique for each payment

Key	Format	CND	Description
CodeExt	n..10	O	Error code from Riverty, if agreed with
ErrorText	ans..1024	O	Error text from Riverty, if agreed with

Result parameters for reversals of Riverty payments

Batch processing via the 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:

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

Key	Format	CND	Description
Type	a..11	M	HEAD for Header, FOOT for Footer, AFTERPAY for Riverty
Action	a..20	M	The parameter Action defines the type of transaction: Capture Credit Reverse (cancellation)

Key	Format	CND	Description
TransID	ans..18	M	TransactionID which should be unique for each payment
RefNr	ns..30	O	Merchant’s unique reference number

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>

Key	Format	CND	Description
Action	a..20	M	The parameter Action defines the type of transaction: Capture Credit Reverse (cancellation)

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.

Key	Format	CND	Description
existingCustomer	bool	O	Indicates whether the customer is an existing customer of the merchant
verifiedCustomerIdentification	bool	O	Indicates whether the customer has been verified
marketingOptIn	bool	O	Indicates whether marketing material is requested
customerSince	dttm	O	Date in format YYYY-MM-DD since which the customer has existed
customerClassification	ans..32	O	Customer classification
acquisitionChannel	enum	O	Indicates the channel via which the merchant is reached. Possible values: „NotSet“, „Advertisment“, „SocialNetwork“, „Direct“, „SearchEngine“, “Other”
hasCustomerCard	bool	O	Indicates whether the customer has a loyalty card
customerCardSince	dttm	O	Date in format YYYY-MM-DD since which the loyalty card has existed
customerCardClassification	ans..32	O	Indicates the loyalty card level, e.g. "Gold Member"
profileTrackingId	ans..64	O	Unique TrackingID
ipAddress	ans..15	M	Customer´s IP address
numberOfTransactions	n..5	O	Number of successful transactions already completed by the customer
customerIndividualScore	n..5	O	Individual score for the customer supplied by the merchant
userAgent	ans..32	O	UserAgent of this specific consumer
amountOfTransactions	n..5	O	Amount of paid orders last 12 months
otherPaymentMethods	bool	O	Other payment method than MI in wallet

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.

Key	Format	CND	Description
totalGrossAmount	ans..16	M	Gross order amount. Must equal the value of all items (grossUnitPrice * quantity). Please note, that values has to be specified with “.” as decimal separator.
currency	enum	O	Currency: Possible values are „EUR“, „NOK“, „SEK“, „DKK“, „CHF“
risk	ans..1024	O	Order risk-relevant data as JSON string in Base64 format (see JSON object: OrderRisk)
items	Array	M	Array of OrderItems (see JSON object: OrderItem)
totalNetAmount	ans..16	M	Net order amount Please note, that values has to be specified with “.” as decimal separator.
imageUrl	ans..256	O	URL for order image. This image can be viewed on the invoice or next to the instal-ment payment in the Riverty portal. Limited to 100-1280px.

OrderRisk

The order risk information is defined here.

Key

Format

CND

Description

channelType

ans..64

O

Order channel type. Possible values:

"Internet", "Catalog", "CallCenter", "Stationary", "Other".

deliveryType

ans..64

O

Order delivery type. Possible values:

"Normal", "Express".

ticketDeliveryMethod

ans..64

O

Name of the tickets' method. Possible values:

"NotSet", "PickUp", "Email", "Post", "Phone".

OrderItem

The order information is defined here.

Key	Format	CND	Description
productId	ans..64	M	Article number
description	ans..128	M	Article description
type	ans..64	O	Order item type. Possible values: "PhysicalArticle", "DigitalArticle", "GiftCard", "Discount", "ShippingFee", "Surcharge", "Info"
quantity	n..8	M	Article quantity Decimal values, if agreed with and Riverty.
grossUnitPrice	ans..16	M	Gross price per article Please note, that values has to be specified with “.” as decimal separator.
grouId	ans..64	O	GroupID
netUnitPrice	ans..16	M	Net price per article Please note, that values has to be specified with “.” as decimal separator.
unitCode	ans..16	O	Unit (e.g. pieces, litres, kilograms, etc.)
vatCategory	enum	O	VAT category Possible values: "HighCategory", "LowCategory", "NullCategory", "NoCategory", "MiddleCategory", "OtherCategory"
vatPercent	n..2	M	VAT in percent
vatAmount	ans..16	M	VAT as amount per item Please note, that values has to be specified with “.” as decimal separator.
imageUrl	ans..256	O	URL for order image. This image can be viewed on the invoice or next to the instal-ment payment in the Riverty portal. Limited to 100-1280px.
googleProductCategoryId	n..16	O	Google Product Category ID
googleProductCategory	ans..64	O	Google Product Category
merchantProductType	ans..64	O	Merchant category in addition to Google classification
lineNumber	n.3	O	The merchant can specify a line number for each article for sorting purposes
discountAmount	ans..16	O	Discount amount (only for statistical purposes) Please note, that values has to be specified with “.” as decimal separator.
productUrl	ans..256	O	Article URL
marketPlaceSellerId	ans..64	O	ID of a specific market place

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.

Key	Format	CND	Description
type	ans..32	O	Available payment method Possible values: "Invoice", "Account", "Installment", "Consolidatedinvoice"
account	AccountProduct	O	Account information (see JSON object: AccountProduct)
directDebit	DirectDebitInfo	O	Direct-Debit information (see JSON object: DirectDebitInfo)
campaigns	Array	O	Array of campaign information (see JSON object: CampaignInfo)
Installment	InstallmentInfo	O	Instalment payment information (see JSON object: InstallmentInfo)
legalInfo	legalInfo	O	Legal info containing Terms and Conditions, Privacy statement, etc. (see JSON object: LegalInfo)

AccountProduct

The AccountProduct information is defined here.

Key	Format	CND	Description
profileNo	n..32	M	Account profile number

DirectDebitInfo

The DirectDebitInfo information is defined here.

Key	Format	CND	Description
Available	bool	O	Indicates whether DirectDebit is available

CampaignInfo

The CampaignInfo information is defined here.

Key	Format	CND	Description
campaignNo	n..32	O	Campaign number
description	ans..128	O	Campaign description

InstallmentInfo

The InstallmentInfo information is defined here.

Key	Format	CND	Description
basketAmount	enum	O	Available payment method Possible values: "Invoice", "Account", "Installment", "Consolidatedinvoice" Please note, that values has to be specified with “.” as decimal separator.
numberOfInstallments	n..2	O	Number of installments
installmentAmount	ans..16	O	Installment amount for each month Please note, that values has to be specified with “.” as decimal separator.
firstInstallmentAmount	ans..16	O	First installment amount Please note, that values has to be specified with “.” as decimal separator.
lastInstallmentAmount	ans..16	O	Final installment amount Please note, that values has to be specified with “.” as decimal separator.
interestRate	ans..16	O	Interest rate
effectiveInterestRate	ans..16	O	Effective interest rate
effectiveAnnualPercentageRate	ans..16	O	Effective annual percentage
totalInterestAmount	ans..16	O	Total interest rate Please note, that values has to be specified with “.” as decimal separator.
startupFee	ans..16	O	Starting fee
monthlyFee	ans..16	O	Monthly fee
totalAmount	ans..16	O	Total amount
installmentProfileNumber	ans..16	O	Installment profile number
readMore	ans..128	O	Further information about the installment process

LegalInfo

The LegalInfo information is defined here.

Key	Format	CND	Description
requiresCustomerConsent	bool	O	"true", if customer consent is required
termsAndConditionsUrl	ans..250	O	URL to Terms and Conditions
privacyStatementUrl	ans..250	O	URL to Privacy Statement
bgb507Url	ans..250	O	URL to § 507 BGB
text	ans..2500	O	Legal text

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.

Key	Format	CND	Description
countryCode	enum	M	Country code Possible values: "NO“, „SE“, „FI“, „DK“, „DE“, „AT“, „CH“, „NL“, „BE“
postalCode	ans..10	M	Postal code
postalPlace	ans..100	M	City
Street	ans..100	M	Street or packstation
streetNumber	ans..10	M	Street number or packstation number
streetNumberAdditional	ans..10	O	Street number addition
careOf	ans..50	O	Responsible person for dispatch of shipment

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.

Key	Format	CND	Description
totalGrossAmount	ans..16	O	Gross order amount. Must equal the value of all items (grossUnitPrice * quantity). Please note, that values has to be specified with “.” as decimal separator.
currency	enum	O	Currency. Possible values are „EUR“, „NOK“, „SEK“, „DKK“, „CHF“
items	Array	O	Array of OrderItems (see JSON object: OrderItem)
totalNetAmount	ans..16	O	Net order amount Please note, that values has to be specified with “.” as decimal separator.
imageUrl	ans..256	O	URL for order image. This image can be viewed on the invoice or next to the instal-ment payment in the Riverty portal. Limited to 100-1280px.
googleAnalyticsUserId	ans..64	O	Google Analytics UserID
googleAnalyticsClientId	ans..64	O	Google Analytics ClientID
discountAmount	ans..16	O	Discount amount (only for statistical purposes) Please note, that values has to be specified with “.” as decimal separator.

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.

Key	Format	CND	Description
shippingDetails	Array	M	Array of shipping information (see JSON object: ShippingDetails)

ShippingDetails

The ShippingDetails information is defined here.

Key	Format	CND	Description
type	enum	M	Dispatch type: Possible values are "Shipment", "Return"
shippingCompany	ans..64	M	Shipping company
trackingId	ans..64	M	Unique TrackingID

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.

Key	Format	CND	Description
orderItems	Array	M	Array of articles to be credited (see JSON object: RefundOrderItem)

RefundOrderItem

The RefundOrderItem information is defined here.

Key	Format	CND	Description
refundType	ans..32	C	Credit type: Possible values are "Refund“, "Return" The parameter is not required for EventToken="Return".
productId	ans..64	M	Article number
description	ans..128	M	Article description
quantity	n..8	M	Article quantity Decimal values, if agreed with and Riverty.
grossUnitPrice	ans..16	M	Gross price per article Please note, that values has to be specified with “.” as decimal separator.
groupId	ans..64	O	GroupID
netUnitPrice	ans..16	M	Net price per article Please note, that values has to be specified with “.” as decimal separator.
unitCode	ans..16	O	Unit (e.g. pieces, litres, kilograms, etc.)
vatCategory	ans..32	O	VAT category Possible values: "HighCategory", "LowCategory", "NullCategory", "NoCategory", "MiddleCategory", "OtherCategory"
vatPercent	n..2	M	VAT in percent
vatAmount	ans..16	M	VAT as amount per item Please note, that values has to be specified with “.” as decimal separator.
imageUrl	ans..256	O	URL for order image. This image can be viewed on the invoice or next to the instal-ment payment in the Riverty portal. Limited to 100-1280px.
googleProductCategoryId	n..16	O	Google Product Category ID
googleProductCategory	ans..64	O	Google Product Category
merchantProductType	ans..64	O	Merchant category in addition to Google classification
lineNumber	n.3	O	The merchant can specify a line number for each article for sorting purposes
discountAmount	ans..16	O	Discount amount (only for statistical purposes) Please note, that values has to be specified with “.” as decimal separator.
productUrl	ans..256	O	Article URL
marketPlaceSellerId	ans..64	O	ID of a specific market place

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
            }
]

About Riverty (AfterPay) SCA

General information about Riverty (AfterPay) SCA

On this page

Process Flow Chart

interface

Query about available payment types (two-stage authorisation)

Calling the interface for one-stage authorisation

Capture

Credit with reference

Reverse

Batch processing via the interface

JSON Objects

CustomerRisk

Example CustomerRisk as JSON string

Order

OrderRisk

OrderItem

Example of Order as JSON string

AllowedPayMethods

PaymentMethod

AccountProduct

DirectDebitInfo

CampaignInfo

InstallmentInfo

LegalInfo

Example of AllowedPaymentMethods as JSON string

Address

Example of Address as JSON string

OrderSummary

Example of OrderSummary as JSON string

ShippingData

ShippingDetails

Example of ShippingData as JSON string

RefundOrder

RefundOrderItem

Example of RefundOrder as JSON string