Optional Backend Parameters

Optional Backend Parameters

Table 1. Backend Optional Request Parameters
Parameter	Data type	Description
`shopId`	Alphanumeric, 16 characters	Unique ID of the online shop if several configurations are used within one `customerId`.

Table 2. Additional Optional Request Parameters For Recurring Payments
Parameter	Data type	Description
`merchantTokenizationFlag`	Boolean	Sets whether credit card details are stored for later use.
`periodicType`	Enumeration	Sets the periodic type of initial and recurring payments.

Table 3. Additional Optional Request Parameters For Recurring Payments
`merchantTokenizationFlag`
Data	Value
Data type	Boolean
Description	Sets whether credit card details are stored for later use.
`periodicType`
Data	Value
Data type	Enumeration
Description	Sets the periodic type of initial and recurring payments.

Available Transaction Based Operations

Table 4. deposit
Parameters	Within fingerprint	Data type	Description
`merchantReference`	Required	ASCII up to 128 characters, but may differ for specific payment methods.	Unique order reference ID sent from merchant to financial institution.
`customerStatement`	Required	Alphanumeric up to 254 characters that may be restricted for specific payment methods.	Text displayed on bank statement issued to the consumer by the financial service provider.

When multiple deposits and refunds are made the orderReference may not suffice as a sole reference, so the additional reference for each operation can therefore be set with the parameter merchantReference.

Table 5. deposit
`merchantReference`
Data	Value
Within fingerprint	Required if used.
Data type	ASCII up to 128 characters, but may differ for specific payment methods.
Description	Unique order reference ID sent from merchant to financial institution.
`customerStatement`
Data	Value
Within fingerprint	Required if used.
Data type	Alphanumeric up to 254 characters that may be restricted for specific payment methods.
Description	Text displayed on bank statement issued to the consumer by the financial service provider.

Table 6. recurPayment
Parameter	Data type	Description
`autoDeposit`	Enumeration	Possible values: `Yes` and `No`. `Yes` is used for enabling and `No` for disabling automated deposit and day-end closing of payments. If the feature `Nightcatpure` is active for the `customerId`, the payments will be deposited in the night at the latest, even if `autoDeposit=no` is sent for a recurring payment!
`customerStatement`	Alphanumeric, up to 254 characters that may be restricted for specific payment methods.	Text displayed on bank statement issued to the consumer by the financial service provider.
`orderNumber`	Numeric, up to 9 digits.	Order number of payment.
`orderReference`	Alphanumeric, up to 128 characters.	Unique order reference ID sent from merchant to financial institution.

Table 7. recurPayment
`autoDeposit`
Data	Value
Data type	Enumeration
Description	Possible values: `Yes` and `No`. `Yes` is used for enabling and `No` for disabling automated deposit and day-end closing of payments. If the feature `Nightcatpure` is active for the `customerId`, the payments will be deposited in the night at the latest, even if the merchant sends `autoDeposit=no` for a recurring payment!
`customerStatement`
Data	Value
Data type	Alphanumeric, up to 254 characters that may be restricted for specific payment methods.
Description	Text displayed on bank statement issued to the consumer by the financial service provider.
`orderNumber`
Data	Value
Data type	Numeric, up to 9 digits.
Description	Order number of payment.
`orderReference`
Data	Value
Data type	Alphanumeric, up to 128 characters.
Description	Unique order reference ID sent from merchant to financial institution.