Wiki Markup |
---|
{float:right|width=300px|background=lightgrey|border=solid blue 2px|margin=10px|padding=8px}*Contents*
{toc:all=true|depth=4|excerpt=true|indent=14px}
{float} |
Change log:
Date: | Author: | Version: | Changes: |
---|---|---|---|
03 Oct 2013 | KTH | 0.1 | Doc created. |
10 Feb 2014 | KTH | 0.2 | Added PayPerEmail field descriptions |
...
- Payment status code and payment type code
These fields explain the reason for receiving this message. It is primarily used for determining the type of payment, e.g. direct debit / reversal / refund / settlement by merchant etc. - Invoicenumber
This number should be used to link the response to the original payment request messagebe used to link the response to the original payment request message. Also the brand is detected based on this number when it is received from the Push response. - Debit/Credit amount
Debit/credit is from the customer's perspective. For a regular payment the debit field should contain an value matching the amount in the corresponding payment instruction message.
...
Fieldname | Rator table and field | Example | Format |
---|---|---|---|
websitekey | - | FSsfaJKF&6GH | Buckaroo Websitekey. |
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 |
service_payperemail_action | - | Paymentinvitation | String: Paymentinvitation (See Buckaroo PayPerEmail Service Description) |
service_payperemail_customeremail | users.EMAIL | support@buckaroo.nl | String; customer email address |
service_payperemail_customergender | users.GENDER | 1 | Integer, may not be empty 0: Unknown 1: Male 2: Female 9: Irrelevant (currently not used) |
service_payperemail_customerfirstname | users.FIRST_NAME | Test | String; Customer first name |
service_payperemail_customerlastname | users.LAST_NAME | Tester | String; Customer lastname |
service_payperemail_paymentmethodsallowed | - | Ideal | String: Ideal, (See Buckaroo PayPerEmail Service Decription) |
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. |
customergender | users.GENDER | 1 | Integer, may not be empty |
amountvat | - | 0.00 | Real, 2 decimals |
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 |
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 |
...
field | Description |
---|---|
status code |
|
payment type code |
|
...
Resp. status code(s) | Payment type codes | Description | Action CDRator |
---|---|---|---|
190 | C001/C002/C003 | Successful: Payment/Direct debit/ iDEAL | The action required from CDRator for handling (direct debit) payments is Capture Payment by:
|
190 | C461/C462 | Payments to the Collection Agency | The action required from CDRator for handling payments to the collection agency is Capture Payment by:
|
190 | N800 | Settlement by merchant | The action required from CDRator for handling BPE 3.0 settlements by merchant is Capture Payment by:
|
190 | C561/C562/C501 | Reversal | The action required from CDRator for handling reversals is Insert Reversed Payment by:
|
...
Resp. code(s) | Transaction codes | Description | Action CDRator |
---|---|---|---|
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.
|
190 | I255 | Credit Note | The action required from CDRator for handling BPE 3.0 credit notes is Insert positive payment by:
|
Write
...
-Off
Invoices that are not paid for by customers are sent to the collection agency. After a certain period of time, the unpaid invoices are closed by the collection agency and should be closed on the rator Rator platform as a write-off.
Resp. status code(s) | Payment type codes | Description | Action CDRator |
---|---|---|---|
190 | I256 | Write off | The action required from CDRator for handling reversals is Insert Reversed Payment by:
|
...