Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space ENWORK and version Documentation
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.
TypePayments 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
MultiExcerptNameProcessFlow_RatepayV2

draw.io Diagram
bordertrue
diagramNameProcessFlow_RatepayV2_CT
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth1108

Ratepay process flow


Get Started

  1. To start accepting Ratepay payment methods, first onboard with Ratepay.
  2. 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
  3. Reach out to
    Multiexcerpt include
    SpaceWithExcerptEN
    MultiExcerptNameHelpdesk-Name
    PageWithExcerptWording
    to enable Ratepay as a payment method and provide the above details securely.


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
interface

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameDefinition
PageWithExcerptDefinition 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
SpaceWithExcerptDE
MultiExcerptNameBaseURL
PageWithExcerptDE:Wording
ratepay.aspx

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Multiexcerpt
MultiExcerptNameratepayv2_initiate_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1645026714732_-2015508759
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Key

Format

CND

Description

OrderDescans..768ODescription of the goods purchased
bdFirstNameans..100CFirst 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.
bdLastNameans..100CLast 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.
bdStreetans..100MStreet name of the billing address
bdStreetNrans..30OHouse number of the billing address
bdStreetAdditionans..50OAdditional info of the billing address
bdCityans..100MCity of the billing address
bdCountryCodeans..2MCountry code of the billing address
bdZIPans..10MPostal code of the billing address
Titleans..45OTitle of the customer
DateOfBirthans..10CDate of birth of customer in YYYY-MM-DD format. Required for B2C.
bdCompanyNameans..100CCompany Name. Required for B2B transactions.
VatIDans..25OCompany Vat ID. Relevant for B2B transactions.
Emailans..100MEmail address of the customer
Phoneans..60MPhone number of the customer
Languageans..2OThe 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.
CustomerIDan..100OUnique customer ID from your system
sdFirstNameans..100CFirst name of the shipping address. For B2B transactions it should be the contact person in the company.
sdLastNameans..100CLast name of the shipping address. For B2B transactions it should be the contact person in the company.
sdCompanyNameans..100CCompany Name
sdStreetans..100MStreet name of the shipping address
sdStreetHouseNumberans..30OHouse number of the shipping address
sdStreetAdditionans..50OAdditional info of the shipping address
sdCityans..100MCity of the shipping address
sdCountryCodeans..2MCountry code of the shipping address
sdZIPCodeans..10MPostal code of the shipping address
IPAddrans..39OIP Address of the customer's device
DeviceTokenans..255ODevice token
ChannelenumOThe sales channel the transaction originates from: "WEBSHOP", "POINT_OF_SALE", "PHONE_OR_MAIL"
BICans..50OBank Identifier Code
IBANans..34CInternational Bank Account Number. Mandatory when DebitPayType is SEPA_DIRECT_DEBIT.
AccOwnerans..100CName of account holder. Mandatory when DebitPayType is SEPA_DIRECT_DEBIT.
RPMethodenumMThe payment option the buyer selected: "OPEN_INVOICE", "PAY_NOW"
DebitPayTypeenumMThe transfer type the buyer selected: "BANK_TRANSFER", "SEPA_DIRECT_DEBIT
shoppingBasket JSONMShopping basket. For structure see Shopping Basket below. Has to be sent as Base64 encoded.

Parameters for Ratepay payments


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Multiexcerpt
MultiExcerptNameratepayv2_initiate_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1645015599201_-519776912
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Key

Format

CND

Description

AuthorizationExpirydttmCThe 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.
BankNameans..127CBank name of the bank account the customer has to transfer the money to. Provided only when DebitPayType is sent as BANK_TRANSFER in request.
BICans..50CBIC of the bank account the customer has to transfer the money to. Provided only when DebitPayType is sent as BANK_TRANSFER in request.
IBANans..34CIBAN of the bank account the customer has to transfer the money to. Provided only when DebitPayType is sent as BANK_TRANSFER in request.
AccOwnerans..100CAccount 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.
RatepayPaymentReferenceans..127CPurpose to be indicated in the bank transfer (generated by Ratepay). Provided only when DebitPayType is sent as BANK_TRANSFER in request.

ExternalDeclineCategory

ans..

C

Decline category. See Decline Categories for details.

ExternalMessageans..256C

A message describing which constraint was violated

ExternalCodesans..64C

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

RPTransIDans..50M

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

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
SpaceWithExcerptDE
MultiExcerptNameBaseURL
PageWithExcerptDE:Wording
increment.aspx

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Multiexcerpt
MultiExcerptNameratepayv2_increment_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1748339571015_-50462648
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Key

Format

CND

Description

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

