Api that controls payment per debit. SEPA Debit: With SEPA ( Single Euro Payments Area ) germany will introduce new europe wide unified practices on 01.02.2014 for noncash payments (remittance, debit) The previous practice with bank code and account number will be replaced by IBAN and BIC. IBAN (International Bank Account Number) is the international account number and replaces bank code and account number. For payments across national borders the BIC (Business Identifier Code) is mandatory as a internationally standardised bank code (comparable to the bank code in Germany). For payments / debits within Germany the usage of the IBAN (iban only) is sufficient, for all other transactions the IBAN and BIC are required. For a correct SEPA-Payment following points are important: Mandate (mandateRef), Creditor-ID (creditorId) and Prenotification (Notification about the customer account debit; payDate). Mandate: Parameter names "mandateRef", "mandateSignDate" A Mandate is the authorization of the creditor by the debitor to book an agreed upon amount with a debit. The mandate reference is chosen freely bei the creditor and has to be unique. Usually it will be created by the DebitAPI, see return value at "sessionCreate". If a self generated mandate reference is used, and this mandate does not exist, the booking date of the mandate issuance can be passed. Otherwise it will be determined or rather the date of the sessionApprove call will be used. Recurring-Mandate: Parameter name "mandateRecur", "payRecurState" With "mandateRecur" is used to specify if one "ONEOFF" or one of many debits "RECURRING" will be created. With "FINAL" a existing mandate will be closed if applicable, this means the current mandate will be used for the last time. If a one-time SEPA mandate is created with "ONEOFF", then "payRecurState" will always have the status "OOFF". After this the Mandate Reference must not be used anymore. A Multi-Session returns "FRST" if the mandate is new or "RCUR" if it's already in use. If the mandate was closed with "FINAL" then "payRecurState" will have the value "FNAL". In this case also the Mandate Reference must not be used anymore. Creditor-ID: Parameter name "creditorId" The creditor identification ist a distinct identification of creditors of SEPA Mandates. It is compulsory for all creditors and can be applied for at the Bundesbank for free, see https://extranet.bundesbank.de/scp/ . The creditor ID can be stored in the micropayment control center under "Kundendaten->Gläubiger-Identifikationsnummer". Otherwise the creditor ID will be provided by micropayment. Prenotification: The Customer should be informed about a debit booking (see alos "payDate") in a suitable fashion. A suitable text example could look like following (the placeholders {} should be replaced by the actual values) "Our debit with the amount of {$qamount} will be deducted via SEPA-Debit by Mandate Nr. {$mandateRef} to the Creditor ID {$creditorId} from your account with the IBAN {$iban} at {$bank} BIC {$bic} at the due date {$paydate}. Please ensure that the account is covered." In case of recurring mandates the customer must also be notified before every following direct debit. New sessionCredit: With this function it is possible to perform a payout to a customer without a previous direct debit. This feature must be activated separately, and is only available under strict guidelines. Changes to the EU Funds Transfers Regulation: from the 26.06.2017 forward the EU regulation 2015/847 comes into force. For this it is necessary to determine the addresses of debitors outside of the european economic area (EEA). Currently this only concerns customers in Switzerland. The functionality for this has been added to the methods bankaccountSet, -Get, -Check and bankCheck. For regular customers these informations have to be added, otherwise sessionCreate will return one of the following error codes: 4112, 4113 ------------------------------------------------------------------------------------ All functions that were previously called with the bankcode/account number, can now also be used with the IBAN/BIC. If calls are made without the IBAN the parameter "country" must be supplied. Error codes: 4101 // Bank code is invalid 4102 // Account number is invalid 4103 // No account was provided 4104 // Action has already been acknowledged 4105 // Account has been frozen 4106 // Limit reached 4107 // no open amount or exceeds session amount 4108 // IBAN is invalid 4109 // BIC needed or is invalid 4110 // The payment type is not supported by the target bank 4111 // Banks from this country are not supported 4112 // The information for the account holder are insufficient, the full name is required 4113 // IBAN is not part of the europena economic area, the address of the account holder must be supplied ------------------------------------------------------------------------------------ Notes for the test mode: - Test mode can be activated on each function with the parameter `testMode=1` - for simulating automated internal processes and events, the ...Test-Functions exist. In Order to simulate a complete direct debit with all contingencies the following function calls are needed: - customerCreate (create a customer) - bankaccountSet (create an account reference) - sessionCreate (create a session) - sessionApprove (approve direct debit) - sessionChargeTest (simulate a charge) - sessionReverseTest (simulate a return debit) - sessionRechargeTest (simulate an additional payment) - transactionCreate (book additional payment to your account) - sessionRefund (refund) - sessionRefundReverseTest (simulate the Retour of a refund) - all the regular accounts and following additional accounts exist in test mode, in order to simulate a successful booking: - bankCode: 88888888 - accountNumber: z.B: 1234567890 - iban: z.B: DE89888888881234567890 - bic: TESTDE00XXX (optional) ]]> ]]>