POST - /orders{action} - Validation of Orders

POST /orders/debit

Method: POST

URI: /orders/debit

Parent Error Code (where applicable): 12000 Error while creating order

HTTP status: 400 Bad Request

Overview

Field	Data Type	Required for	Unique	Value Range Length	Length	Expectation	Code
initialAmount	Number	All	No	greater then min. authorizing amount in cents and less then 9999999	7	Integer between 1 and 9999999	12200 12201
currency	String	All	No	Processing, dependent on payment method and merchant configuration	3	Currency code in the range of ISO_4217	12202 12203
product	String	All	No	[creditcard, paypal, paydirekt, ratepay-invoice, ratepay-directdebit, ratepay-installment, sofort]	128	one of the following: [creditcard, paypal, paydirekt, ratepay-invoice, ratepay-directdebit, ratepay-installment, sofort]	12256 12257 12602 12603
async	Object	PayPal PayDirekt Sofort	No			Object of type async	12204
async.successUrl	String	All	No	Class URL	{6 - 2048}	Mandatory string representing a valid http URL according to: Class URL and UrlValidator	12205 12206
async.failureUrl	String	All	No	Class URL	{6 - 2048}	Mandatory string representing a valid http URL according to: Class URL UrlValidator	12207 12208
async.cancelUrl	String	All	No	Class URL	{6 - 2048}	Mandatory string representing a valid http URL according to: Class URL UrlValidator	12209 12210
terms	Number	Ratepay	No	long		UNIX timestamp in ms	12213 12214
privacy	Number	Ratepay	No	long		UNIX timestamp in ms	12215 12216
description	String	None	No		{1 - 128}	String between 1 and 128 characters	12217
statementDescription	String	None	No		{1 - 128}	String between 1 and 128 characters	12218
basket	Array[item]	Ratepay	No			Array of type item	12219 12220
item.name	String	All(when basket is present)	No		{1 - 128}	String between 1 and 128 characters	12220 12220
item.articleNumber	String	Yes(when basket is present)	No		{1 - 255}	String between 1 and 255 characters	12223 12224
item.totalPrice	Number	Yes when basket is present	No	greater than min. item total price amount in cents and less than 9999999		Number between min. item total price amount in cents and 9999999	12225 12226
item.totalPriceWithTax:	Number	Yes when basket is present	No	Number greater than item Total Price in cents		Number greater than item Total Price in cents	12227 12228
item.tax	Number	Yes when basket is present	No	Number between 0 and 100		Number between 0 and 100	12229 12230
item.unitPrice	Number	Yes when basket is present	No	Number between min. item unit price amount in cents and 9999999		Number between min. item unit price amount in cents and 9999999	12231 12232
item.unitPriceWithTax	Number	Yes when basket is present	No	Number greater than item.unitPrice		Number greater than item unit Price	12233 12234
item.quantity	Number	Yes when basket is present	No	Number between 1 and 9999999		Number between 1 and 9999999	12235 12236
customer	String	Ratepay	Yes	Additional required fields for ratepay: email	20	Unique string representing a customer reference. May contain numbers, letters, dashes and underscores.	12237 12238 12239 4020
persona	String	Ratepay	Yes	Additional required fields for ratepay: birthday and at least phone or mobile	20	Unique string representing a persona reference. May contain numbers, letters, dashes and underscores.	12240 12240 12240 12243 8020
billingAddress	String	Ratepay	Yes		20	unique string representing a billing reference. May contain numbers, letters, dashes and underscores.	12244 12245
shippingAddress	String	Ratepay	Yes		20	Unique string representing a shipping Address reference. May contain numbers, letters, dashes and underscores.	12246 12247 6020
ipAddress	String	No	No	IPv4 - IPv6	255	String with length of 255 representing a valid ip address according to: InetAddressValidator	12248 12249 6020
channel	String	No	No	[ MOTO, ECOM ]	128	String in range [MOTO, ECOM]	12250 12251
source	String	No	No		{1 - 128}	String between 1 and 128 characters	12252
payment	Object	CreditCardRatepaySepa	No			Object of type payment	12258 12259
payment.riskIdentId	String	Ratepay ECOM	No	string	{1-80}	String between 1 and 80 characters	12264 12265
payment.installmentTotalAmount	Number	Ratepay Installment	No			Number greater than 0	12266 12267
payment.installmentNumber	Number	Ratepay Installment	No			Number greater than 0	12268 12269
payment.installmentAmount	Number	Ratepay Installment	No			Number greater than 0 representing Installment Amount in cents.	12270 12271
payment.lastInstallmentAmount	Number	Ratepay Installment	No			Number greater than 0 representing last Installment Amount in cents.	12272 12273
payment.installmentInterestRate	Float	Ratepay Installment	No			Fractional number representing Interest Rate.	12274 12275
payment.paymentFirstDay	Number	Ratepay Installment - optional	No			Number greater than 0	12276

