Ratepay Payment API Documentation

Open invoice, installments, direct debit and prepayment - Ratepay is your partner for easy and secure payments!

We are experts in individual payment solutions!

We handle the entire payment process and carry the risk for payment default. Our products with immediate online approval include installment payment, open invoice, direct debit and payment in advance.

Hello World!

If you are not familiar with our Payment API, we recommend to start with our Introduction.

Quick Links

For those who don't like to use the Search field, here some links related to FAQ.

Gateway URL

Sequence Flows

XSD Files

SDK

You won't start from scratch? Try the PHP SDK.

Version History

Version

Date

Changes

1.8.12

September 2020

  • Updated XML schema files (XSDs)

1.8.11

May 2019

1.8.10

February 2019

1.8.9

December 2018

1.8.8

October 2018

1.8.7

August 2018

  • Added new Reason Codes

1.8.6

March 2018

1.8.5

March 2018

  • Editorial Changes

  • Small changes in 7.1.2 List of Reason Codes and corresponding Result Codes

  • Added 7.1.3 Calculation Request: Reason Codes and Description

1.8.4

October 2017

  • Editorial Changes

1.8.3

August 2017

1.8.2

June 2016

  • Korrektur der Erklärung zum Feld reference-id im External Block.

1.8.1

February 2016

  • Editorial changes

1.8

November 2015

1.7.5.1

October 2015

1.7.5

June 2015

  • Added note about the new feature “Extended Response”

  • Added section about sending special characters

  • Removed IS-ALIVE-TEST

  • <customer> and <payment> parameters are optional for all PAYMENT_CHANGE subtypes

  • <device-site> is not needed anymore (deprecated)

  • <customer-device> now is mandatory for PAYMENT_REQUEST and PAYMENT_QUERY

  • [email protected] not mandatory anymore

1.7.1

August 2018

  • Removed deprecated and backward elements

1.7

April 2014

  • Simplified Payment Change sub-types

  • Removed deprecated device fingerprinting elements and added new elements

  • Set Payment Query response parameters limits and classification to deprecated

  • Enhanced RatePAY responses

1.6.3.2

July 2013

  • Updated referenced documents

1.6.3

June 2013

  • Revised Shopping basket item – split the old and new way of handling the shopping basket and added explanation

1.6.2

March 2013

  • Reworked chapter about Payment Changes and added further explanation to the XML examples