address
↔ Request/Response parameter
<address>
| Type | Condition |
|---|---|
| type | Mandatory |
| delivery-type | Should only be set for addresses with type DELIVERY |
<address@type>
Kind of address
| Type | Condition | Enumeration |
|---|---|---|
| xs:string | Mandatory | - BILLING- DELIVERY |
warning
The billing address is mandatory.
attention
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.
danger
Deviating delivery addresses must be contractually agreed with Ratepay. Otherwise those transactions will be rejected.
success
The delivery address can contain a company name, even the purchase order is about B2C.
<address@delivery-type>
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 |
warning
If delivery type is set for billing address, the value must be ADDRESS.
danger
Delivery type different than ADDRESS must be contractually agreed with Ratepay. Otherwise those transactions will be rejected.
address > company
➡ Request Parameter
<company>
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Optional: - For delivery address N/A: - For billing address |
Length <=100 |
address > salutation
Salutation of delivery addressee, e.g. "Mr." or "Mrs."
➡ Request Parameter
<salutation>
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Optional for: - delivery address N/A: - For billing address |
Length <=45 |
address > first-name
First name of delivery addressee
➡ Request Parameter
<first-name>
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Optional for: - delivery address N/A: - For billing address |
Length <=100 |
address > last-name
Last name of delivery addressee
➡ Request Parameter
<last-name>
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Optional for: - delivery address N/A: - For billing address |
Length <=100 |
address > street
↔ Request/Response parameter
<street>
Request
Street name
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Mandatory | Length <=100 |
Response
Street name (normalized)
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Optional | Length <=100 |
address > street-number
➡ Request/Response Parameter
<street-number>
Request
Street number
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Optional | Length <=30 |
attention
If it is not possible to send the street number separately, it may be sent together at the end of the element street.
Response
Street number (normalized)
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Optional | Length <=10 |
address > street-additional
➡ Request Parameter
<street-additional>
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Optional | Length <=50 |
address > zip-code
↔ Request/Response parameter
<zip-code>
Request
Postal code
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Mandatory | Length <=10 |
Response
Postal code (normalized)
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Optional | Length <=10 |
address > city
↔ Request/Response parameter
<city>
Request
City
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Mandatory | Length <=100 |
Response
City (normalized)
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Optional | Length <=100 |
address > country-code
ISO-3166 alpha 2
➡ Request Parameter
See XSD File for further information regarding the format.
<country-code>
| Type | Condition | Example value |
|---|---|---|
| countryCodeType | Mandatory | DE |
danger
For compatibility reasons ISO-3166 numeric and alpha 3 are still supported. Don’t use them when performing a new integration.