Table of Contents

About Ratepay

General information about Ratepay

Page properties

Logo

Info

Excerpt
Ratepay offers payments solutions for purchases on invoice and hire purchases as well as direct debits with full processing and carries to complete risk of payments defaults.

Type

Payments by Invoice and Installments

Ratepay is a whitelabel online service provider which allows merchants to provide their customers secure and commonly used payment methods. Below are the payment methods that are supported by Ratepay:

Open Invoice - Open Invoice is a payment method that enables customers to purchase goods or services on credit and pay at a later date. With Open Invoice customers receive an invoice detailing the amount owed, payment terms, and due date.
When a customer selects Open Invoice during the checkout, Ratepay performs a real-time risk check. The advantage of using Open Invoice is that it can improve cash flow for both the buyer and merchants:
- For buyers: They can purchase goods or services without having to pay for them immediately, which can be beneficial for managing their finances.
- For merchants: With Ratepay you profit as a merchant from a full invoice purchase service. You pass on all the invoice data during the order to Ratepay, who takes over the complete billing and debtor management. As merchant you get a payment guarantee.
SEPA Direct Debit - Ratepay offers classical hire purchase and SEPA direct debit. SEPA Direct Debit is a payment method that allows merchants to collect payments from buyers directly from their bank account via their IBAN, who have granted them permission to do so.