Parameters for increment Ratepay payments


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Multiexcerpt
MultiExcerptNameratepayv2_increment_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1748339863703_-1766822566
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Key

Format

CND

Description

ExternalDeclineCategory

ans..

C

Decline category. See Decline Categories for details.

ExternalMessageans..256C

A message describing which constraint was violated

ExternalCodesans..64C

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

RPTransIDans..50M

ID of confirmed authorization generated by Ratepay

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
SpaceWithExcerptDE
MultiExcerptNameBaseURL
PageWithExcerptDE:Wording
capture.aspx

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Multiexcerpt
MultiExcerptNameratepayv2_capture_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1742894400726_-206894178
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
namePayID_Capture
pagePayID
typepage

Key

Format

CND

Description

TransIDans..64OTransactionID provided by you which should be unique for each payment

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Key

Format

CND

Description

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

Parameters for capture of a Ratepay payment


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Multiexcerpt
MultiExcerptNameratepayv2_capture_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1742894440207_-28168767
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Key

Format

CND

Description

TransIDans..64OTransactionID provided by you which should be unique for each payment

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Key

Format

CND

Description

ExternalDeclineCategory

ans..

C

Decline category. See Decline Categories for details.

ExternalMessageans..256C

A message describing which constraint was violated

ExternalCodesans..64C

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

RPCaptureIDans..50M

ID of transaction generated by Ratepay for capture

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
SpaceWithExcerptDE
MultiExcerptNameBaseURL
PageWithExcerptDE:Wording
reverse.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Multiexcerpt
MultiExcerptNameratepayv2_cancel_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1742893753677_1071238395
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
isFirstTimeEntertrue
statictrue
v2
namePayID_Reverse
pagePayID
typepage

Key

Format

CND

Description

TransIDans..64OTransactionID provided by you which should be unique for each payment

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Key

Format

CND

Description

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

Parameters for cancellation / return of a Ratepay payment


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Multiexcerpt
MultiExcerptNameratepayv2_cancel_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1742893840159_-2017710763
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Key

Format

CND

Description

TransIDans..64OTransactionID provided by you which should be unique for each payment

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Key

Format

CND

Description

ExternalDeclineCategory

ans..

C

Decline category. See Decline Categories for details.

ExternalMessageans..256C

A message describing which constraint was violated

ExternalCodesans..64C

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

RPCancellationIDans..50M

ID of transaction generated by Ratepay for cancellation

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
SpaceWithExcerptDE
MultiExcerptNameBaseURL
PageWithExcerptDE:Wording
credit.aspx

 

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Multiexcerpt
MultiExcerptNameratepayv2_credit_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1645107504560_-904197602
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
namePayID_Credit
pagePayID
typepage

Key

Format

CND

Description

TransIDans..64OTransactionID provided by you which should be unique for each payment

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Key

Format

CND

Description

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

Parameters for crediting a Ratepay payment


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Multiexcerpt
MultiExcerptNameratepayv2_credit_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1645107786925_-1392886331
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Key

Format

CND

Description

TransIDans..64OTransactionID provided by you which should be unique for each payment

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameRefNr
pagerefnr
typepage

Key

Format

CND

Description

ExternalDeclineCategory

ans..

C

Decline category. See Decline Categories for details.

ExternalMessageans..256C

A message describing which constraint was violated

ExternalCodesans..64C

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

RPRefundIDans..50M

ID of transaction generated by Ratepay for credit

Response parameters for crediting a Ratepay payment


ShoppingBasket parameter explained

The following table describes the individual values within the ShoppingBasket:

Multiexcerpt
MultiExcerptNameratepayv2_shoppingbasket

Key

Format

CND

Description

shoppingBasketAmountn..10M

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.

items.artNrans..255O

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

items.categoryans..511O

Category for the item

items.descriptionAdditionansO

Description of the item

items.discountansO

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

items.namestringM

Name of the item

items.unitPriceGrossn..10M

Gross value of one item after taxes. For a value of €100.00 pass it as 10000.

items.quantityn..M

Ordered quantity of the item

items.taxRatedecimalM

Tax rate applicable for the item given in percent. Pass this value up to 2 decimals. For example 15.55% should be sent as 15.55.

items.unitans..255O

Arbitrary measurement unit of the item, e.g. kg, litre, pieces

vats.netAmountn..10M

Amount before taxes for all items

vats.taxAmountn..10M

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

vats.taxRatedecimalM

Tax rate given as percentage on the net amount. Pass this value up to 2 decimals. For example 15.55% should be sent as 15.55.

Parameters within the shopping basket


Multiexcerpt
MultiExcerptNameratepayv2_shoppingbasket_example
Code Block
languagejson
[
    {
        "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
            }
        ]
    }
]