↔ Request/Response parameter
| Type | Condition |
|---|---|
| type | Mandatory |
| delivery-type | Should only be set for addresses with type DELIVERY |
Kind of address
| Type | Condition | Enumeration |
|---|---|---|
| xs:string | Mandatory | - BILLING- DELIVERY |
The billing address is mandatory.
Delivery address is optional. It can contain different recipients. I.e. the first-name, last-name and salutation can differ from the customer's first-name, last-name and salutation.
Deviating delivery addresses must be contractually agreed with Ratepay. Otherwise those transactions will be rejected.
The delivery address can contain a company name, even the purchase order is about B2C.
Kind of delivery-type
| Delivery Type | Condition | Enumeration |
|---|---|---|
| xs:string | Optional, default value is ADDRESS | - ADDRESS - IN_STORE_COLLECT - PICK_UP_BOX - PICK_UP_SHOP |
If delivery type is set for billing address, the value must be ADDRESS.
Delivery type different than ADDRESS must be contractually agreed with Ratepay. Otherwise those transactions will be rejected.
➡ Request Parameter
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Optional: - For delivery address N/A: - For billing address | Length <=100 |
➡ Request Parameter
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Optional for: - delivery address N/A: - For billing address | Length <=45 |
➡ Request Parameter
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Optional for: - delivery address N/A: - For billing address | Length <=100 |
➡ Request Parameter
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Optional for: - delivery address N/A: - For billing address | Length <=100 |
↔ Request/Response parameter
Street name
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Mandatory | Length <=100 |
Street name (normalized)
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Optional | Length <=100 |
➡ Request/Response Parameter
Street number
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Optional | Length <=30 |
If it is not possible to send the street number separately, it may be sent together at the end of the element street.
Street number (normalized)
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Optional | Length <=10 |
➡ Request Parameter
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Optional | Length <=50 |
↔ Request/Response parameter
Postal code
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Mandatory | Length <=10 |
Postal code (normalized)
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Optional | Length <=10 |
↔ Request/Response parameter
City
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Mandatory | Length <=100 |
City (normalized)
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Optional | Length <=100 |
➡ Request Parameter
See XSD File for further information regarding the format.
| Type | Condition | Example value |
|---|---|---|
| countryCodeType | Mandatory | DE |
For compatibility reasons ISO-3166 numeric and alpha 3 are still supported. Don’t use them when performing a new integration.