About Riverty Debtor Management (Accounting as Service)

General information about Riverty Debtor Management

offers together with a partner/third party service provider a complete debtor management system to merchants. Via the merchant can maintain debtor accounts and provide information about payment status of all payment methods to the service provider to ensure account checking and traceability.

Logo

Info

offers individually scalable solutions for financial and debtor accountings – including the downstream processes such as logistics, dunnings or debt collection.

Type

Debtors Management

Further information can be found on the webpage of Riverty Debtor Management (https://www.riverty.com/de/business/produkte/accounting-as-a-service/).

Process flow chart

interface

Create Order

In order to carry out a create order for Riverty via a server-to-server connection, please use the following URL:

debtor.aspx

Key

Format

CND

Description

Beschreibung

RefNr

ns..30

M

Unique reference number for the enquiry, for example the order number

Eindeutige Referenznummer zur Anfrage, zum Beispiel Bestellnummer

OrderDesc

ans..768

O

Description of the goods purchased

Beschreibung der gekauften Waren

CustomerID

n..10

M

Customer number

Kundennummer

Eventtoken

a2

M

Abbreviation of the action to be done:

<OC> for Order creation

Abkürzung der durchzuführenden Aktion:

<OC> für Auftragserstellung

Paytype

ans

M

PaymentMethodName	PayType (Allowed Values)
AfterPayDirectDebit	APDD
AfterPayInstallmentsDirectDebit	APIDD
AfterPayInstallmentsOpenInvoice	APIOI
AfterPayOpenInvoice	APOI
AmazonPay	AP
AmericanExpress	AMEX
ApplePayExpressCheckout	APEC
ArvatoDirectDebitSepa	ADDS
Bancontact	BC
Blik	Blik
BlikCodeOnly	BlikCO
CashOnDelivery	COD
DinersClub	DINERS
Discover	DISC
Eps	EPS
Giftcard	GC
Giropay	GP
GooglePay	GPay
Ideal	ID
InAppAmazon	IAAM
InAppApple	IAAP
InAppGoogle	IAGO
InStoreOpenInvoice	ISPOI
InStorePickup	ISPWP
InStorePrepayment	ISPP

PaymentMethodName	PayType (Zulässige Werte)
AfterPayDirectDebit	APDD
AfterPayInstallmentsDirectDebit	APIDD
AfterPayInstallmentsOpenInvoice	APIOI
AfterPayOpenInvoice	APOI
AmazonPay	AP
AmericanExpress	AMEX
ApplePayExpressCheckout	APEC
ArvatoDirectDebitSepa	ADDS
Bancontact	BC
Blik	Blik
BlikCodeOnly	BlikCO
CashOnDelivery	COD
DinersClub	DINERS
Discover	DISC
Eps	EPS
Giftcard	GC
Giropay	GP
GooglePay	GPay
Ideal	ID
InAppAmazon	IAAM
InAppApple	IAAP
InAppGoogle	IAGO
InStoreOpenInvoice	ISPOI
InStorePickup	ISPWP
InStorePrepayment	ISPP

Billing Details

Rechnungs-Details

bdSalutation

ans..10

O

Salutation ‘Mr’, ‘Ms’, ‘Company’ or ‘Unknown’. ‘Unknown’ applies if not specified or if wrong.

Anrede „Herr“, „Frau“, „Firma“ oder „Unbekannt“. Wenn nicht angegeben oder falsch, gilt „Unbekannt“.

bdFirstName

ans..24

M

First name of the customer

Vorname des Kunden

bdLastName

ans..30

M

Last name or company name

Nachname oder Firmenname

bdDateOfBirth

ans..10

O

Date of birth in the format YYYY-MM-DD

Geburtsdatum im Format JJJJ-MM-TT

bdStreet

ans..30

M

Street name

Straßenname

bdstreetNr

ans..30

M

house number

Hausnummer

bdZip

ans..5

M

Postcode

Postleitzahl

bdDistrict

ans..30

O

District

District-Name

bdCity

ans..30

M

City

Ort

bdCountryCode

a2

M

Country code, 2 characters according to ISO 3166, DE=Germany

Ländercode zweistellig gemäß ISO 3166, DE=Deutschland

Shipping Details

Liefer-Details

sdSalutation

ans..10

O

Salutation ‘Mr’, ‘Ms’, ‘Company’ or ‘Unknown’. ‘Unknown’ applies if not specified or if wrong

Anrede „Herr“, „Frau“, „Firma“ oder „Unbekannt“. Wenn nicht angegeben oder falsch, gilt „Unbekannt“.

sdFirstName

ans..24

M

First name of the customer

Vorname des Kunden

sdLastName

ans..30

M

Last name or company name

Nachname oder Firmenname

sdStreet

ans..30

M

Street name and house number

Straßenname und Hausnummer

sdstreetNr

ans..30

M

house number

Hausnummer

sdDistrict

ans..30

O

Address addition, e.g. town district

Adresszusatz wie z.B. Ortsteil

sdZip

ans..5

M

Postcode

Postleitzahl

sdCity

ans..30

M

City

Ort

sdCountryCode

a2

M

Country code, 2 characters according to ISO 3166, DE=Germany

Ländercode zweistellig gemäß ISO 3166, DE=Deutschland

Phone

ans..20

O

Customer’s phone number

Telefonnummer des Kunden

Email

ans..100

O

Email address of the customer

E-Mail-Adresse des Kunden

MobileNo

ans..20

O

Customer’s mobile telephone number

Mobiltelefonnummer des Kunden

Articlelist

String

M

Base64 encoded value

Base64-codierter Wert

items

array

M

Array of items, e.g.: {"items": [{items1 ...}{item2...}]}

Array von Elementen, z. B.: {"items": [{items1 ...}{item2...}]}

items.itemReference

ans..30

M

Position of the line item in the order

Position der Werbebuchung in der Bestellung

items.id

ans..30

M

Article Number

Artikelnummer

items.description

ans..30

M

Name / Title of the Article

Name / Titel des Artikels

items.quantity

ans..30

M

Total number of items

Gesamtzahl der Artikel

items.amount

n..10

M

Gross unit price (incl. VAT) in Cent

Brutto-Stückpreis (inkl. MwSt.) in Cent

items.vatAmount

n..10

M

Tax Amount in cents

Steuerbetrag in Cent

items.vatPercent

n..10

M

Tax rate of country tax in % as number 19% = 19

Steuersatz der Landessteuer in % als nummer 19% = 19

items.vatType

String

M

TAXLESS = taxless

NORMAL = normal

REDUCED = reduced

TAXLESS = taxless

NORMAL = normal

REDUCED = reduced

items.positionType

String

M

SALES_ARTICLE = Sales Article

IBAN_VERIFICATION = IBAN verification

LOYALTY_CARD = Loyalty Card

SHIPPING_COSTS_EXPRESS = Shipping costs (express)

FREE_ARTICLE = Free article

GIFT_CARD_VOUCHER_PAYMENT = Gift Card Voucher Payment

GIFT_CARD_VOUCHER_SALE = Gift Card Voucher Sale

SERVICE_CHARGE = Service Charge

CASH_ON_DELIVERY = Cash on delivery

MARKETPLACE_PROVISION = Marketplace-Provision

SUBSCRIPTION_ORDER = Subscription Order

DISCOUNT = Discount

SHIPPING_COSTS = Shipping costs

DISCOUNT_FOR_SUBSCRIPTION_ORDER = Discount for Subscription Order

SALES_ARTICLE = Sales Article

IBAN_VERIFICATION = IBAN verification

LOYALTY_CARD = Loyalty Card

SHIPPING_COSTS_EXPRESS = Shipping costs (express)

FREE_ARTICLE = Free article

GIFT_CARD_VOUCHER_PAYMENT = Gift Card Voucher Payment

GIFT_CARD_VOUCHER_SALE = Gift Card Voucher Sale

SERVICE_CHARGE = Service Charge

CASH_ON_DELIVERY = Cash on delivery

MARKETPLACE_PROVISION = Marketplace-Provision

SUBSCRIPTION_ORDER = Subscription Order

DISCOUNT = Discount

SHIPPING_COSTS = Shipping costs

DISCOUNT_FOR_SUBSCRIPTION_ORDER = Discount for Subscription Order

AmountAuth

a3

O

Authroization amount in cents

Autorisierungsbetrag in Cent

cardholderName

String

C

Name of the cardholder as printed on the card.

Notice: Alphanumeric special characters, listed in EMV Book 4, “Appendix B”. Special characters have been added with EMV 3DS Version 2.3, but not all participants (banks) already support that standard.

Name des Karteninhabers wie auf der Karte aufgedruckt.

Hinweis: Alphanumerische Sonderzeichen, aufgeführt in EMV Buch 4, „Anhang B“. Mit EMV 3DS Version 2.3 wurden Sonderzeichen hinzugefügt, aber nicht alle Teilnehmer (Banken) unterstützen diesen Standard bereits.

expiryDate

String

C

Card expiry in format YYYYMM

Kartenablaufdatum im Format JJJJMM

AccOwner

ans..30

O

Account holder. Structure: Salutation;FirstName;LastName.

Kontoinhaber. Aufbau: Anrede;Vorname;Nachname.

AccBank

ans..40

O

Name of the bank

Name der Bank

IBAN

ans..34

C

IBAN is mandatory in case of :

AfterPayDirectDebit	APDD
AfterPayInstallmentsDirectDebit	APIDD
ArvatoDirectDebitSepa	ADDS

Die IBAN ist Pflicht im Fall von:

AfterPayDirectDebit	APDD
AfterPayInstallmentsDirectDebit	APIDD
ArvatoDirectDebitSepa	ADDS

BIC

ans..11

C

BIC is Mandatory in case of:

AfterPayDirectDebit	APDD
AfterPayInstallmentsDirectDebit	APIDD
ArvatoDirectDebitSepa	ADDS

Die BIC ist Pflicht im Fall von:

AfterPayDirectDebit	APDD
AfterPayInstallmentsDirectDebit	APIDD
ArvatoDirectDebitSepa	ADDS

MandateId

ans..35

C

Reference of the SEPA Mandate. Mandatory for SEPA Payments.

Referenz des SEPA-Mandats. Obligatorisch für SEPA-Zahlungen.

Parameters for creating an order

Articlelist

Articlelist should be sent as a base64 encoded value. Please find the example below.

{
    "items": [
        {
            "itemReference": "1",
            "id": "123457",
            "description": "Test product",
            "quantity": 3,
            "amount": 5500,
            "vatAmount": 500, 
            "vatPercent": 19,
			"vatType": "NORMAL",
			"positionType":"SALES_ARTICLE"
		},
		{
            "itemReference": "2",
			"id": "654327",
			"description": "Test product2",
			"quantity": 1,
			"amount": 500,
			"vatAmount": 100, 
            "vatPercent": 7,
			"vatType": "NORMAL",
			"positionType":"SALES_ARTICLE"
		}
	]
}  Articlelist=ewogICAgIml0ZW1zIjogWwogICAgICAgIHsKICAgICAgICAgICAgIml0ZW1SZWZlcmVuY2UiOiAiMSIsCiAgICAgICAgICAgICJpZCI6ICIxMjM0NTYiLAogICAgICAgICAgICAiZGVzY3JpcHRpb24iOiAiVGVzdCBwcm9kdWN0IiwKICAgICAgICAgICAgInF1YW50aXR5IjogMywKICAgICAgICAgICAgImdyb3NzUHJpY2UiOiA1MDAwLAogICAgICAgICAgICAidmF0QW1vdW50IjogMCwgCiAgICAgICAgICAgICJ2YXRQZXJjZW50IjogMCwKCQkJInZhdFR5cGUiOiJUQVhMRVNTIiwKCQkJInBvc2l0aW9uVHlwZSI6IlNBTEVTX0FSVElDTEUiCgkJfSwKCQl7CiAgICAgICAgICAgICJpdGVtUmVmZXJlbmNlIjogIjIiLAoJCQkiaWQiOiAiNjU0MzIxIiwKCQkJImRlc2NyaXB0aW9uIjogIlRlc3QgcHJvZHVjdDIiLAoJCQkicXVhbnRpdHkiOiAxLAoJCQkiZ3Jvc3NQcmljZSI6IDUwMDAsCgkJCSJ2YXRBbW91bnQiOiAwLCAKICAgICAgICAgICAgInZhdFBlcmNlbnQiOiAwLAoJCQkidmF0VHlwZSI6IlRBWExFU1MiLAoJCQkicG9zaXRpb25UeXBlIjoiU0FMRVNfQVJUSUNMRSIKCQl9CgldCn0=

Key	Format	CND	Description	Beschreibung
RefNr	ns..30	O	Reference number is returned, if it was previously submitted	Wenn zuvor übergeben, wird die Referenznummer zurückgegeben
CodeExt	n..10	O	Error code from Riverty	Fehlercode von Riverty
ErrorText	ans..256	O	Error text from Riverty	Fehlertext von Riverty
ReferenzID	n..50	O	Unique ID within information/response from Riverty	Eindeutige ID der Auskunft/Antwort von Riverty

Response parameters for creating an order

Create an Invoice

In order to create an invoice for Riverty via a server-to-server connection, please use the following URL:

debtor.aspx

Key	Format	CND	Description	Beschreibung
PayID	ans..32	M	ID issued by for order creation	Vom vergebene ID für die Bonitätsprüfung
InvoiceNr	ns..30	M	Invoice Number	Rechnung Nummer
RefNr	ns..30	M	Unique reference number, e.g. order number	Eindeutige Referenznummer, z.B. Bestellnummer
Date	Date	M	Date of Invoice (YYYY-MM-DD)	Datum der Rechnung (JJJJ-MM-TT)
TrackingID	ns..30	O	Shipment Tracking Id from delivery company	Sendungsverfolgungs-ID des Lieferunternehmens
TrackingNummer	ns..30	O	Shipment reference of the shop	Versandreferenz des Shops
ParcelService	String	M	Delivery Company Eg: DHL	Lieferunternehmen z. B.: DHL
DueDate	Date	M	Date on which the invoice is due	Datum, an dem die Rechnung fällig ist
InvoiceDate	Date	M	Invoice Creation Date	Rechnungserstellungsdatum
DeliveryDate	Date	M	Date of Delivery	Datum der Lieferung
Articlelist	String	M	Base64 encoded value	Base64-codierter Wertitems
items	array	M	Array of items, e.g.: {"items": [{items1 ...}{item2...}]}	Array von Elementen, z. B.: {"items": [{items1 ...}{item2...}]}
items.itemReference	ans..30	M	Position of the line item in the order	Position der Werbebuchung in der Bestellung
items.id	ans..30	M	Article Number	Artikelnummer
items.description	ans..30	M	Name / Title of the Article	Name / Titel des Artikels
items.quantity	ans..30	M	Total number of items	Gesamtzahl der Artikel
items.amount	n..10	M	Gross unit price (incl. VAT) in Cent	Brutto-Stückpreis (inkl. MwSt.) in Cent
items.vatAmount	n..10	M	Tax Amount in cents	Steuerbetrag in Cent
items.vatPercent	n..10	M	Tax rate of country tax in % as number 19% = 19	Steuersatz der Landessteuer in % als nummer 19% = 19
items.vatType	String	M	TAXLESS = taxless NORMAL = normal REDUCED = reduced	TAXLESS = taxless NORMAL = normal REDUCED = reduced
items.positionType	String	M	SALES_ARTICLE = Sales Article IBAN_VERIFICATION = IBAN verification LOYALTY_CARD = Loyalty Card SHIPPING_COSTS_EXPRESS = Shipping costs (express) FREE_ARTICLE = Free article GIFT_CARD_VOUCHER_PAYMENT = Gift Card Voucher Payment GIFT_CARD_VOUCHER_SALE = Gift Card Voucher Sale SERVICE_CHARGE = Service Charge CASH_ON_DELIVERY = Cash on delivery MARKETPLACE_PROVISION = Marketplace-Provision SUBSCRIPTION_ORDER = Subscription Order DISCOUNT = Discount SHIPPING_COSTS = Shipping costs DISCOUNT_FOR_SUBSCRIPTION_ORDER = Discount for Subscription Order	SALES_ARTICLE = Sales Article IBAN_VERIFICATION = IBAN verification LOYALTY_CARD = Loyalty Card SHIPPING_COSTS_EXPRESS = Shipping costs (express) FREE_ARTICLE = Free article GIFT_CARD_VOUCHER_PAYMENT = Gift Card Voucher Payment GIFT_CARD_VOUCHER_SALE = Gift Card Voucher Sale SERVICE_CHARGE = Service Charge CASH_ON_DELIVERY = Cash on delivery MARKETPLACE_PROVISION = Marketplace-Provision SUBSCRIPTION_ORDER = Subscription Order DISCOUNT = Discount SHIPPING_COSTS = Shipping costs DISCOUNT_FOR_SUBSCRIPTION_ORDER = Discount for Subscription Order

Key	Format	CND	Description	Beschreibung
EventToken	a2	M	Abbreviation of the action to be done: <BT> for Invoice Creation	Abkürzung der auszuführenden Aktion: <BT> für Invoice Creation

Parameters for creating invoices

Articlelist

{
    "items": [
        {
            "itemReference": "1",
            "id": "123457",
            "description": "Test product",
            "quantity": 3,
            "amount": 5500,
            "vatAmount": 500, 
            "vatPercent": 19,
			"vatType": "NORMAL",
			"positionType":"SALES_ARTICLE"
		},
		{
            "itemReference": "2",
			"id": "654327",
			"description": "Test product2",
			"quantity": 1,
			"amount": 500,
			"vatAmount": 100, 
            "vatPercent": 7,
			"vatType": "NORMAL",
			"positionType":"SALES_ARTICLE"
		}
	]
}  Articlelist=ewogICAgIml0ZW1zIjogWwogICAgICAgIHsKICAgICAgICAgICAgIml0ZW1SZWZlcmVuY2UiOiAiMSIsCiAgICAgICAgICAgICJpZCI6ICIxMjM0NTYiLAogICAgICAgICAgICAiZGVzY3JpcHRpb24iOiAiVGVzdCBwcm9kdWN0IiwKICAgICAgICAgICAgInF1YW50aXR5IjogMywKICAgICAgICAgICAgImdyb3NzUHJpY2UiOiA1MDAwLAogICAgICAgICAgICAidmF0QW1vdW50IjogMCwgCiAgICAgICAgICAgICJ2YXRQZXJjZW50IjogMCwKCQkJInZhdFR5cGUiOiJUQVhMRVNTIiwKCQkJInBvc2l0aW9uVHlwZSI6IlNBTEVTX0FSVElDTEUiCgkJfSwKCQl7CiAgICAgICAgICAgICJpdGVtUmVmZXJlbmNlIjogIjIiLAoJCQkiaWQiOiAiNjU0MzIxIiwKCQkJImRlc2NyaXB0aW9uIjogIlRlc3QgcHJvZHVjdDIiLAoJCQkicXVhbnRpdHkiOiAxLAoJCQkiZ3Jvc3NQcmljZSI6IDUwMDAsCgkJCSJ2YXRBbW91bnQiOiAwLCAKICAgICAgICAgICAgInZhdFBlcmNlbnQiOiAwLAoJCQkidmF0VHlwZSI6IlRBWExFU1MiLAoJCQkicG9zaXRpb25UeXBlIjoiU0FMRVNfQVJUSUNMRSIKCQl9CgldCn0=

Key	Format	CND	Description	Beschreibung
RefNr	ns..30	O	Reference number is returned, if it was previously submitted	Wenn zuvor übergeben, wird die Referenznummer zurückgegeben
CodeExt	n..10	O	Error code from Riverty	Fehlercode von Riverty
ErrorText	ans..256	O	Error text from Riverty	Fehlertext von Riverty
ReferenzID	n..50	O	Unique ID within information/response from Riverty	Eindeutige ID der Auskunft/Antwort von Riverty

Response parameters for creating invoices

Cancel Order and Credit Invoice

With reference to a previously set up order and invoice, you can cancel the order and credit the invoice. For that purpose, please use the following URL:

debtor.aspx

Key	Format	CND	Description	Beschreibung
InvoiceNr	ns..30	M	Unique reference number for the enquiry, for example the order number	Eindeutige Referenznummer zur Anfrage, zum Beispiel Bestellnummer
EventToken	a2	M	Abbreviation of the action to be done: <OS> for canceling the order <CR> for Credit	Abkürzung der auszuführenden Aktion: <OS> zum Stornieren der Bestellung <CR> für Gutschrift
Reason	a2	M	Cancelation: "OUT_OF_STOCK", "CUSTOMER_CANCELLATION", "NO_PAYMENT", "CUSTOMER_SERVICE" Credit: CARRIER_RETURN = carrier return CUSTOMER_RETURN = customer return - use this one if not provided by merchant	Stornieren: "OUT_OF_STOCK", "CUSTOMER_CANCELLATION", "NO_PAYMENT", "CUSTOMER_SERVICE" Gutschrift: CARRIER_RETURN = Rücksendung durch den Spediteur CUSTOMER_RETURN = Kundenretoure – verwenden Sie diese, wenn nicht vom Händler bereitgestellt
Date	Date	M	YYYY-MM-DD	YYYY-MM-DD
reference	ans..32	M	Mandatory for credit, Reference for return	Obligatorisch für Gutschrift, Referenz für Rücksendung
ReturnDate	Date	M	Mandatory for credit, Date of return	Obligatorisch für Gutschrift, Rückgabedatum
ArticleList	String	M	Base64 encoded value	Base64-codierter Wertitems
items	array	M	Array of items, e.g.: {"items": [{items1 ...}{item2...}]}	Array von Elementen, z. B.: {"items": [{items1 ...}{item2...}]}
items.itemReference	ans..30	M	Position of the line item in the order	Position der Werbebuchung in der Bestellung
items.id	ans..30	M	Article Number	Artikelnummer
items.description	ans..30	M	Name / Title of the Article	Name / Titel des Artikels
items.quantity	ans..30	M	Total number of items	Gesamtzahl der Artikel
items.amount	n..10	M	Gross unit price (incl. VAT) in Cent	Brutto-Stückpreis (inkl. MwSt.) in Cent
items.vatAmount	n..10	M	Tax Amount in cents	Steuerbetrag in Cent
items.vatPercent	n..10	M	Tax rate of country tax in % as number 19% = 19	Steuersatz der Landessteuer in % als nummer 19% = 19
items.vatType	String	M	TAXLESS = taxless NORMAL = normal REDUCED = reduced	TAXLESS = taxless NORMAL = normal REDUCED = reduced
items.positionType	String	M	SALES_ARTICLE = Sales Article IBAN_VERIFICATION = IBAN verification LOYALTY_CARD = Loyalty Card SHIPPING_COSTS_EXPRESS = Shipping costs (express) FREE_ARTICLE = Free article GIFT_CARD_VOUCHER_PAYMENT = Gift Card Voucher Payment GIFT_CARD_VOUCHER_SALE = Gift Card Voucher Sale SERVICE_CHARGE = Service Charge CASH_ON_DELIVERY = Cash on delivery MARKETPLACE_PROVISION = Marketplace-Provision SUBSCRIPTION_ORDER = Subscription Order DISCOUNT = Discount SHIPPING_COSTS = Shipping costs DISCOUNT_FOR_SUBSCRIPTION_ORDER = Discount for Subscription Order	SALES_ARTICLE = Sales Article IBAN_VERIFICATION = IBAN verification LOYALTY_CARD = Loyalty Card SHIPPING_COSTS_EXPRESS = Shipping costs (express) FREE_ARTICLE = Free article GIFT_CARD_VOUCHER_PAYMENT = Gift Card Voucher Payment GIFT_CARD_VOUCHER_SALE = Gift Card Voucher Sale SERVICE_CHARGE = Service Charge CASH_ON_DELIVERY = Cash on delivery MARKETPLACE_PROVISION = Marketplace-Provision SUBSCRIPTION_ORDER = Subscription Order DISCOUNT = Discount SHIPPING_COSTS = Shipping costs DISCOUNT_FOR_SUBSCRIPTION_ORDER = Discount for Subscription Order

Parameters for credit of invoices

Key	Format	CND	Description	Beschreibung
RefNr	ns..30	O	Reference number is returned, if it was previously submitted	Wenn zuvor übergeben, wird die Referenznummer zurückgegeben
CodeExt	n..10	O	Error code from Riverty	Fehlercode von Riverty
ErrorText	ans..256	O	Error text from Riverty	Fehlertext von Riverty
ReferenzID	n..50	O	Unique ID within information/response from Riverty	Eindeutige ID der Auskunft/Antwort von Riverty

Response parameters for credit of invoices