03 Oct 2013

KTH

0.1

Doc created.

10 Feb 2014

KTH

0.2

Added PayPerEmail field descriptions

websitekey

-

FSsfaJKF&6GH

Buckaroo Websitekey.
Fixed string from Buckaroo portal

amount 

invoice.TOTAL_EXCL_VAT + invoice.TOTAL_VAT – invoice.PAYED_AMOUNT

10.00 

REAL, 2 decimals; amount

culture 

-

nl-NL

String, ISO culture code

currency 

-

EUR

Fixed string for currency code

description 

<Description Prefix> + account_payment.REFERENCE

Test Incasso 1

String; description, max length 100 chars

service 

-

Directdebitrecurring

String; Buckaroo service name

invoicenumber 

invoice.INVOICE_NUMBER

Test01923r4e

String; Invoice number, max length 100 chars

service_directdebitrecurring_action

-

Pay

String; Pay or Refund (See Buckaroo service description)

service_directdebitrecurring_customeraccountnumber

Billing_group_bank_account.BANK_ACCOUNT_NUMBER

123456789

Bank Account; Must be 11 proof. Empty or null value not allowed

service_directdebitrecurring_customeraccountname 

users.FIRST_NAME + <space> + users.LAST_NAME

T.Test

String; account name

additional_service 

-

Creditmanagement

String; see Buckaroo Service description 

If more than one additional service is used, this field will contain a comma separated list of names of all the additional services used.

For example: Creditmanagement,Notification

service_creditmanagement_action 

-

Invoice

Fixed String

phonenumber 

users.PHONE1

0201111111

String; Phone number

customerlastname 

users.LAST_NAME

Tester

String; customer last name, max 200 chars

service_creditmanagement_customeraccountnumber 

Billing_group_bank_account.BANK_ACCOUNT_NUMBER

123456789

Bank account; must be 11-proof. Empty or null value not allowed.
Will be same as service_directdebitrecurring_customeraccountnumber, but must be repeated

customergender 

users.GENDER

1

Integer, may not be empty
0: Unknown
1: Male
2: Female
9: Irrelevant  (currently not used)

amountvat 

-

0.00

Real, 2 decimals
Example: 
Value for amount = 1000. 
Value for invoicevat will be: 
1000 * 0.19 = 190 Euro cents

service_creditmanagement_maxreminderlevel 

-

1

INTEGER, may not be empty. Choose from (0,1,2,3,4). Default is 4

invoicedate 

invoice.CLOSE_DATE

2012-01-10

YYYY-MM-DD; Invoice date

service_creditmanagement_customerbirthdate 

users.BIRTHDAY

1970-01-13

YYYY-MM-DD; Birth date

service_creditmanagement_paymentmethodsallowed 

-

machtiging,ideal

String; Comma separated list of allowed methods of payment as offered by Buckaroo. See Buckaroo Service description for possible values

datedue 

invoice.CLOSE_DATE + <due date off set>

2012-01-27

YYYY-MM-DD; due date

customertype 

-

1

String; type of customer
Currently not used

faxnumber 

users.FAX

0309999999

String; Fax number

customeremail 

users.EMAIL

support@buckaroo.nl

String; customer email address

customerfirstname 

users.FIRST_NAME

Test

String; Customer first name

mobilephonenumber 

service.PHONE_NUMBER

0601111111

String; mobile number

customerinitials 

-

T.

String; optional , currently not used  

customertitle 

users.TITLE

2

String; customer title

customercode 

account.CUSTOMER_NUMBER

55225522

String; Customer rator account number

customerlastnameprefix 

-

de

String; optional , currently not used

address_street_1 

users.STREET

Hoofdstraat

String; street name

address_housenumber_1 

users.STREET_NUMBER

1

Integer; House number

address_housenumbersuffix_1 

users.FLOOR

b

String; House number suffix

address_zipcode_1 

users.ZIP

1000 AA

String, Zipcode, always in DDDD<space>CC format

address_city_1 

users.CITY

Amsterdam

String; City (in All capital letters)

address_state_1 

users.PROVINCE

Noord-Holland

String; province

address_country_1 

-

NL

String; country

Created

Transaction date, i.e. payment date

Date format: YYYY-MM-DD HH:MM:SS
Ex: 2013-10-17 16:40:24

Website 

Fixed string

String

Payment type

Payment type code and description indicating the 
type of the payment

4 Character payment type code followed by a payment type string .
Ex: 
C021 - iDeal
C561 - Melding Onterechte Incasso
C102 - Refund - Machtiging

Account number

Customer bank account number

String; IBAN bank account number

Customer

Customer name

String; customer name

Invoice number

invoice number

Customer invoice number

Description

Description of the payment

String

Amount Debit

Amount debited from customer account 

REAL; 2 decimals (amount in EURO)

Amount credit

Amount credited from customer account

REAL; 2 decimals (amount in EURO)

Currency

Currency code

Fixed String "EUR"

Status

Status of the payment transaction

BPE3 status code
Ex: 
190
490
791 etc.

Status date

Date of the last status update

Date format: YYYY-MM-DD HH:MM:SS 
Ex: 2013-10-17 16:40:24

Success

String representation of boolean indicating whether the
payment is successful or not.

String; true/false

Reversal reason

Reason for the payment reversal

String
Ex: ADMINISTRATIEVE REDEN

Country

Country

String

Transaction key

Payment transaction Key

String

IP Address

IP address

String

status code

