Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
developer:api_specification:hpp_bulky_payments_features [2018/07/10 09:26]
thiago123 [spelling fix] for issue #14503
— (current)
Line 1: Line 1:
-====== HPP Bulk Payments Feature ====== 
  
-~~TOC~~ 
- 
-\\ 
- 
-The Bulk Payments feature allows Merchants, which need to process large amounts of transactions periodically for their customers, to submit those transactions and work in two different ways: 
- 
-  * **Processing the Bulking File at Once**: This option is avilable in the HPP integration method, following the next subsections. 
-  ​ 
-  * **Load the Bulking File and Process the Payment Separetely**:​ Take a better look at the  see the **[[merchant:​existing_merchant:​selfcare_system|%SelfCare System]]** page for more details on this feature. 
- 
-In the current page we are going to explore the first option. ​ 
- 
-This feature works beased on the submission of the transactions in a CSV file. This submission returns a response based on a file format and a set of field validation rules. ​ 
- 
-Also, an e-mail notification is sent when the processing of the bulk file ends. This will only be sent if the notification email is configured. ​ 
- 
-<WRAP center important 100%> 
-**REMEMBER**:​ All the URLs used in this guide are test environment related. Before going live contact our support team for the correct URLs. 
-</​WRAP>​ 
-\\ 
- 
-===== File Submission Request ===== 
- 
-  * **Your HTTP POST request should be sent to**: %URLBulkPayments 
- 
-The parameters for the HTTP POST are: 
- 
-^ **FIELD NAME** ​       ^ **REQUIRED** ​ ^ **DESCRIPTION ** ^ 
-| TERMINALID ​       | Y         | Terminal ID Provided by %CompanyName ​                    | 
-| TRANSACTIONCOUNT ​ | Y         | The count of transaction in the bulk payment file.                  | 
-| BATCHTOTAL ​       | Y         | The net total of all amounts fields in the bulk payment file.                  | 
-| DATETIME ​         | Y         | The date time of submission. Format: DD-MM-YYYY:​HH:​SS:​SSS ​          | 
-| HASH   | Y         | A HASH code formed by part of the request fields. Take a look at **ND001 - Hash Formation** for more details. | 
-\\ 
- 
-**ND001 - Hash Formation** 
- 
-The general rule to build HASH field is given at the **[[developer:​api_specification:​special_fields_and_parameters|Special Fields and Parameters]]** page, under the **[[developer:​api_specification:​special_fields_and_parameters#​the_hash_parameter|Special Fields and Parameters]]** section. For this specific feature, you should use the following formats: 
- 
-<WRAP center box 100%> 
-TERMINALID:​TRANSACTIONCOUNT:​BATCHTOTAL:​DATETIME:​SECRET 
-</​WRAP>​ 
-\\ 
- 
-===== File Submission Request Format (CSV) ====== 
- 
-^ **FIELD NAME** ​  ^ **REQUIRED** ​ ^ **DESCRIPTION ** ^ 
-| ODERID ​          | Y         | A unique reference generated by Merchant system to identify the transaction. Maximum of characters. | 
-| CURRENCY ​        | Y         | ISO 4217 Currency Code.  | 
-| AMOUNT ​          | Y         | Amount formatted to two decimal places. E.g. 1653.00 ​ | 
-| CARDNUMBER ​      | Y         | Card PAN. Can be SecureCard reference| 
-| CARDTYPE ​        | N         | See section 3.2 above. Leave blank if using SecureCard | 
-| CARDEXPIRY ​      | N         | MMYY. Leave blank when using SecureCard| 
-| CARDHOLDERNAME ​  | N         | The cardholders name. Leave blank when using SecureCard | 
-| ADDRESS1 ​        | N         | AVS Address Line 1. | 
-| ADDRESS2 ​        | N         | AVS Address Line 2. | 
-| POSTCODE ​        | N         | AVS Post Code.| 
-| DATETIME ​        | Y         | Format: DD-MM-YYYY:​HH:​MM:​SS:​SSS. | 
-| HASH             | Y         | A HASH code formed by part of the request fields. Take a look at **ND001 - Hash Formation** for more details. | 
-| AUTOREADY ​       | N         | Set to Y for setting auto ready or N to mark as pending.| 
-| DESCRIPTION ​     | N         | Optional transaction description. ​     | 
-| EMAIL            | N         | Card holder email for notification. ​     | 
-\\ 
- 
-**ND001 - Hash Formation** 
- 
-The general rule to build HASH field is given at the **[[developer:​api_specification:​special_fields_and_parameters|Special Fields and Parameters]]** page, under the **[[developer:​api_specification:​special_fields_and_parameters#​the_hash_parameter|Special Fields and Parameters]]** section. For this specific feature, you should use the following formats: 
- 
- 
-<WRAP center box 100%> 
-TERMINALID:​ODERID:​AMOUNT:​DATETIME:​SECRET 
-</​WRAP>​ 
-\\ 
- 
-===== File Submission Response ====== 
- 
-The response of a file submission is returned also in CSV format as a String. E.g. “200”,​”76528”. 
- 
-  * **Response Code**: Code defining the result of the bulk payment submission. Code is a 3 digit numeric code. 
- 
-The response code returned can be one of the following: 
- 
-^ **RESPONSE CODE** ^ **DESCRIPTION** ^ 
-| 200 | VALIDATION OK      | 
-| 001 | INVALID FILE ITEM COUNT       | 
-| 002 | INVALID FILE FORMAT ​          | 
-| 003 | FILE UPLOAD ERROR  | 
-| 004 | INVALID TRANSACTION COUNT     | 
-| 005 | INVALID BATCH TOTAL           | 
-| 006 | INVALID TERMINAL ID           | 
-| 007 | INVALID DATETIME ​  | 
-| 008 | INVALID HASH       | 
-| 009 | NOTHING TO SETTLE ​ | 
-| 010 | INVALID NUMBER OF BATCH FILES | 
-| 011 | METHOD NOT SUPPORTED ​         | 
-| 012 | UNKNOWN ERROR      | 
-| 013 | INVALID BULK ID    | 
-| 014 | INVALID BULK ID TERMINAL ID COMBINATION ​ | 
-| 015 | BULK PAYMENTS ARE NOT ALLOWED | 
-| 016 | BULK PROCESSING IN PROGRESS ​  | 
-\\ 
- 
-===== File Result Request ===== 
- 
-The Result file is a CSV file containing the results of all of the transactions submitted in a bulk payment. ​ 
- 
-This file is available for download in the %SelfCare System. Take a better look at the  see the **[[merchant:​existing_merchant:​selfcare_system|%SelfCare System]]** page for more details on this feature. 
- 
-  * **Your HTTP GET request should be sent to**: %URLBulkPaymentsResult 
- 
-<WRAP center important 100%> 
-If the file is still being processed, the response to this request will be error code 016 Which signifies BULK PROCESSING IN PROGRESS. 
-</​WRAP>  ​ 
-  ​ 
-The required parameters are : 
- 
-^ **FIELD NAME** ^ **REQUIRED** ^ **DESCRIPTION** ^ 
-| BULKID ​     | Y | The bulk id supplied to merchant after submitting bulk payments file.  | 
-| TERMINALID | Y | Terminal ID Provided by %CompanyName ​                                  | 
-| HASH | Y | A HASH code formed by part of the request fields. Take a look at **ND001 - Hash Formation** for more details. | 
-\\ 
- 
-**ND001 - Hash Formation** 
- 
-The general rule to build HASH field is given at the **[[developer:​api_specification:​special_fields_and_parameters|Special Fields and Parameters]]** page, under the **[[developer:​api_specification:​special_fields_and_parameters#​the_hash_parameter|Special Fields and Parameters]]** section. For this specific feature, you should use the following formats: 
- 
- 
-<WRAP center box 100%> 
-TERMINALID:​BULKID:​SECRET 
-</​WRAP>​ 
-\\ 
- 
-===== File Result Response ====== 
- 
-The response data is returned in a csv file. It will contain the results of the transactions in a specified bulkid. 
- 
-^ **FIELD NAME** ^ **REQUIRED** ^ **DESCRIPTION** ^ 
-| ORDERID ​      | Y | Order ID supplied by merchant in request. Maximum of 24 characters. | 
-| APPROVALCODE ​ | N | Will be present for a successful authorisation. | 
-| RESPONSECODE ​ | N | For successful transactions:​\\ **A**: (APPROVED/ AUTHORIZED/ ACCEPTED, respectively). \\ **E**: (ACCEPTED for later processing, but result currently unknown - specifically for China Union Pay). \\ **D**: (DECLINED). \\ **R**: (REFERRED, also considered as PICKUP). \\ **C**: (PICKUP, also known as Referral A or Referral B). \\ For more details, visit at **[[merchant:​existing_merchant:​other_information:​transaction_responses|Transaction Responses]]**.\\ \\ For unsuccessful transactions,​ there is a 3 digit numeric error code contained in this column:\\ **100** - Order Already Processed.\\ **101** - System Error. | 
-| RESPONSETEXT ​ | Y | Text describing state of transaction. Error message will be displayed here if an issue was encountered while processing transactions. ​                                                     | 
-| DATETIME ​     | N | Only sent in the case of no error.\\ Format DD-MM-YYYY:​HH:​MM:​SS:​SSS. ​                                                                                                    | 
-| HASH          | Y | A HASH code formed by part of the request fields. Take a look at **ND001 - Hash Formation** for more details. | 
-\\ 
- 
-**ND001 - Hash Formation** 
- 
-The general rule to build HASH field is given at the **[[developer:​api_specification:​special_fields_and_parameters|Special Fields and Parameters]]** page, under the **[[developer:​api_specification:​special_fields_and_parameters#​the_hash_parameter|Special Fields and Parameters]]** section. For this specific feature, you should use the following formats: 
- 
-If the terminal uses a single Currency. 
- 
-<WRAP center box 100%> 
-TERMINALID:​ORDERID:​AMOUNT:​DATETIME:​RESPONSECODE:​RESPONSETEXT:​SECRET 
-</​WRAP>​ 
- 
-If the terminal is Multi Currency. 
- 
-<WRAP center box 100%> 
-TERMINALID:​ORDERID:​CURRENCY:​AMOUNT:​DATETIME:​RESPONSECODE:​RESPONSETEXT:​SECRET 
-</​WRAP>​ 
- 
-  * **1**. The CURRENCY is formed by a three letters code - i.e.: EUR. 
-  * **2**. The AMOUNT is formatted using minor units based on the CURRENCY and then rounded to 2 decimals. 
-\\ 
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International