Required Parameters

Required Backend Parameters

Table 1. Backend Required Parameters
Parameter	Data type	Description
`customerId`	Alphanumeric, fixed 7 characters	Unique ID of merchant.
`toolkitPassword`	Alphanumeric with special characters	The password for backend operations using QPAY Checkout Page.
`command`	Alphabetic	Different types of operations to be executed e.g. approveRevarsal.
`language`	Alphabetic, fixed 2 characters	Language for returned texts and error messages.
`requestFingerprint`	Alphanumeric, fixed 7 characters	Computed fingerprint of the parameter values and the secret.

Table 2. Backend Required Parameters
`customerId`
Data	Value
Data type	Alphanumeric, fixed 7 characters
Description	Unique ID of merchant.
`toolkitPassword`
Data	Value
Data type	Alphanumeric with special characters
Description	The password for backend operations using QPAY Checkout Page.
`command`
Data	Value
Data type	Alphabetic
Description	Different types of operations to be executed e.g. approveRevarsal.
`language`
Data	Value
Data type	Alphabetic, fixed 2 characters
Description	Language for returned texts and error messages.
`requestFingerprint`
Data	Value
Data type	Alphanumeric, fixed 7 characters
Description	Computed fingerprint of the parameter values and the secret.

Available Transaction Based Operations

Table 3. approveReversal
Parameter	Data type	Description
`orderNumber`	Numeric, up to 9 digits	Order number of payment.

Table 4. deposit
Parameter	Data type	Description
`orderNumber`	Numeric, up to 9 digits	Order number of payment.
`amount`	Amount	Deposited amount.
`currency`	Alphabetic or numeric, fixed 3 characters	Currency code of amount.

Table 5. depositReversal
Parameter	Data type	Description
`orderNumber`	Numeric, up to 9 digits	Order number of payment.
`paymentNumber`	Numeric, up to 9 digits	Payment number which is typically the same as the order number.

Table 6. getOrderDetails
Parameter	Data type	Description
`orderNumber`	Numeric, up to 9 digits.	Order number of payment.

Table 7. recurPayment
Parameter	Data type	Description
`amount`	Amount	Debit amount.
`currency`	Alphabetic or numeric, fixed 3 characters	Currency code of amount.
`orderDescription`	Alphanumeric, up to 255 characters.	Textual description of order.
`sourceOrderNumber`	Numeric, up to 9 digits.	Original order number used for a new payment.

Table 8. refund
Parmeter	Data type	Description
`orderNumber`	Numeric, fixed 9.	Order number of payment.
`amount`	Amount	Debit amount.
`currency`	Alphabetic or numeric, fixed 3 characters	Currency code of amount.

Table 9. refundReversal
Parameter	Data type	Description
`orderNumber`	Numeric, up to 9 digits	Order number of payment.
`creditNumber`	Numeric, up to 9 digits	Credit number which has to be canceled.

Table 10. transferFund
Parameter	Data type	Description
`bankBic`	Alphanumeric, 8 to 11 characters.	BIC of bank.
`bankAccountIban`	Alphanumeric, 16 to 34 characters.	IBAN of account.
`bankAccountOwner`	Alphanumeric with special characters, 1 to 255	Name of owner of account.
`fundTransferType`	String with value "SEPA-CT".	Fund transfer type SEPA-CT.