SAQ A-EP/SAQ A Use Cases

payment.paymentInstrumentId

String

CreditCard, if no credit card payment data provided. Ratepay Direct Debit, if no sepa payment data provided. Not mandatory for Ratepay Installment (see bank-transfer case). Denied for Ratepay Invoice. Denied for PayPal. Denied for PayDirekt. Not mandatory for Sofort. Sepa payment instrument or sepa payment data may be provided. Required for PayPal.

Yes

Unique string representing a payment Instrument Id. May contain numbers, letters, dashes and underscores.

12260 12261 12262 12263

Server to Server Use Case

Field	Data Type	Required for	Unique	Value	Length	Expectation	Code
merchantPaymentInstrumentId	String	No	Yes		{1 - 255}	Unique string representing a customer merchant generated unique identifier for a payment instrument.	10205 10206
payment.accountHolder	String	None	No		{4 - 128}	String between 4 and 128 characters representing a valid account holder.May contain letters, whitespaces, dots, apostrophes, dashes and numbers.	16016
payment.bankName	String	None	No		{1 - 255}	String between 1 and 255 characters containging only letters, whitespace and numbers	16011
payment.bic	String	None	No		8 or 11	String from 8 or 11 characters representing a valid BIC	16014
payment.cardHolder	String	None	No		{3 - 128}	Mandatory string between 3 and 128 characters containing only letters, whitespaces, dots, apostrophes and dashes	16009 16010
payment.cardNumber	String	CreditCard	No	Depends on Credit card types	{12 - 19}	Mandatory string between 12 and 19 symbols, representing a valid creditcard number	16000 16001
payment.expiryMonth	String	CreditCard	No	['01', '02', '03', '04', '05', '06', '07', '08', '09', '10', '11', '12']	2	Mandatory numeric string between 01 and 12 representing the month in a valid creditcard expiry date. Must be greater than current date.	16004 16005
payment.expiryMonth AND payment.expiryYear	Validation	CreditCard	No	Expiry Year must be greater than currentYear and Expiry Month must be greater than currentMonth		Valid creditcard expiry date must be greater than current date.	16008
payment.expiryYear	String	CreditCard	No	['01', '02', ..., '99']	2	Mandatory numeric string between 01 and 99, representing the year in a valid creditcard expiry date. Must be greater than current date	16006 16007
payment.iban	String	Sepa	Yes		34	Mandatory string between 22 and 34 characters representing a valid german IBAN (should start with DE)	16012 16013 Bad value for '
payment.verification	String	CreditCard	No	Depends on Credit card types.Not mandatory for maestro.	max. 4	Mandatory numeric string between 3 and 4 representing a valid creditcard verification number.	16002 16003

POST /orders/preauth

Method: POST

URI: /orders/preauth

Parent Error Code (where applicable): 12000 Error while creating order

HTTP status: 400 Bad Request

Overview

