Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Date:

Author:

Version:

Changes:

Completed

Available in version (tag)

Ext.

Int.

Is in Core

 


 

 


 

1.0

Doc. created

Yes

 

 

 

 

1.1Added Pay per email parameter entryYes    
1.2Added new parameter tree entries to support the configuration of additional service NotificationYes    
1.3Fix to avoid creating empty files if all of the payments in a invoice batch are rejectedYes1.4.2   

Terms and Definitions:

Terms/definitions:

Meaning:

TBD

To be defined

N/A

Not applicable

...

  1. First run the Buckaroo Request Generator engine. If all of the payments for a run are rejected and no payments need to be sent to Buckaroo, the corresponding BUCKAROO_REQUEST_HEADER_BPE3  and/or BUCKAROO_NOTIFICTN_HEADER_BPE3 record(s) will be set to STATUS = 3 (STATUS_EMPTY). 
  2. Then run the File Processor Generator engine instance. The file processor engine will create a file only if the request engine processed the data successfully, and the DB tables contain some records ready to be processedsuccessfully, and the BUCKAROO_REQUEST_HEADER_BPE3  and/or BUCKAROO_NOTIFICTN_HEADER_BPE3 tables contain some records in STATUS = 1 (READY_TO_PROCESS) . Please note that it is possible to configure the layout of request file (i.e. which of the fields should be present and at which position in the request record) by using the File processor generator configuration. 
    For example: It is possible skip adding the PayperEmail fields to the request record in the file even if they are present in the BUCKAROO_REQUEST_RECORD_BPE3 table. 

...

Name:

ACCOUNT_PAYMENT_REQUEST

Description:

Each record represents a direct debit payment request. The InvoiceHandlerEngine will create an  account payment request record for each invoice that is successfully closed. The Buckaroo Request Generator engine will then read the payment requests in this table that are ready for capture and inserts the required payment data into buckaroo tables mentioned below.
NOTE: For BPE2, the ACCOUNT_PAYMENT records are created during the invoice close process i.e. one ACCOUNT_PAYMENT for every closed invoice and the BPE2 request generator reads the data from the ACCOUNT_PAYMENT table. But for BPE3, a new payment solution is implemented to handled various types of payments (like partial payments, creditnotes, write offs etc..). As per this new solution, the invoice close process will not create ACCOUNT_PAYMENT records. It will create ACCOUNT_PAYMENT_REQUEST records which are used by the Buckaroo BPE3 request generator. The ACCOUNT_PAYMENT records are created by the Buckaroo BPE3 Response reader (Capture) engine when the response file from Buckaroo is processed. For every successfully processed payment response, an ACCOUNT_PAYMENT and an INVOICE_PAYMENT record will be created. So with BPE3 solution, there will be one-to-one relation between InvoicePayments and AccountPayments.

 

 

Name:

BUCKAROO_REQUEST_HEADER_BPE3

Description:

Each record represents a header which holds reference to the record data needed to generate a payment request file. Each header entry can have one or more corresponding request records in BUCKAROO_REQUEST_RECORD_BPE3 table. So for each record (not in ERROR with STATUS = 1 (i.e. in READY_TO_PROCESS status) in this table, a payment file will be generated and sent to the Buckaroo containing the information like name of the file, status, file generation date, number of records in the file etc.

 

 

Name:

BUCKAROO_REQUEST_RECORD_BPE3

Description:

Each record represents a a payment record in the payment request file. Each record in this table contains actual payment information like amount, VAT, user info like name, bank account info, address etc.

  

Name:

BUCKAROO_NOTIFICTN_HEADER_BPE3

Description:

Each record represents a header which holds reference to the record data needed to generate a seaparte pre-notification file. Each header entry can have one or more corresponding notification records in BUCKAROO_REQUEST_RECORD_BPE3 table. So for each record (not in ERROR w ith STATUS = 1 (i.e. in READY_TO_PROCESS status) in this table, a pre-notification file (containing the information like customer name, email, type of notification used, communication method used and the date of sending the notification) in the file etc.) will be generated and sent to the Buckaroo. Please note that this table will be used only if separate notification files need to be created.

...