Further information can be found on the webpage of Ratepay (https://www.ratepay.com/en/).

Process flow chart

Multiexcerpt

MultiExcerptName	ProcessFlow_RatepayV2

draw.io Diagram

border	true
diagramName	ProcessFlow_RatepayV2_CT
simpleViewer	false
links	auto
tbstyle	top
lbox	true
diagramWidth	1108

Ratepay process flow

Get Started

To start accepting Ratepay payment methods, first onboard with Ratepay.
Once onboarded below information should be provided to you by Ratepay:
1. Client ID: Username to connect to Ratepay's API
2. Client Secret: Password to connect to Ratepay's API
3. Partner Shop ID: The unique identifier assigned to you by Ratepay
Reach out to
Multiexcerpt include
SpaceWithExcerpt EN
MultiExcerptName Helpdesk-Name
PageWithExcerpt Wording
to enable Ratepay as a payment method and provide the above details securely.

Multiexcerpt include
SpaceWithExcerpt EN
MultiExcerptName Platform-Kurz
PageWithExcerpt Wording
interface

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Definition
PageWithExcerpt	Definition EN

Initiate Ratepay payment

Once the customer proceeds to checkout you show a default list of Ratepay payment methods to pay. Once the customer proceeds to pay with Ratepay payment method, your backend need to make a server to server call to the following URL for making a payment request:

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	BaseURL
PageWithExcerpt	DE:Wording (veraltet)

ratepay.aspx

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Request_Intro
PageWithExcerpt	Reuse API

Table FilterdefaultBeschreibungisFirstTimeEnterfalse

hideColumns

true

sparkName

Sparkline

hidePane

true

datepattern

dd M yy

id

1645026714730_-1115773321

worklog

365|5|8|y w d h m|y w d h m

isOR

AND

separator

Point (.)

order

0

Multiexcerpt

MultiExcerptName	ratepayv2_initiate_request

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1645026714732_-2015508759
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MerchantID
page	MerchantID
type	page

Table Excerpt Include

static	true
name	TransID
page	TransID
type	page

Table Excerpt Include

static	true
name	RefNr
page	refnr
type	page

Table Excerpt Include

static	true
name	Amount
page	Amount
type	page

Table Excerpt Include

static	true
name	Currency
page	Currency
type	page

Table Excerpt Include

static	true
name	ReqId-ans..32
page	ReqId
type	page

Key	Format	CND	Description

Beschreibung

OrderDesc

ans..768

O

Description of the goods purchased

Beschreibung der gekauften Waren


bdFirstName	ans..100	C	First name of the customer who is billed. For B2B transactions it should be the contact person in the company. Required for B2C. Optional for B2B.

Vorname des Kunden, dem die Rechnung ausgestellt wird.Bei B2B-Transaktionen sollte dies die Kontaktperson im Unternehmen sein.Erforderlich für B2C.Optional für B2B.

bdLastName

ans..100

C

Last name of the customer who is billed. For B2B transactions it should be the contact person in the company. Required for B2C. Optional for B2B.

Nachname des Kunden, dem die Rechnung ausgestellt wird.Bei B2B-Transaktionen sollte dies die Kontaktperson im Unternehmen sein.Erforderlich für B2C.Optional für B2B.

bdStreet

ans..100

M

Street name of the billing address

Straßenname der Rechnungsadresse


bdStreetNr	ans..30	O	House number of the billing address

Hausnummer der Rechnungsadresse

bdStreetAddition

ans..50

O

Additional info of the billing address

Zusätzliche Informationen zur Rechnungsadresse

bdCity

ans..100

M

City of the billing address

Ort der Rechnungsadresse


bdCountryCode	ans..2	M	Country code of the billing address

Ländercode der RechnungsadresseTitle

bdZIP

ans..10

M

Postal code of the billing address

Postleitzahl der Rechnungsadresse

Title

ans..45

O

Title of the customer

Titel des Kunden

DateOfBirth

ans..10

C

Date of birth of customer in YYYY-MM-DD format. Required for B2C.

Geburtsdatum des Kunden im Format JJJJ-MM-TT.Erforderlich für B2C.

bdCompanyName

ans..100

C

Company Name. Required for B2B transactions.

Firmenname.Erforderlich für B2B-Transaktionen.

VatID

ans..25

O

Company Vat ID. Relevant for B2B transactions.

Umsatzsteuer-Identifikationsnummer des Unternehmens.Relevant für B2B-Transaktionen.

Email

ans..100

M

Email address of the customer

E-Mail-Adresse des Kunden

Phone

ans..60

M

Phone number of the customer

Telefonnummer des Kunden


Language	ans..2	O	The language in which the buyer prefers communication to be done. If the preferred language is not supported, the buyer communication will be in German. Must conform to ISO 639-1 alpha 2.

Die Sprache, in der der Käufer die Kommunikation bevorzugt.Wird die gewünschte Sprache nicht unterstützt, erfolgt die Kommunikation mit dem Käufer auf Deutsch.Muss ISO 639-1 alpha 2 entsprechen.


CustomerID	an..100	O	Unique customer

CustomerIDan..100OUnique customer

ID from your system

Eindeutige Kunden-ID aus Ihrem System

sdFirstName

ans..100

C

First name of the shipping address. For B2B transactions it should be the contact person in the company.

Vorname in der Lieferadresse.Bei B2B-Geschäften sollte es der Ansprechpartner im Unternehmen sein.

sdLastName

ans..100

C

Last name of the shipping address. For B2B transactions it should be the contact person in the company

.Nachname in der Lieferadresse.Bei B2B-Geschäften sollte es der Ansprechpartner im Unternehmen sein

.
sdCompanyName	ans..100	C	Company Name

Firmenname

sdStreet

ans..100

M

Street name of the shipping address

Straßenname der Lieferadresse


sdStreetHouseNumber	ans..30	O	House number of the shipping address

Hausnummer der Lieferadresse

sdStreetAddition

ans..50

O

Additional info of the shipping address

Zusätzliche Informationen zur Lieferadresse

sdCity

ans..100

M

City of the shipping address

Ort der Lieferadresse

sdCountryCode

ans..2

M

Country code of the shipping address

Ländercode der Lieferadresse


sdZIPCode	ans..10	M	Postal code of the shipping address

Postleitzahl der Lieferadresse


IPAddr	ans..39	O	IP Address of the customer's device

IP-Adresse des Kundengeräts

DeviceToken

ans..255

O

Device token

Geräte-Token


Channel	enum	O	The sales channel the transaction originates from: "WEBSHOP", "POINT_OF_SALE", "PHONE_OR_MAIL"

Der Vertriebskanal, aus dem die Transaktion stammt: „WEBSHOP“, „POINT_OF_SALE“, „PHONE_OR_MAIL“

BIC

ans..50

O

Bank Identifier Code

Bankleitzahl

IBAN

ans..34

C

International Bank Account Number. Mandatory when DebitPayType is

SEPA_DIRECT_DEBIT.Internationale Bankkontonummer.Obligatorisch, wenn DebitPayType

SEPA_DIRECT_DEBIT

ist

.
AccOwner	ans..100	C	Name of account holder. Mandatory when DebitPayType is SEPA_DIRECT_DEBIT.

Name des Kontoinhabers.Obligatorisch, wenn DebitPayType SEPA_DIRECT_DEBIT ist.DebitPayType

RPMethod

enum

M

The payment option the buyer selected: "OPEN_INVOICE", "PAY_NOW"

Die vom Käufer gewählte Zahlungsoption: „OPEN_INVOICE“, „PAY_NOW“

DebitPayType

enum

M

The transfer type the buyer selected: "BANK_TRANSFER", "SEPA_DIRECT_DEBIT

Die vom Käufer gewählte Überweisungsart: „BANK_TRANSFER“, „SEPA_DIRECT_DEBIT“

shoppingBasket

JSON

M

Shopping basket. For structure see Shopping Basket below. Has to be sent as Base64 encoded.

Warenkorb.Informationen zur Struktur finden Sie weiter unten bei Shopping Basket. Muss Base64-kodiert gesendet werden.

Parameters for Ratepay payments

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Response_Intro
PageWithExcerpt	Reuse API

filterdefaultisFirstTimeEnterhideColumnstruesparkName1645015599199910105299Point ()order0

Multiexcerpt

MultiExcerptName	ratepayv2_initiate_response

table-

joiner

dateFormat

Beschreibung

dd M yy
export-word	false

show-source

false

hidePane

true

datepattern

dd M yy

export-csv

Sparkline

false

id

1645015599201_-

519776912
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m

isOR

AND

separator

.

export-pdf

false

Multiexcerpt

MultiExcerptName	ratepayv2_initiate_response

sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MID
page	mid
type	page

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1645015599201_-519776912
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MID
page	mid
type	page

Table Excerpt Include

static

true

Table Excerpt Include

static	true

name	PayID
page	PayID
type	page

Table Excerpt Include

static	true
name	XID
page	XID
type	page

Table Excerpt Include

static	true
name	TransID
page	TransID
type	page

Table Excerpt Include

static	true
name	Status_OK_FAILED
page	Status
type	page

Table Excerpt Include

static	true
name	RefNr
page	refnr
type	page

Key	Format	CND	Description

Beschreibung

AuthorizationExpiry

dttm

C

The date and time when remaining un-cancelled and un-captured authorized amount will be automatically cancelled. Timestamp with offset according to ISO 8601. Available only for successful responses HTTP 201.

Datum und Uhrzeit der automatischen Stornierung des verbleibenden, nicht stornierten und nicht gebuchten autorisierten Betrags.Zeitstempel mit Offset gemäß ISO 8601. Nur für erfolgreiche HTTP 201-Antworten verfügbar.BankNameans..127

BankName

ans..127

C

Bank name of the bank account the customer has to transfer the money to. Provided only when DebitPayType is sent as BANK_TRANSFER in request.

Bankname des Bankkontos, auf das der Kunde das Geld überweisen muss.Wird nur bereitgestellt, wenn DebitPayType in der Anfrage als BANK_TRANSFER gesendet wird.

BIC

ans..50

C

BIC of the bank account the customer has to transfer the money to. Provided only when DebitPayType is sent as BANK_TRANSFER in request.

BIC des Bankkontos, auf das der Kunde das Geld überweisen muss.Wird nur bereitgestellt, wenn DebitPayType in der Anfrage als BANK_TRANSFER gesendet wird.IBANans..34


IBAN	ans..34	C	IBAN of the bank account the customer has to transfer the money to. Provided only when DebitPayType is sent as BANK_TRANSFER in request.

IBAN des Bankkontos, auf das der Kunde das Geld überweisen muss.Wird nur bereitgestellt, wenn DebitPayType in der Anfrage als BANK_TRANSFER gesendet wird.

AccOwner

ans..100

C

Account owner name of the bank account the customer has to transfer the money to. Provided only when DebitPayType is sent as BANK_TRANSFER in request

.Kontoinhaber des Bankkontos, auf das der Kunde das Geld überweisen muss

.

Wird nur bereitgestellt, wenn DebitPayType in der Anfrage als BANK_TRANSFER gesendet wird.

ExternalDeclineCategory


RatepayPaymentReference	ans..127	C	Purpose to be indicated in the bank transfer (generated by Ratepay). Provided only when DebitPayType is sent as BANK_TRANSFER in request.

Anzugebender Zweck in der Überweisung (von Ratepay generiert). Wird nur bereitgestellt, wenn DebitPayType in der Anfrage als BANK_TRANSFER gesendet wird.

ExternalDeclineCategory

ans..

C

Decline category. See Decline Categories for details.

Ablehungskategorie. Details finden Sie unter Decline Categories.

ExternalMessage

ans..256

C

A message describing which constraint was violated

Eine Meldung, die beschreibt, welche Einschränkung verletzt wurde

ExternalCodes

ans..64

C

List of none, one or multiple reasons why the request was declined. See Decline Categories to learn about possible reasons for each decline category

.Liste mit keinem, einem oder mehreren Ablehnungsgründen für die Anfrage.Unter Decline Categories finden Sie Informationen zu möglichen Gründen für jede Ablehnungskategorie

.
RPTransID	ans..50	M	ID of transaction generated by Ratepay during authorization. A transaction ID is generated for both accepted and declined transactions.

ID der von Ratepay während der Autorisierung generierten Transaktion.Sowohl für akzeptierte als auch für abgelehnte Transaktionen wird eine Transaktions-ID generiert.

Result parameters for Ratepay payments

Incremental Authorization

This function increases the amount of a previously authorized transaction. You can only increment the original authorized amount by 30% or by €300 whichever is lower. You can only send one incremental authorization request for the original transaction. In order to increase a payment transaction with Ratepay, please use the following URL:

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	BaseURL
PageWithExcerpt	DE:Wording (veraltet)

increment.aspx

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Request_Intro
PageWithExcerpt	Reuse API

filterdefaultisFirstTimeEnterhideColumnstruesparkNameSparkline1748339571013_903926538

Multiexcerpt

MultiExcerptName	ratepayv2_increment_request

table-

joiner

dateFormat

Beschreibung

dd M yy
export-word	false

show-source

false

export-csv

false

hidePane

true

datepattern

dd M yy

id

id	1748339571015_-50462648
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m

isOR

AND

separator

Point (.)

order

0

export-

export-
separator	.

Multiexcerpt

MultiExcerptName	ratepayv2_increment_request

Table Transformer

dateFormat

dd M yy

export-word

false

show-source

false

export-csv

false

id

1748339571015_-50462648

transpose

false

worklog

365|5|8|y w d h m|y w d h m

separator

.

pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MerchantID
page	MerchantID
type	page

Table Excerpt Include

static	true
name	PayID
page	PayID
type	page

Table Excerpt Include

static	true
name	TransID
page	TransID
type	page

Table Excerpt Include

static	true
name	RefNr
page	refnr
type	page

Table Excerpt Include

static	true
name	Amount
page	Amount
type	page

Table Excerpt Include

static	true
name	Currency
page	Currency
type	page

Key	Format	CND	Description

Beschreibung

items

JSON

O

Item list. For structure see Shopping Basket below, only the items part. Has to be sent as Base64 encoded.

Artikelliste.Die Struktur finden Sie unten bei Shopping Basket, nur der Artikelteil. Muss Base64-kodiert gesendet werden.

vats

JSON

O

Vat information. For structure see Shopping Basket below, only the vats part. Has to be sent as Base64 encoded.

MwSt.-Informationen. Die Struktur finden Sie unten bei Shopping Basket, nur der MwSt.-Teil. Muss Base64-kodiert gesendet werden.

Parameters for increment Ratepay payments

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Response_Intro
PageWithExcerpt	Reuse API

filterdefaultisFirstTimeEnterhideColumnstruedd M yy174833986370170549443Point ()order0

Multiexcerpt

MultiExcerptName	ratepayv2_increment_response

table-

joiner

dateFormat

Beschreibung

dd M yy
export-word	false

show-source

false

sparkName

Sparkline

hidePane

true

datepattern

export-csv	false

id

1748339863703_-

1766822566
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m

isOR

AND

separator

.

export-pdf

false

Multiexcerpt

MultiExcerptName	ratepayv2_increment_response

sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MID
page	mid
type	page

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1748339863703_-1766822566
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MID
page	mid
type	page

Table Excerpt Include

static

true

Table Excerpt Include

static	true

name	PayID
page	PayID
type	page

Table Excerpt Include

static	true
name	XID
page	XID
type	page

Table Excerpt Include

static	true
name	TransID
page	TransID
type	page

Table Excerpt Include

static	true
name	Status_OK_FAILED
page	Status
type	page

Table Excerpt Include

static	true
name	RefNr
page	refnr
type	page

Key	Format	CND	Description

Beschreibungans..


ExternalDeclineCategory	ans..	C	Decline category. See Decline Categories for details.
ExternalMessage

Ablehungskategorie. Details finden Sie unter Decline Categories.ExternalMessage

ans..256

C

A message describing which constraint was violated

Eine Meldung, die beschreibt, welche Einschränkung verletzt wurde

ExternalCodes

ans..64

C

List of none, one or multiple reasons why the request was declined. See Decline Categories to learn about possible reasons for each decline category.

Liste mit keinem, einem oder mehreren Ablehnungsgründen für die Anfrage.Unter Decline Categories finden Sie Informationen zu möglichen Gründen für jede Ablehnungskategorie.

RPTransID

ans..50

M

ID of confirmed authorization generated by Ratepay

Von Ratepay generierte ID der bestätigten Autorisierung

Response parameters for increment Ratepay payments

Capture a Ratepay payment

In order to capture a payment transaction with Ratepay, please use the following URL:

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	BaseURL
PageWithExcerpt	DE:Wording (veraltet)

capture.aspx

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Request_Intro
PageWithExcerpt	Reuse API

filterdefault

Multiexcerpt

MultiExcerptName	ratepayv2_capture_request

table-

joiner

dateFormat

Beschreibung

isFirstTimeEnter

false

hideColumns

true

sparkName

Sparkline

hidePane

true

datepattern

dd M yy

id

1645103153861_761968387

worklog

365|5|8|y w d h m|y w d h m

show-
dd M yy
export-word	false

isOR

AND

separator

Point (.)

order

0

show-

Multiexcerpt

MultiExcerptName	ratepayv2_capture_request

Table Transformer

dateFormat

dd M yy

export-word

false

source	false
export-csv	false
id	1742894400726_-206894178
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MerchantID
page	MerchantID
type	page

Table Excerpt Include

isFirstTimeEnter	true
static	true
v	2
name	PayID_Capture
page	PayID
type	page

Key	Format	CND	Description

Beschreibung

TransID

ans..64

O

TransactionID provided by you which should be unique for each payment

Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Table Excerpt Include

static	true
name	RefNr
page	refnr
type	page

Table Excerpt Include

static	true
name	Amount
page	Amount
type	page

Table Excerpt Include

static	true
name	Currency
page	Currency
type	page

Key	Format	CND	Description

Beschreibung


items	JSON	O	Item list. For structure see Shopping Basket below, only the items part. Has to be sent as Base64 encoded.

Artikelliste.Die Struktur finden Sie unten bei Shopping Basket, nur der Artikelteil. Muss Base64-kodiert gesendet werden.

vats

JSON

O

Vat information. For structure see Shopping Basket below, only the vats part. Has to be sent as Base64 encoded.

MwSt.-Informationen. Die Struktur finden Sie unten bei Shopping Basket, nur der MwSt.-Teil. Muss Base64-kodiert gesendet werden.

Parameters for capture of a Ratepay payment

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Response_Intro
PageWithExcerpt	Reuse API

filtertable

Multiexcerpt

MultiExcerptName	ratepayv2_capture_response

table-

joiner

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1645103936760_-1914303220
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	ratepayv2_capture_response

Table Transformer

dateFormat

dd M yy

dateFormat	dd M yy

export-word	false
show-source	false
export-csv	false
id	1742894440207_-28168767
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MID
page	mid
type	page

Table Excerpt Include

static	true
name	PayID
page	PayID
type	page

Table Excerpt Include

static	true
name	XID
page	XID
type	page

Key	Format	CND	Description

Beschreibung

TransID

ans..64

O

TransactionID provided by you which should be unique for each payment

Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

table-excerpt-include

static	true
name	Status_OK_FAILED
page	Status
type	page

Table Excerpt Include

static	true
name	RefNr
page	refnr
type	page

Key	Format	CND	Description

Beschreibung


ExternalDeclineCategory	ans..	C	Decline category. See Decline Categories for details.

Ablehungskategorie. Details finden Sie unter Decline Categories.

ExternalMessage

ans..256

C

A message describing which constraint was violated

Eine Meldung, die beschreibt, welche Einschränkung verletzt wurde

ExternalCodes

ans..64

C

List of none, one or multiple reasons why the request was declined. See Decline Categories to learn about possible reasons for each decline category.

Liste mit keinem, einem oder mehreren Ablehnungsgründen für die Anfrage.Unter Decline Categories finden Sie Informationen zu möglichen Gründen für jede Ablehnungskategorie.

RPCaptureID

ans..50

M

ID of transaction generated by Ratepay for capture

ID der von Ratepay zur Buchung generierten Transaktion

Response parameters for capturing a Ratepay payment

Cancel / return of Ratepay payments

In order to cancel a payment transaction with Ratepay, please use the following URL:

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	BaseURL
PageWithExcerpt	DE:Wording (veraltet)

reverse.aspx

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Request_Intro
PageWithExcerpt	Reuse API

filtertable

Multiexcerpt

MultiExcerptName	ratepayv2_cancel_request

table-

joiner

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1645106404748_-1209779947
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	ratepayv2_cancel_request

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1742893753677_1071238395
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MerchantID
page	MerchantID
type	page

Table Excerpt Include

isFirstTimeEnter	true
static	true
v	2
name	PayID_Reverse
page	PayID
type	page

Key	Format	CND	Description

Beschreibung

TransID

ans..64

O

TransactionID provided by you which should be unique for each payment

Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

table-excerpt-include

static	true
name	RefNr
page	refnr
type	page

Table Excerpt Include

static	true
name	Amount
page	Amount
type	page

Table Excerpt Include

static	true
name	Currency
page	Currency
type	page

Key	Format	CND	Description

Beschreibung


items	JSON	O	Item list. For structure see Shopping Basket below, only the items part. Has to be sent as Base64 encoded.

Artikelliste.Die Struktur finden Sie unten bei Shopping Basket, nur der Artikelteil. Muss Base64-kodiert gesendet werden.

vats

JSON

O

Vat information. For structure see Shopping Basket below, only the vats part. Has to be sent as Base64 encoded.

MwSt.-Informationen. Die Struktur finden Sie unten bei Shopping Basket, nur der MwSt.-Teil. Muss Base64-kodiert gesendet werden.

Parameters for cancellation / return of a Ratepay payment

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Response_Intro
PageWithExcerpt	Reuse API

filterdefault

Multiexcerpt

MultiExcerptName	ratepayv2_cancel_response

table-

joiner

order

0

Multiexcerpt

MultiExcerptName	ratepayv2_cancel_response

Table Transformer

dateFormat

dd M yy

dateFormat

Beschreibung

isFirstTimeEnter

false

hideColumns

true

sparkName

Sparkline

hidePane

true

datepattern

dd M yy

id

1645106671137_1127389283

worklog

365|5|8|y w d h m|y w d h m

isOR

AND

separator

Point (.)

dd M yy

export-word	false
show-source	false
export-csv	false
id	1742893840159_-2017710763
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MID
page	mid
type	page

Table Excerpt Include

static	true
name	PayID
page	PayID
type	page

Table Excerpt Include

static	true
name	XID
page	XID
type	page

Key	Format	CND	Description

Beschreibung

TransID

ans..64

O

TransactionID provided by you which should be unique for each payment

Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Table Excerpt Include

static	true
name	Status_OK_FAILED
page	Status
type	page

Table Excerpt Include

static	true
name	RefNr
page	refnr
type	page

Key	Format	CND	Description

Beschreibung


ExternalDeclineCategory	ans..	C	Decline category. See Decline Categories for details.

Ablehungskategorie. Details finden Sie unter Decline Categories.

ExternalMessage

ans..256

C

A message describing which constraint was violated

Eine Meldung, die beschreibt, welche Einschränkung verletzt wurde

ExternalCodes

ans..64

C

List of none, one or multiple reasons why the request was declined. See Decline Categories to learn about possible reasons for each decline category.

Liste mit keinem, einem oder mehreren Ablehnungsgründen für die Anfrage.Unter Decline Categories finden Sie Informationen zu möglichen Gründen für jede Ablehnungskategorie.

RPCancellationID

ans..50

M

ID of transaction generated by Ratepay for cancellation

ID der von Ratepay zur Stornierung generierten Transaktion

Response parameters for cancellation / return of a Ratepay payment

Credit / refund Ratepay payment

In order to refund a payment transaction with Ratepay, please use the following URL:

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	BaseURL
PageWithExcerpt	DE:Wording (veraltet)

credit.aspx

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Request_Intro
PageWithExcerpt	Reuse API

filtertable

Multiexcerpt

MultiExcerptName	ratepayv2_credit_request

table-

joiner

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1645107504559_-1209779947
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	ratepayv2_credit_request

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1645107504560_-904197602
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MerchantID
page	MerchantID
type	page

Table Excerpt Include

static	true
name	PayID_Credit
page	PayID
type	page

Key	Format	CND	Description

Beschreibung

TransID

ans..64

O

TransactionID provided by you which should be unique for each payment

Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

table-excerpt-include

static	true
name	RefNr
page	refnr
type	page

Table Excerpt Include

static	true
name	Amount
page	Amount
type	page

Table Excerpt Include

static	true
name	Currency
page	Currency
type	page

Key	Format	CND	Description

Beschreibung


items	JSON	O	Item list. For structure see Shopping Basket below, only the items part. Has to be sent as Base64 encoded.

Artikelliste.Die Struktur finden Sie unten bei Shopping Basket, nur der Artikelteil. Muss Base64-kodiert gesendet werden.

vats

JSON

O

Vat information. For structure see Shopping Basket below, only the vats part. Has to be sent as Base64 encoded.

MwSt.-Informationen. Die Struktur finden Sie unten bei Shopping Basket, nur der MwSt.-Teil. Muss Base64-kodiert gesendet werden.

Parameters for crediting a Ratepay payment

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Response_Intro
PageWithExcerpt	Reuse API

filterdefault

Multiexcerpt

MultiExcerptName	ratepayv2_credit_response

table-

joiner

order

0

Multiexcerpt

MultiExcerptName	ratepayv2_credit_response

Table Transformer

dateFormat

dd M yy

dateFormat

Beschreibung

isFirstTimeEnter

false

hideColumns

true

sparkName

Sparkline

hidePane

true

datepattern

dd M yy

id

1645107786924_399475371

worklog

365|5|8|y w d h m|y w d h m

isOR

AND

separator

Point (.)

dd M yy

export-word	false
show-source	false
export-csv	false
id	1645107786925_-1392886331
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MID
page	mid
type	page

Table Excerpt Include

static	true
name	PayID
page	PayID
type	page

Table Excerpt Include

static	true
name	XID
page	XID
type	page

Key	Format	CND	Description

Beschreibung

TransID

ans..64

O

TransactionID provided by you which should be unique for each payment

Ihre eigene TransaktionsID, die für jede Zahlung eindeutig sein muss

Table Excerpt Include

static	true
name	Status_OK_FAILED
page	Status
type	page

Table Excerpt Include

static	true
name	RefNr
page	refnr
type	page

Key	Format	CND	Description

Beschreibung


ExternalDeclineCategory	ans..	C	Decline category. See Decline Categories for details.

Ablehungskategorie. Details finden Sie unter Decline Categories.

ExternalMessage

ans..256

C

A message describing which constraint was violated

Eine Meldung, die beschreibt, welche Einschränkung verletzt wurde

ExternalCodes

ans..64

C

List of none, one or multiple reasons why the request was declined. See Decline Categories to learn about possible reasons for each decline category.

Liste mit keinem, einem oder mehreren Ablehnungsgründen für die Anfrage.Unter Decline Categories finden Sie Informationen zu möglichen Gründen für jede Ablehnungskategorie.

RPRefundID

ans..50

M

ID of transaction generated by Ratepay for credit

ID der von Ratepay zur Gutschrift generierten Transaktion

Response parameters for crediting a Ratepay payment

ShoppingBasket parameter explained

The following table describes the individual values within the ShoppingBasket:

SELECT * FROM T*

Multiexcerpt

MultiExcerptName	ratepayv2_shoppingbasket

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1645108006524_1911748195
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	ratepayv2_shoppingbasket

Table Transformer

dateFormat

dd M yy

export-word

false

show-source

false

export-csv

false

id

1645108006527_-852642095

transpose

false

worklog

365|5|8|y w d h m|y w d h m

separator

.

export-pdf

false

sql

Key	Format	CND	Description

Beschreibung

shoppingBasketAmount

n..10

M

The amount for the basket including VAT given in the currency of the transaction. shoppingBasketAmount=Sum from all items for ((unitPriceGross+discount) * quantity). Note: Since discount is a negative amount the addition above actually subtracts the discount from unitPriceGross.

Der Warenkorbbetrag inklusive Mehrwertsteuer in der Währung der Transaktion.shoppingBasketAmount = Summe aller Artikel für ((unitPriceGross+discount) * quantity).Hinweis: Da der Rabatt ein negativer Betrag ist, wird durch die obige Addition der Rabatt tatsächlich vom unitPriceGross abgezogen.

items.artNr

ans..255

O

The article number of the item, e.g. SKU. Not allowed to contain only whitespaces

.Artikelnummer des Artikels, z.B. SKU

.

Sie darf nicht ausschließlich Leerzeichen enthalten.


items.category	ans..511	O	Category for the item

Kategorie für den Artikel


items.descriptionAddition	ans	O	Description of the

itemBeschreibung des Artikels

item
items.discount	ans	O	Gross discount on one item after taxes. Needs to be a negative value. Example: For a discount of 20.55 pass -2055.

Bruttorabatt auf einen Artikel nach Steuern. Das muss ein negativer Wert sein.Beispiel: Für einen Rabatt von 20,55 geben Sie -2055 ein.

items.name

string

M

Name of the item

Name des Artikels


items.unitPriceGross	n..10	M	Gross value of one item after taxes. For a value of €100.00 pass it as 10000.

Bruttowert eines Artikels nach Steuern. Für einem Wert von 100,00 € geben Sie 10000 ein.

items.quantity

n..

M

Ordered quantity of the item

Bestellte Menge des Artikels


items.taxRate	decimal	M	Tax rate applicable for the item given in percent

Für den Artikel geltender Steuersatz in Prozent

. Pass this value up to 2 decimals. For example 15.55% should be sent as 15.55.
items.unit	ans..255	O	Arbitrary measurement unit of the item, e.g. kg, litre, pieces

Beliebige Maßeinheit des Artikels, z.B. kg, Liter, Stück

vats.netAmount

n..10

M

Amount before taxes for all items

Betrag vor Steuern für alle Artikel

vats.taxAmount

n..10

M

Total tax amount for all the items for the given tax rate. For a value of 100.00 pass 10000.

Gesamtsteuerbetrag für alle Artikel zum angegebenen Steuersatz.Für einen Wert von 100,00 geben Sie 10000 ein.

vats.taxRate

decimal

M

Tax rate given as percentage on the net amount. Pass this value up to 2 decimals. For example

15%

15.55% should be sent as

0.

15

,Steuersatz als Prozentsatz auf den Nettobetrag. Geben Sie diesen Wert mit maximal zwei Dezimalstellen an.Beispielsweise werden 15 % als 0,15 angegeben

.55.

Parameters within the shopping basket

Multiexcerpt

MultiExcerptName	ratepayv2_shoppingbasket_example

Code Block

language	json

[
    {
        "shoppingBasketAmount": 7350,
        "items": [
            {
                "artNr": 37,
                "category": "Electronics",
                "descriptionAddition": "desc 1",
                "discount": -50,
                "name": "High-performance laptop",
                "unitPriceGross": 2500,
                "quantity": 1,
                "taxRate": 0.04,
                "unit": "pcs"
            },
            {
                "artNr": 38,
                "category": "Accessories",
                "descriptionAddition": "desc 1",
                "discount": -50,
                "name": "Wireless gaming mouse",
                "unitPriceGross": 2500,
                "quantity": 2,
                "taxRate": 0.04,
                "unit": "pcs"
            }
        ],
        "vats": [
            {
                "netAmount": 7200,
                "taxAmount": 300,
                "taxRate": 0.04
            }
        ]
    }
]

Space shortcuts

Page tree

Versions Compared

Old Version 8

New Version Current

Key

About Ratepay

General information about Ratepay

Process flow chart

Get Started

Multiexcerpt include
SpaceWithExcerpt EN
MultiExcerptName Platform-Kurz
PageWithExcerpt Wording
interface

Initiate Ratepay payment

Incremental Authorization

Capture a Ratepay payment

Cancel / return of Ratepay payments

Credit / refund Ratepay payment

ShoppingBasket parameter explained

Paygate

Computop

Help

Intranet Tools

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 8

New Version Current

Key

About Ratepay

General information about Ratepay

Process flow chart

Get Started

Multiexcerpt includeSpaceWithExcerptENMultiExcerptNamePlatform-KurzPageWithExcerptWording interface

Initiate Ratepay payment

Incremental Authorization

Capture a Ratepay payment

Cancel / return of Ratepay payments

Credit / refund Ratepay payment

ShoppingBasket parameter explained

Multiexcerpt include
SpaceWithExcerpt EN
MultiExcerptName Platform-Kurz
PageWithExcerpt Wording
interface