Field	Data Type	Required for	Unique	Value Range Length	Length	Expectation	Code
initialAmount	Number	All	No	greater then min. authorizing amount in cents and less then 9999999	7	Integer between 1 and 9999999	12200 12201
currency	String	All	No	Processing, dependent on payment method and merchant configuration	3	Currency code in the range of ISO_4217	12202 12203
product	String	All	No	[creditcard, paypal, paydirekt, ratepay-invoice, ratepay-directdebit, ratepay-installment, sofort]	128	one of the following: [creditcard, paypal, paydirekt, ratepay-invoice, ratepay-directdebit, ratepay-installment]	12256 12257 12602 12603
async	Object	PayPal PayDirekt Sofort	No			Object of type async	12204
async.successUrl	String	All	No	Class URL	{6 - 2048}	Mandatory string representing a valid http URL according to: Class URL and UrlValidator	12205 12206
async.failureUrl	String	All	No	Class URL	{6 - 2048}	Mandatory string representing a valid http URL according to: Class URL UrlValidator	12207 12208
async.cancelUrl	String	All	No	Class URL	{6 - 2048}	Mandatory string representing a valid http URL according to: Class URL UrlValidator	12209 12210
terms	Number	Ratepay	No	long		UNIX timestamp in ms	12213 12214
privacy	Number	Ratepay	No	long		UNIX timestamp in ms	12215 12216
description	String	None	No		{1 - 128}	String between 1 and 128 characters	12217
statementDescription	String	None	No		{1 - 128}	String between 1 and 128 characters	12218
basket	Array[item]	Ratepay	No			Array of type 'item'	12219 12220
item.name	String	All(when basket is present)	No		{1 - 128}	String between 1 and 128 characters	12220 12220
item.articleNumber	String	Yes(when basket is present)	No		{1 - 255}	String between 1 and 255 characters	12223 12224
item.totalPrice	Number	Yes when basket is present	No	greater than min. item total price amount in cents and less than 9999999		Number between min. item total price amount in cents and 9999999	12225 12226
item.totalPriceWithTax:	Number	Yes when basket is present	No	Number greater than item Total Price in cents		Number greater than item Total Price in cents	12227 12228
item.tax	Number	Yes when basket is present	No	Number between 0 and 100		Number between 0 and 100	12229 12230
item.unitPrice	Number	Yes when basket is present	No	Number between min. item unit price amount in cents and 9999999		Number between min. item unit price amount in cents and 9999999	12231 12232
item.unitPriceWithTax	Number	Yes when basket is present	No	Number greater than item.unitPrice		Number greater than item unit Price	12233 12234
item.quantity	Number	Yes when basket is present	No	Number between 1 and 9999999		Number between 1 and 9999999	12235 12236
customer	String	Ratepay	Yes	Additional required fields for ratepay: email	20	Unique string representing a customer reference. May contain numbers, letters, dashes and underscores.	12237 12238 12239 4020
persona	String	Ratepay	Yes	Additional required fields for ratepay: birthday and at least phone or mobile	20	Unique string representing a persona reference. May contain numbers, letters, dashes and underscores.	12240 12240 12240 12243 8020
billingAddress	String	Ratepay	Yes		20	unique string representing a shipping reference. May contain numbers, letters, dashes and underscores.	12244 12245
shippingAddress	String	Ratepay	Yes		20	Unique string representing a shipping Address reference. May contain numbers, letters, dashes and underscores.	12246 12247 6020
ipAddress	String	No	No	IPv4 - IPv6	255	String with length of 255 representing a valid ip address according to: InetAddressValidator	12248 12249 6020
channel	String	No	No	[ MOTO, ECOM ]	128	String in range [MOTO, ECOM]	12250 12251
source	String	No	No		{1 - 128}	String between 1 and 128 characters	12252
payment	Object	CreditCardRatePaySepa	No			Object of type payment	12258 12259
payment.riskIdentId	String	Ratepay ECOM	No	string	{1-80}	String between 1 and 80 characters	12264 12265
payment.installmentTotalAmount	Number	Ratepay Installment	No			Number greater than 0	12266 12267
payment.installmentNumber	Number	Ratepay Installment	No			Number greater than 0	12268 12269
payment.installmentAmount	Number	Ratepay Installment	No			Number greater than 0 representing Installment Amount in cents.	12270 12271
payment.lastInstallmentAmount	Number	Ratepay Installment	No			Number greater than 0 representing last Installment Amount in cents.	12272 12273
payment.installmentInterestRate	Float	Ratepay Installment	No			Fractional number representing Interest Rate.	12274 12275
payment.paymentFirstDay	Number	Ratepay Installment - optional	No			Number greater than 0	12276

SAQ A-EP/SAQ A Use Cases

Field	Data Type	Required for	Unique	Length	Expectation	Code
payment.paymentInstrumentId	String	CreditCard, if no credit card payment data provided. Ratepay Direct Debit, if no sepa payment data provided. Not mandatory for Ratepay Installment (see bank-transfer case). Denied for Ratepay Invoice. Denied for PayPal. Denied for PayDirekt. Not mandatory for Sofort. Sepa payment instrument or sepa payment data may be provided. Required for PayPal.	Yes	20	Unique string representing a payment Instrument Id. May contain numbers, letters, dashes and underscores.	12260 12261 12262 12263

Server to Server use case