•  190 - Success: The payment is processed successfully.
• 490 - Failed: The transaction failed.  
• 491 - Validation failed: The transaction request contained errors and could not be processed properly.
• 492 - Technical error: Due to a technical fault the transaction could not be completed.
• 690 - Rejected: The transaction is rejected by the (third party) payment provider.
• 790 - Pending entry: The transaction is on hold while the payment engine is waiting for input from consumers.
• 791 - Pending processing: The transaction will be processed.
• 792 - Awaiting the consumer: the payment Engine waits for consumers to return back from a third-party website,                                                        which is needed to complete the transaction.
• 793 - The transaction is on hold.
• 890 - Cancelled by User: The operation was cancelled by the customer.
• 891 - Cancelled by Merchant: The merchant has cancelled the transaction.

payment type code

• C001***
• C002 – first direct debit
• C003 – recurring direct debit
• C004 – first direct debit
• C005 – recurring direct debit
• C008 – SEPA direct debit
• C021 – ideal
• C101 – refund transfer
• C121 – refund ideal
• C102 – refund any direct debit trx
• C500 – refund any direct debit trx
• C565 – refund any Settlement by merchant trx
• C501 – reversal
• C561 --direct debit has been reversed by the customer (M.O.I)
• C562 – reversal
• I255 – credit note
• I256 – Write-off
• C461 – payments from collection agency
• C462?***
• N800 ***

190

C001/C002/C003
C004/C005
C008/C021

Successful: Payment/Direct debit/ iDEAL

The action required from CDRator for handling (direct debit) payments is Capture Payment by:

• Checking if the status code is 190. Not found -> write error to log, process next record.
• If status code is 190 and transaction code is C002/C003/C004/C005/C008 or C021, search for invoice number in field “Invoice number” and capture the payment with the debit amount specified in field “Amount Debit”. 
• Write “successful result” to log file

190

C461/C462

Payments to the Collection Agency

The action required from CDRator for handling payments to the collection agency is Capture Payment by:

• Checking if the status code is 190. Not found -> write error to log, process next record.
• If status code is 190 and transaction code is C461/C462, search for invoice number in field “Invoice number” and capture the payment with the debit amount specified in field “Amount Debit”.
• Write “successful result” to log file

190

N800

Settlement by merchant

The action required from CDRator for handling BPE 3.0 settlements by merchant is Capture Payment by:

• Checking if the status code is 190. Not found -> write error to log, process next record.
• If status code is 190 and transaction code is N800, search for invoice number in field“Invoice number” and capture the payment with the debit amount specified in field “Amount Debit”.
• Write “successful result”to log file

190

C561/C562/C501

Reversal

The action required from CDRator for handling reversals is Insert Reversed Payment by:

• Checking if the status code is 190. Not found -> write error to log, process next record.
• If status code is 190 and transaction code is C561/C562/C501, search for invoice number in field“Invoice number” and capture the payment with the debit amount specified in field “Amount Credit”.
• Write “successful result”to log file

190

C101/C102/C121C500/C565

Refund

The action required from CDRator for handling BPE 3.0 (single) refunds is Insert Reversed Payment by:* Checking if the status code is 190. Not found -> write error to log, process next record.

• If status code is 190 and transaction code is C101/C102/C121/C500 or C565, search for invoice number in field “Invoice number” and insert a reversed payment with the negative credit amount specified in field “Amount Credit”. 
• Check if there is a corresponding credit note transaction by searching for status code 190 and transaction code I255, with an invoice number in the “Invoice number” field that has the prefix “CRN” followed by the invoice number of the refund. If so -> Process Credit Note. If not -> this can be seen as a single refund transaction
• Write “successful result” to log file

190

I255

Credit Note

The action required from CDRator for handling BPE 3.0 credit notes is Insert positive payment by:

• Checking if the status code is 190. Not found -> write error to log, process next record.
• If status code is 190 and transaction code is I255 and invoice number in field “Invoice number” has a “CRN” prefix, Search for a refund transaction with status code 190, transaction code C101/C102/C121/C500 or C565 and the same invoicenumber (CRN excluded) in the field “Invoice number”). -> Process refund first if it is not processed yet.
• If the invoice number in field “Invoice number” does not have the “CRN” prefix, this is a single credit note transaction. No need to search for a corresponding refund.
•  Search for amount in field “Amount Credit” and insert a positive debit payment. 
• Write “successful result” to log file

190

I256

Write off

The action required from CDRator for handling reversals is Insert Reversed Payment by:

• Checking if the status code is 190. Not found -> write error to log, process next record.
• If status code is 190 and transaction code is I256, search for invoice number in field “Invoice number” and insert a reversed payment with the negative credit amount specified in field “Amount Credit”. 
• Write “successful result” to log file

For each response file that is processed,
the Rator system has to write a log record to a table.

The DB table BUCKAROO_RESPONSE_HEADER contains one row for each response file processed.
This table has a column called STATUS which contains the current status of the response file. 
Possible status values are NEW(0), PROCESSED(1), PROCESSED_WITH_ERROR(2), ERROR(4)

For each processed record, a row must be written
to the log file which indicates if the record is successfully processed.

The table BUCKAROO_RESPONSE_RECORD contains one row for each record in the response file.
This table has a column called STATUS which contains the current status of the response record. Possible status values are NEW(0), PROCESSED(1), IGNORE(2), ERROR(4)

In case of an error, a clear description should be written to the log file and the Rator system should start processing the next (response) record.

The table BUCKAROO_RESPONSE_RECORD contains one row for each record in the response file.
This table has a column called STATUS_MESSAGE which contains a message indicating whether or not an error occurred  while processing the corresponding response record.
These status messages are configurable by defining parameter tree entries for each status message used. Please see Parameters required section for more info.