- Created by PAYONE Admin, last modified by BS PAYONE on 2019-07-01
Introduction
The "debit" request books an outstanding amount to the receivables account. This request can be used instead of the "refund" request. The request offers additional options that are not possible using "refund".
PAYONE Processing
This request is only available with PAYONE Business.
PAYONE Business
The submitted amount is booked as an outstanding payment on the transaction account or credited to said account.
Settlement of balances
The PAYONE Platform can carry out a settlement of balances for you. If a transaction account has a negative balance it can be captured or paid out in case of a positive balance. The means of payment used for the settlement are always the funds that have been deposited during the process.
If you set the parameter "settleaccount" to "no" using the "debit" request, a settlement is not carried out. Only a booking on the transaction account occurs. If you select the value "yes", however, the balance is automatically settled (captured or paid out) by the PAYONE Platform after the request has been carried out.
Please notice that the submitted amount does not necessarily correspond with the open balance which is subsequently captured or paid out. This is always the case if the balance was not settled before issuing the request!
If you only wish to settle the open balance without booking a new payment request enter zero as the amount and set the "settleaccount" value to "yes". This can be useful e.g. for a refund in the event of an overpayment by the customer or can be used for the repeated collection of an unpaid debit payment. Furthermore, the open balance can be collected using a different type of payment. For this purpose the corresponding payment data must be submitted. This process can e.g. be used for a subsequent collection of an invoice via direct debit or credit card.
Payment type | Description | Comments |
---|---|---|
Credit card | The open balance is credited to or drawn from the customer's card. | |
Debit payment | The customer is reimbursed with the open balance | For collecting money and refund: According to the new regulation on the transfer of funds (Geldtransferverordnung) address data (name, street, zip, city) is mandatory for cross border bank transfers (EEA / EWR), e.g.: CH, SM, MC, PM, JE, GG. This is mandatory from 2017-11-19. Please use request “updateuser” to update customers address data. This means that the whole address for bank transfers needs to be provided. |
Online transfer | The customer is reimbursed with the open balance, | For refund for Giropay: According to the new regulation on the transfer of funds (Geldtransferverordnung) address data (name, street, zip, city) is mandatory for cross border bank transfers (EEA / EWR), e.g.: CH, SM, MC, PM, JE, GG. This is mandatory from 2017-11-19. Please use request “updateuser” to update customers address data. This means that the whole address for bank transfers needs to be provided. |
e-wallet | The open balance is credited to the customer's e-wallet account, | |
Prepayment | The customer is reimbursed with the open balance, | For refund: According to the new regulation on the transfer of funds (Geldtransferverordnung) address data (name, street, zip, city) is mandatory for cross border bank transfers (EEA / EWR), e.g.: CH, SM, MC, PM, JE, GG. This is mandatory from 2017-11-19. Please use request “updateuser” to update customers address data. This means that the whole address for bank transfers needs to be provided. |
Invoice | The customer is reimbursed with the open balance, | For refund: According to the new regulation on the transfer of funds (Geldtransferverordnung) address data (name, street, zip, city) is mandatory for cross border bank transfers (EEA / EWR), e.g.: CH, SM, MC, PM, JE, GG. This is mandatory from 2017-11-19. Please use request “updateuser” to update customers address data. This means that the whole address for bank transfers needs to be provided. |
Cash on delivery | The customer is reimbursed with the open balance, | For refund: According to the new regulation on the transfer of funds (Geldtransferverordnung) address data (name, street, zip, city) is mandatory for cross border bank transfers (EEA / EWR), e.g.: CH, SM, MC, PM, JE, GG. This is mandatory from 2017-11-19. Please use request “updateuser” to update customers address data. This means that the whole address for bank transfers needs to be provided. |
Request "debit" | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Common Parameter | Required | Format | Short explanation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+ | Format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ | Sequence number for this transaction within the payment process (1..n), e.g. PreAuthorization: 0, 1. Capture: 1, 2. Capture: 2 Required for multi partial capture (starting with the 2nd capture) Format Permitted values | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ | Gross amount of debit (in smallest currency unit! e.g. cent, max. 19 999 999 99) Credit: amount < 0 Payment request: amount > 0 The amount must be less than or equal to the amount of the outstanding payment request of the corresponding booking. Format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ | Specifies currency for this transaction Format LIST Permitted values ISO 4217 (currencies) 3-letter-codes Samples EUR USD GBP | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- | Dynamic text element on account statements Format (3 lines with 27 characters each) and credit card statements. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- | Use for changes of payment type - only to select new payment type. Format LIST
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- | Use account details from debtor's master data Format LIST
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- | Format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parameter ( PAYONE Business ) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- | Format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- | Type of payment request Format RL Direct debit return fee MG Dunning charge VZ Default interest VD Delivery charges FD Payment request (default for amount > 0) GT Credit (default for amount < 0) RT Returns | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- | Format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- | Format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parameter ( Invoice / prepayment / online transfer - for refunds only )Parameter ( Debit payment - change of type of payment or refund only ) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
o | Format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
o | Bank Identifier Code to be used for payment or to be checked Format BIC is optional for all Bank transfers within SEPA. For Accounts from Banks outside of SEPA, BIC is still required. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
o | Account type/ country for use with BBAN (i.e. bankcode, bankaccount): DE DE: Mandatory with bankcode, bankaccount, optional with IBAN For other countries than DE please use IBAN or IBAN/BIC Format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
o | Account number (BBAN) Format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
o | Sort code (BBAN) (only in DE) Format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
o | A SEPA mandate can be created if a payment is initiated (amount > 0). Can be used to enforce a merchant specific mandate identification. The mandate_identification has to be unique. Format If the mandate_identification is not set PAYONE will create an unique mandate identification (pattern: PO-nnnnnnnnnn). PPS (PAYONE Payment Service): This parameter must not be used! For PPS the PAYONE platform defines the mandate_identification | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- | Account holder Format CHAR(1..50) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parameter ( credit card - change of type of payment only ) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ | Primary account number of credit card Format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ | Card type of credit card Format V Visa 4 M MasterCard A American Express 300-305,3095,36,38,39 601, 64, 65 J JCB O Maestro International *girocard is currently only viable for e-commerce-payments via Apple Pay. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ | Credit card expiry date YYMM Format NUMERIC(4), YYMM | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
o | Format For SAQ A compliance: PAYONE Frontend hosted iFrame must be used. This parameter must not be used. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- | Format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- | Cardholder of credit card. Format CHAR(1..50) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
o | Pseudo primary account number for a credit card. Format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parameter ( BillSAFE, Klarna, module Invoicing ) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- | Merchant's invoice number Format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- | Parameter defines how documents like invoice, credit notes and reminders should be sent to the customer. Format M Postal Mail P PDF (via email) N no delivery | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- | Format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- | Format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- | Format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ | Used with "clearingtype=fnc" to identify Financing type Format RPV Ratepay Open Invoice RPS Ratepay Installments RPP Ratepay Prepayment RPD Ratepay Direct Debit PYV Unzer Invoice PYS Unzer Installment PYM Unzer Monthly PYD Unzer Direct Debit KLV Klarna Checkout Invoice KLS Klarna Checkout Installment | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+ | Parameter it[n] specifies the item type of a shopping cart item. Format LIST Array Array elements [n] starting with [1]; serially numbered; max [400]
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
o | Format Array Array elements [n] starting with [1]; serially numbered; max [400] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
o | Unit gross price of the item in smallest unit! e.g. cent Format NUMERIC(10) max. 19 999 999 99 Array Array elements [n] starting with [1]; serially numbered; max [400] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
o | Format Array Array elements [n] starting with [1]; serially numbered; max [400] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
o | Description of this item. Will be printed on documents to customer. Format Array Array elements [n] starting with [1]; serially numbered; max [400] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- | Format Array Array elements [n] starting with [1]; serially numbered; max [400] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- | Format Array Array elements [n] starting with [1]; serially numbered; max [400] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- | Format Array Array elements [n] starting with [1]; serially numbered; max [400] |
Response "debit" | |||||||||
---|---|---|---|---|---|---|---|---|---|
Common Parameter | Required | Format | Comment | ||||||
status | + | Default | APPROVED / ERROR | ||||||
Parameter (APPROVED) | |||||||||
+ | Format | ||||||||
+ | Format | ||||||||
Parameter (ERROR) | |||||||||
+ | In case of error the PAYONE Platform returns an error code for your internal usage. Format | ||||||||
- | In case of error the PAYONE Platform returns an error message for your internal usage. Format | ||||||||
- | The customermessage is returned to your system in order to be displayed to the customer. (Language selection is based on the end customer's language, parameter "language") Format |
Content
- No labels