Field	Data Type	Required for	Unique	Value Range	Length	Expectation	Code
merchantPaymentInstrumentId	String	No	Yes		{1 - 255}	Unique string representing a customer merchant generated unique identifier for a payment instrument.	10205 10206
payment.cardNumber	String	CreditCard	No	Depends on Credit card types	{12 - 19}	Mandatory string between 12 and 19 symbols, representing a valid creditcard number	16000 16001
payment.verification	String	CreditCard	No	Depends on Credit card types.Not mandatory for maestro.	max. 4	Mandatory numeric string between 3 and 4 representing a valid creditcard verification number.	16002 16003
payment.expiryMonth	String	CreditCard	No	['01', '02', '03', '04', '05', '06', '07', '08', '09', '10', '11', '12']	2	Mandatory numeric string between 01 and 12 representing the month in a valid creditcard expiry date. Must be greater than current date.	16004 16005
payment.expiryYear	String	CreditCard	No	['01', '02', ..., '99']	2	Mandatory numeric string between 01 and 99, representing the year in a valid creditcard expiry date. Must be greater than current date	16006 16007
payment.expiryMonth AND payment.expiryYear	Validation	CreditCard	No	Expiry Year must be greater than currentYear and Expiry Month must be greater than currentMonth		Valid creditcard expiry date must be greater than current date.	16008
payment.cardHolder	String	None	No		{3 - 128}	Mandatory string between 3 and 128 characters containing only letters, whitespaces, dots, apostrophes and dashes	16009 16010
payment.bankName	String	None	No		{1 - 255}	String between 1 and 255 characters containging only letters, whitespace and numbers	16011
payment.iban	String	Sepa	Yes		34	Mandatory string between 22 and 34 characters representing a valid german IBAN (should start with DE)	16012 16013 Bad value for '
payment.bic	String	None	No		8 or 11	String from 8 or 11 characters representing a valid BIC	16014
payment.accountHolder	String	None	No		{4 - 128}	String between 4 and 128 characters representing a valid account holder.May contain letters, whitespaces, dots, apostrophes, dashes and numbers.	16016

POST /orders/credit

Method: POST /orders/credit

URI: /orders/credit

Parent Error Code (where applicable): 12000 Error while creating order

HTTP status: 400 Bad Request

Overview

Field	Data Type	Required for	Unique	Value Range	Length	Expectation	Code
initialAmount	Number	All	No	greater then min. authorizing amount in cents and less then 9999999	7	Integer between 1 and 9999999	12200 12201
currency	String	All	No	Processing, dependent on payment method and merchant configuration	3	Currency code in the range of ISO_4217	12202 12203
product	String	All	No	[creditcard]	128	[creditcard]	12256 12257 12602 12603
terms	Number	Ratepay	No	long		UNIX timestamp in ms	12213 12214
privacy	Number	Ratepay	No	long		UNIX timestamp in ms	12215 12216
description	String	None	No		{1 - 128}	String between 1 and 128 characters	12217
statementDescription	String	None	No		{1 - 128}	String between 1 and 128 characters	12218
basket	Array[item]	Ratepay	No			Array of type 'item'	12219 12220
item.name	String	All(when basket is present)	No		{1 - 128}	String between 1 and 128 characters	12220 12220
item.articleNumber	String	Yes(when basket is present)	No		{1 - 255}	String between 1 and 255 characters	12223 12224
item.totalPrice	Number	Yes when basket is present	No	greater than min. item total price amount in cents and less than 9999999		Number between min. item total price amount in cents and 9999999	12225 12226
item.totalPriceWithTax:	Number	Yes when basket is present	No	Number greater than item Total Price in cents		Number greater than item Total Price in cents	12227 12228
item.tax	Number	Yes when basket is present	No	Number between 0 and 100		Number between 0 and 100	12229 12230
item.unitPrice	Number	Yes when basket is present	No	Number between min. item unit price amount in cents and 9999999		Number between min. item unit price amount in cents and 9999999	12231 12232
item.unitPriceWithTax	Number	Yes when basket is present	No	Number greater than item.unitPrice		Number greater than item unit Price	12233 12234
item.quantity	Number	Yes when basket is present	No	Number between 1 and 9999999		Number between 1 and 9999999	12235 12236
customer	String	Ratepay	Yes	Additional required fields for ratepay: email	20	Unique string representing a customer reference. May contain numbers, letters, dashes and underscores.	12237 12238 12239 4020
persona	String	Ratepay	Yes	Additional required fields for ratepay: birthday and at least phone or mobile	20	Unique string representing a persona reference. May contain numbers, letters, dashes and underscores.	12240 12240 12240 12243 8020
billingAddress	String	Ratepay	Yes		20	unique string representing a billing reference. May contain numbers, letters, dashes and underscores.	12244 12245
shippingAddress	String	Rateay	Yes		20	Unique string representing a shipping Address reference. May contain numbers, letters, dashes and underscores.	12246 12247 6020
ipAddress	String	No	No	IPv4 - IPv6	255	String with length of 255 representing a valid ip address according to: InetAddressValidator	12248 12249 6020
channel	String	No	No	[ MOTO, ECOM ]	128	The only possible channel is MOTO	12250 12251
source	String	No	No		{1 - 128}	String between 1 and 128 characters	12252
payment	Object	CreditCardRatePaySepa	No			Object of type payment	12258 12259
payment.riskIdentId	String	Ratepay ECOM	No	string	{1-80}	String between 1 and 80 characters	12264 12265
payment.installmentTotalAmount	Number	Ratepay Installment	No			Number greater than 0	12266 12267
payment.installmentNumber	Number	Ratepay Installment	No			Number greater than 0	12268 12269
payment.installmentAmount	Number	Ratepay Installment	No			Number greater than 0 representing Installment Amount in cents.	12270 12271
payment.lastInstallmentAmount	Number	Ratepay Installment	No			Number greater than 0 representing last Installment Amount in cents.	12272 12273
payment.installmentInterestRate	Float	Ratepay Installment	No			Fractional number representing Interest Rate.	12274 12275
payment.paymentFirstDay	Number	Ratepay Installment - optional	No			Number greater than 0	12276

