Profile Request
The profile-request allows the merchant to read the stored configuration for his merchant profile.
Request Parameters
<head>
Section
Parameter | Condition | Restriction |
---|---|---|
system-id |
Mandatory | |
operation |
Mandatory | PROFILE_REQUEST |
credential |
Mandatory |
The PAYMENT_INIT request do not contain a <content>
section.
XML Example
<?xml version="1.0" encoding="UTF-8"?>
<request version="1.0" xmlns="urn://www.ratepay.com/payment/1_0">
<head>
<system-id>myshop</system-id>
<operation>PROFILE_REQUEST</operation>
<credential>
<profile-id>INTEGRATION_TE_DACH</profile-id>
<securitycode>4c0a11923fa3433fb168f9c7176429e9</securitycode>
</credential>
</head>
</request>
Response Parameters
<head>
Section
Parameter | Condition | Restriction |
---|---|---|
system-id |
Mandatory | |
operation |
Mandatory | PROFILE_REQUEST |
response-type |
Mandatory | success: STATUS_RESPONSE failure: STATUS_ERROR |
processing |
Mandatory |
<content>
Section
The <content>
section of the PROFILE_REQUEST response contains the requested profile information splitted in the sections master-data
and if applicable installment-configuration-result
and b2b-configuration-result
.
master-data
Parameter | Enumeration | Comment |
---|---|---|
profile-id |
name of requested profile | Name of requested profile-id |
merchant-name |
Name of merchant | |
shop-name |
Name of web shop | |
merchant-status |
1 = not active 2 = active |
Merchant status |
activation-status-invoice |
1 = not active 2 = active 3 = phased out (no new orders are allowed but existing orders can be updated [e.g. capture or refund]) |
Status of payment method invoice |
activation-status-installment |
see activation-status-invoice | Status of payment method instalment |
activation-status-elv |
see activation-status-invoice | Status of payment method direct debit |
activation-status-prepayment |
see activation-status-invoice | Status of payment method prepayment |
eligibility-ratepay-invoice |
"yes" = payment method active "no" = payment method not active |
Status of payment method invoice |
eligibility-ratepay-installment |
see eligibility-ratepay-invoice | Status of payment method instalment |
eligibility-ratepay-elv |
see eligibility-ratepay-invoice | Status of payment method direct debit |
eligibility-ratepay-prepayment |
see eligibility-ratepay-invoice | Status of payment method prepayment |
eligibility-ratepay-pq-light |
[deprecated] | [deprecated] |
eligibility-ratepay-pq-full |
"yes" = available "no" = not available |
Status of IBS (integrated payment management) / is the PAYMENT_QUERY usable |
tx-limit-invoice-min |
type Decimal | Minimum shopping basket amount for invoice |
tx-limit-invoice-max |
type Decimal | Maximum shopping basket amount for invoice |
tx-limit-elv-max |
type Decimal | Maximum shopping basket amount for direct debit |
tx-limit-elv-max-b2b |
type Decimal | Maximum shopping basket amount for direct debit B2B customers |
tx-limit-prepayment-min |
type Decimal | Minimum shopping basket amount for prepayment |
tx-limit-prepayment-max |
type Decimal | Maximum shopping basket amount for prepayment |
tx-limit-prepayment-max-b2b |
type Decimal | Maximum shopping basket amount for prepayment B2B customers |
b2b-invoice |
"yes" = allowed "no" = not allowed |
are B2B orders for payment method invoice are allowed |
delivery-address-invoice |
"yes" = allowed "no" = not allowed |
is a different delivery address for the payment method invoice allowed |
b2b-installment |
see b2b-invoice | b2b-invoice |
delivery-address-installment |
see delivery-address-invoice | see delivery-address-invoice |
b2b-elv |
see b2b-invoice | see b2b-invoice |
delivery-address-elv |
see delivery-address-invoice | see delivery-address-invoice |
b2b-prepayment |
see b2b-invoice | see b2b-invoice |
delivery-address-prepayment |
see delivery-address-invoice | see delivery-address-invoice |
b2b-PQ-light |
[deprecated] | [deprecated] |
delivery-address-PQ-light |
[deprecated] | [deprecated] |
b2b-PQ-full |
see b2b-invoice | see b2b-invoice |
delivery-address-PQ-full |
see delivery-address-invoice | see delivery-address-invoice |
country-code-billing |
enumeration of countries | List of allowed countries (reference billing address) |
country-code-delivery |
enumeration of countries | List of allowed countries (reference delivery address) |
currency |
enumeration of allowed currencies | List of allowed currencies e.g. EUR or CHF |
installment-configuration-result (if applicable)
Parameter | Enumeration | Comment |
---|---|---|
interestrate-min |
decimal | Minimum value of percentage applied to the loan drawn down |
interestrate-default |
decimal | Default value of percentage applied to the loan drawn down |
interestrate-max |
decimal | Maximum value of percentage applied to the loan drawn |
interest-rate-merchant-towards-bank |
decimal | The interest-rate defined contractually between the merchant and factoring entity |
month-number-min |
integer | Minimum duration in months |
month-number-max |
integer | Maximum duration in months |
month-longrun |
deprecated | deprecated |
amount-min-longrun |
deprecated | deprecated |
month-allowed |
string | Comma separated list of allowed durations, stated in months e.g. 3,6,9,12,24 |
valid-payment-firstdays |
string | Comma separated list of calendar days which are allowed as starting days of the installment plan: 2 (direct-debit) 28 (bank transfer) 2,28 (both options are possible) |
payment-firstday |
string | Default calendar day of the first payment |
payment-amount |
decimal | Minimum shopping basket amount incl. shipping |
payment-lastrate |
decimal | Partial amount due in the last month |
rate-min-normal |
decimal | Minimum monthly instalment due |
rate-min-longrun |
deprecated | deprecated |
service-charge |
decimal | In case of payment by instalments, additional costs of financing |
min-difference-dueday |
integer | Minimum difference in days until due date |
b2b-configuration-result (if applicable)
This section contains information about the optional and mandatory fields per company type.
XML Example
<response xmlns="urn://www.ratepay.com/payment/1_0" version="1.0">
<head>
<system-id>myshop</system-id>
<operation>PROFILE_REQUEST</operation>
<response-type>PROFILE_SETTINGS</response-type>
<external />
<processing>
<timestamp>2020-04-27T10:13:04.000</timestamp>
<status code="OK">Successfully</status>
<reason code="306">Profile read successful</reason>
<result code="500">Profile processed</result>
</processing>
</head>
<content>
<master-data>
<profile-id>INTEGRATION_TE_DACH</profile-id>
<merchant-name>INTEGRATION_TE_DACH</merchant-name>
<shop-name>INTEGRATION_TE_DACH</shop-name>
<merchant-status>2</merchant-status>
<activation-status-invoice>2</activation-status-invoice>
<activation-status-installment>2</activation-status-installment>
<activation-status-elv>2</activation-status-elv>
<activation-status-prepayment>2</activation-status-prepayment>
<eligibility-ratepay-invoice>yes</eligibility-ratepay-invoice>
<eligibility-ratepay-installment>yes</eligibility-ratepay-installment>
<eligibility-ratepay-elv>yes</eligibility-ratepay-elv>
<eligibility-ratepay-prepayment>yes</eligibility-ratepay-prepayment>
<eligibility-ratepay-pq-light>yes</eligibility-ratepay-pq-light>
<eligibility-ratepay-pq-full>yes</eligibility-ratepay-pq-full>
<tx-limit-invoice-min>10</tx-limit-invoice-min>
<tx-limit-invoice-max>9999.99</tx-limit-invoice-max>
<tx-limit-invoice-max-b2b></tx-limit-invoice-max-b2b>
<tx-limit-installment-min>200</tx-limit-installment-min>
<tx-limit-installment-max>9999.99</tx-limit-installment-max>
<tx-limit-installment-max-b2b></tx-limit-installment-max-b2b>
<tx-limit-elv-min>0</tx-limit-elv-min>
<tx-limit-elv-max>9999.99</tx-limit-elv-max>
<tx-limit-elv-max-b2b></tx-limit-elv-max-b2b>
<tx-limit-prepayment-min>0</tx-limit-prepayment-min>
<tx-limit-prepayment-max>999999</tx-limit-prepayment-max>
<tx-limit-prepayment-max-b2b></tx-limit-prepayment-max-b2b>
<b2b-invoice>yes</b2b-invoice>
<delivery-address-invoice>yes</delivery-address-invoice>
<b2b-installment>no</b2b-installment>
<delivery-address-installment>yes</delivery-address-installment>
<b2b-elv>yes</b2b-elv>
<delivery-address-elv>yes</delivery-address-elv>
<b2b-prepayment>yes</b2b-prepayment>
<delivery-address-prepayment>yes</delivery-address-prepayment>
<b2b-PQ-light>no</b2b-PQ-light>
<delivery-address-PQ-light>no</delivery-address-PQ-light>
<b2b-PQ-full>no</b2b-PQ-full>
<delivery-address-PQ-full>no</delivery-address-PQ-full>
<country-code-billing>DE,NL,AT,CH</country-code-billing>
<country-code-delivery>DE,NL,CH,AT</country-code-delivery>
<currency>EUR,CHF</currency>
</master-data>
<installment-configuration-result name="INTEGRATION_TE_DACH" type="DEFAULT">
<interestrate-min>13.7</interestrate-min>
<interestrate-default>13.7</interestrate-default>
<interestrate-max>13.7</interestrate-max>
<interest-rate-merchant-towards-bank>13.7</interest-rate-merchant-towards-bank>
<month-number-min>3</month-number-min>
<month-number-max>48</month-number-max>
<month-longrun>0</month-longrun>
<amount-min-longrun>0</amount-min-longrun>
<month-allowed>3,6,12,24,36,48</month-allowed>
<valid-payment-firstdays>28</valid-payment-firstdays>
<payment-firstday>28</payment-firstday>
<payment-amount>200</payment-amount>
<payment-lastrate>0</payment-lastrate>
<rate-min-normal>20</rate-min-normal>
<rate-min-longrun>0</rate-min-longrun>
<service-charge>0</service-charge>
<min-difference-dueday>28</min-difference-dueday>
</installment-configuration-result>
<b2b-configuration-result>
<country code="DE">
<company-type-definitions>
<company type="GMBH" label="GmbH" description="">
<fields-optional>
<value>1</value>
<value>2</value>
<value>3</value>
<value>6</value>
<value>8</value>
<value>9</value>
<value>10</value>
<value>11</value>
<value>12</value>
</fields-optional>
<fields-mandatory>
<value>7</value>
</fields-mandatory>
</company>
<company type="GMBH-I-GR" label="GmbH i.Gr." description="GmbH in Gründung">
<fields-optional>
<value>3</value>
<value>6</value>
</fields-optional>
<fields-mandatory>
<value>7</value>
</fields-mandatory>
</company>
<company type="GGMBH" label="gGmbH" description="Gemeinnützige GmbH">
<fields-optional>
<value>1</value>
<value>2</value>
<value>3</value>
<value>6</value>
<value>8</value>
<value>9</value>
<value>10</value>
<value>11</value>
<value>12</value>
</fields-optional>
<fields-mandatory>
<value>7</value>
</fields-mandatory>
</company>
<company type="GMBH-CO-KG" label="GmbH & Co. KG" description="">
<fields-optional>
<value>1</value>
<value>2</value>
<value>3</value>
<value>6</value>
<value>8</value>
<value>9</value>
<value>10</value>
<value>11</value>
<value>12</value>
</fields-optional>
<fields-mandatory>
<value>7</value>
</fields-mandatory>
</company>
<company type="OHG" label="OHG" description="">
<fields-optional>
<value>1</value>
<value>2</value>
<value>3</value>
<value>6</value>
</fields-optional>
<fields-mandatory>
<value>7</value>
</fields-mandatory>
</company>
<company type="KG" label="KG" description="">
<fields-optional>
<value>1</value>
<value>2</value>
<value>3</value>
<value>6</value>
<value>8</value>
<value>9</value>
<value>10</value>
<value>11</value>
<value>12</value>
</fields-optional>
<fields-mandatory>
<value>7</value>
</fields-mandatory>
</company>
<company type="EV" label="e.V." description="Eingetragener Verein">
<fields-optional>
<value>2</value>
<value>3</value>
<value>4</value>
<value>6</value>
</fields-optional>
<fields-mandatory>
<value>7</value>
</fields-mandatory>
</company>
<company type="EG" label="e.G." description="Eingetragene Genossenschaft">
<fields-optional>
<value>2</value>
<value>3</value>
<value>5</value>
<value>6</value>
</fields-optional>
<fields-mandatory>
<value>7</value>
</fields-mandatory>
</company>
<company type="AG" label="AG" description="">
<fields-optional>
<value>1</value>
<value>2</value>
<value>3</value>
<value>6</value>
<value>8</value>
<value>9</value>
<value>10</value>
<value>11</value>
<value>12</value>
</fields-optional>
<fields-mandatory>
<value>7</value>
</fields-mandatory>
</company>
<company type="UG" label="UG" description="Unternehmergesellschaft">
<fields-optional>
<value>1</value>
<value>2</value>
<value>3</value>
<value>6</value>
<value>8</value>
<value>9</value>
<value>10</value>
<value>11</value>
<value>12</value>
</fields-optional>
<fields-mandatory>
<value>7</value>
</fields-mandatory>
</company>
<company type="UG-I-GR" label="UG i.Gr." description="Unternehmergesellschaft in Gründung">
<fields-optional>
<value>3</value>
<value>6</value>
</fields-optional>
<fields-mandatory>
<value>7</value>
</fields-mandatory>
</company>
<company type="EINZELUNTERNEHMEN" label="Einzelunternehmen" description="">
<fields-optional>
<value>3</value>
<value>6</value>
</fields-optional>
<fields-mandatory>
<value>7</value>
<value>13</value>
</fields-mandatory>
</company>
<company type="EK" label="e.K." description="Eingetragener Kaufmann">
<fields-optional>
<value>1</value>
<value>2</value>
<value>3</value>
<value>6</value>
<value>8</value>
<value>9</value>
<value>10</value>
<value>11</value>
<value>12</value>
</fields-optional>
<fields-mandatory>
<value>7</value>
</fields-mandatory>
</company>
<company type="PARTNERSCHAFT" label="Partnerschaft" description="">
<fields-optional>
<value>2</value>
<value>3</value>
<value>6</value>
<value>8</value>
<value>9</value>
<value>10</value>
<value>11</value>
<value>12</value>
<value>14</value>
</fields-optional>
<fields-mandatory>
<value>7</value>
</fields-mandatory>
</company>
<company type="GBR" label="GbR" description="">
<fields-optional>
<value>3</value>
<value>6</value>
</fields-optional>
<fields-mandatory>
<value>7</value>
</fields-mandatory>
</company>
<company type="AOR" label="Anstalt öffentlichen Rechts" description="">
<fields-optional>
<value>3</value>
<value>6</value>
</fields-optional>
<fields-mandatory>
<value>7</value>
</fields-mandatory>
</company>
<company type="KOR" label="Körperschaft öffentlichen Rechts" description="">
<fields-optional>
<value>3</value>
<value>6</value>
</fields-optional>
<fields-mandatory>
<value>7</value>
</fields-mandatory>
</company>
<company type="STIFTUNG" label="Stiftung" description="">
<fields-optional>
<value>3</value>
<value>6</value>
</fields-optional>
<fields-mandatory>
<value>7</value>
</fields-mandatory>
</company>
<company type="OTHER" label="andere" description="Sammeltyp für alle anderen Gesellschaftsformen">
<fields-optional>
<value>3</value>
<value>6</value>
</fields-optional>
<fields-mandatory>
<value>7</value>
</fields-mandatory>
</company>
</company-type-definitions>
<element-definitions>
<element index="1" apiattr="customer:company-id" description="">Handelsregisternummer</element>
<element index="2" apiattr="customer:registry-location" description="">Sitz Registergericht</element>
<element index="3" apiattr="customer:homepage" description="">Homepage</element>
<element index="4" apiattr="customer:company-id" description="">Vereinsregisternummer</element>
<element index="5" apiattr="customer:company-id" description="">Genossenschaftsregisternummer</element>
<element index="6" apiattr="customer:vat-id" description="">Umsatzsteuer-ID</element>
<element index="7" apiattr="customer:contacts:phone" description="">Telefonnummer</element>
<element index="8" apiattr="customer:adresses(REGISTRY):street" description="">Meldeadresse/Reg: Straße</element>
<element index="9" apiattr="customer:adresses(REGISTRY):street-number" description="">Meldeadresse/Reg: Hausnummer</element>
<element index="10" apiattr="customer:adresses(REGISTRY):zip-code" description="">Meldeadresse/Reg: PLZ</element>
<element index="11" apiattr="customer:adresses(REGISTRY):city" description="">Meldeadresse/Reg: Stadt</element>
<element index="12" apiattr="customer:adresses(REGISTRY):country-code" description="">Meldeadresse/Reg: Land</element>
<element index="13" apiattr="customer:date-of-birth" description="">Geburtsdatum</element>
<element index="14" apiattr="customer:company-id" description="">Partnerschaftsregisternummer</element>
<element index="15" apiattr="customer:company-id" description="">Registernummer</element>
<element index="16" apiattr="customer:company-id" description="">Firmenbuchnummer (FN)</element>
</element-definitions>
</country>
</b2b-configuration-result>
</content>
</response>