SAQ A-EP/SAQ A Use Cases

Field	Data Type	Required for	Unique	Length	Expectation	Code
payment.paymentInstrumentId	String	CreditCard, if no credit card payment data provided. Ratepay Direct Debit, if no sepa payment data provided. Not mandatory for Ratepay Installment (see bank-transfer case). Denied for Ratepay Invoice. Denied for PayPal. Denied for PayDirekt. Not mandatory for Sofort. Sepa payment instrument or sepa payment data may be provided. Required for PayPal.	Yes	20	Unique string representing a payment Instrument Id. May contain numbers, letters, dashes and underscores.	12260 12261 12262 12263

Server to Server Use Case

Field	Data Type	Required for	Unique	Value Range	Length	Expectation	Code
merchantPaymentInstrumentId	String	No	Yes		{1 - 255}	Unique string representing a customer merchant generated unique identifier for a payment instrument.	10205 10206
payment.cardNumber	String	CreditCard	No	Depends on Credit card types	{12 - 19}	Mandatory string between 12 and 19 symbols, representing a valid creditcard number	16000 16001
payment.verification	String	CreditCard	No	Depends on Credit card types.Not mandatory for maestro.	max. 4	Mandatory numeric string between 3 and 4 representing a valid creditcard verification number.	16002 16003
payment.expiryMonth	String	CreditCard	No	['01', '02', '03', '04', '05', '06', '07', '08', '09', '10', '11', '12']	2	Mandatory numeric string between 01 and 12 representing the month in a valid creditcard expiry date. Must be greater than current date.	16004 16005
payment.expiryYear	String	CreditCard	No	['01', '02', ..., '99']	2	Mandatory numeric string between 01 and 99, representing the year in a valid creditcard expiry date. Must be greater than current date	16006 16007
payment.expiryMonth AND payment.expiryYear	Validation	CreditCard	No	Expiry Year must be greater than currentYear and Expiry Month must be greater than currentMonth		Valid creditcard expiry date must be greater than current date.	16008
payment.cardHolder	String	None	No		{3 - 128}	Mandatory string between 3 and 128 characters containing only letters, whitespaces, dots, apostrophes and dashes	16009 16010
payment.bankName	String	None	No		{1 - 255}	String between 1 and 255 characters containging only letters, whitespace and numbers	16011
payment.iban	String	Sepa	Yes		34	Mandatory string between 22 and 34 characters representing a valid german IBAN (should start with DE)	16012 16013 Bad value for '
payment.bic	String	None	No		8 or 11	String from 8 or 11 characters representing a valid BIC	16014
payment.accountHolder	String	None	No		{4 - 128}	String between 4 and 128 characters representing a valid account holder.May contain letters, whitespaces, dots, apostrophes, dashes and numbers.	16016

POST - /orders{action} - Validation of Orders

POST /orders/debit

Overview

SAQ A-EP/SAQ A Use Cases

Server to Server Use Case

POST /orders/preauth

Overview

SAQ A-EP/SAQ A Use Cases

Server to Server use case

POST /orders/credit

Overview

SAQ A-EP/SAQ A Use Cases

Server to Server Use Case

What was your feeling about it?