The Payline® Batch Processor is designed to process input files containing credit card payment information for authorisation.
| Technical Specifications/ Features: |
|
| Quote Suffix For Numeric Fields | If checked, appends a single quote (') to numeric fields like Card Number. This prevents Micorosoft Excel etc from interpreting such fields as a number value causing corruption of the value if the file is later saved by Excel. |
| Field Delimiter | This is the format you have created your csv file. Fields either seperated by commas or delimited by quotes. The quotes are helpful when you are using a comma delimeter and have a comma in a text field, which you do not want to delimit (break apart into multiple fields). |
| DDMMYYYY Format | If checked, PXBAT will output AcquirerDate and DateSettlement dates in DDMMYYYY format where DD is Day or month, MM is month 01-12 and YYYY is year. Default: Not checked (dates output in YYYYMMDD format). |
| YYMM Expiry | If checked, PXBAT will interpret expiry dates in YYMM format, not MMYY. Default: Not checked (date format for expiry dates is MMYY) |
| Require 2 decimal places | Reserved. Default: Not Checked |
| DPS BillingId | If checked, a DpsBillingId can be used for recurring billing purposes. If unchecked, you can use your own BillingId for token billing transactions. Default: Not checked. |
| EnableRetry | If checked, automatically retries transactions failed due to a transient condition such as communications failure. Default: Checked (Retry transactions failed due to transient faults). |
| Currency | Determines the currency of the transaction for the input file – eg NZD, USD etc. |
| LF Line Terminator | If your CSV uses LF (Line Feed) terminators instead of plain CRs (carriage returns) then you should check this box. |
Input File format is CSV (Comma Separated Value), Excel style. Each line of the file represents an authorisation, purchase, completion or refund request and has the following format:
TxnType,Account,MerchantReference,CardNumber,Expiry,Amount,DpsTxnRef,CPC,
CardHolderName
| Field | Parameter | Description | |
| 1 | TxnType | Transaction type that you would like to send. Can be Purchase, Refund, Tipping or Billing type transactions. Valid values are 'A'=Auth, 'C'=Completion, 'P'=Purchase, 'R'=Refund, 'V'=Validate, 'B'=Bill | |
| 2 | Account | DPS account number. Values can be 0-9999 depending upon account to settle to. |
|
| 3 | MerchantReference | Free transaction reference field. E.g.: booking reference, order reference or invoice number. |
|
| 4 | CardNumber/BillingId/ DpsBillingId |
Card Number. Note - must be followed by a single ' character if this file is loaded and saved using Microsoft Excel spreadsheet. |
|
| 5 | ExpiryDate | Card Expiry Date in MMYY format. Some acquirers do not require this field - contact DPS for more details. Also not required if BillingId/DpsBillingId is used. |
|
| 6 | Amount | Amount in d.cc format e.g. $1.23 would be 1.23 |
|
| 7 | PreAuthNumber/ DpsTxnRef | Either PreAuthNumber or DpsTxnRef (Preferred) needs to present for completion requests to match against original authorisation. DpsTxnRef will also need to be present for Refund transactions to match the original Purchase, Completion or Billing transaction. |
|
| 8 | CPC | Corporate Purchase Card transactions. Extended data, which will appear on corporate cardholders statements if your merchant account supports it. |
|
| 9 | CardHolderName | Cardholder Name if known. |
|
P,9997,Ref1,4111111111111119,0201,1.23,,,TEST NAME1
The above input line describes a Purchase transaction for account 9997,
Merchant Reference "Ref1",card number 4111111111111111, Expiry Date February
2001, amount $1.23, PreAuthNumber blank,reserved valu blank, Card holder name
is "TEST NAME1". Additional data (if present is ignored and is not written to
output file. Trailing single quotes (') or double quotes (") are ignored. These
should be included to prevent the cardnumber etc being interpreted as decimal
values by Excel. IE: cardnumber should be input as 4111111111111119' not
4111111111111119.
Input File format is CSV (Comma Separated Value), Excel style. The original filename is used with the suffix "_OUT" appended to the original name. The file type .CSV is preserved. Each line of the file represents an authorisation, purchase, completion or refund result and has the following format:
TxnType,Account,MerchantReference,CardNumber,ExpiryDate,Amount,DpsTxnRef(Input),
CPC,CardHolderName,Result,ResponseCode,ResponseText,DpsTxnRef(Output),
AcquirerDate,AcquirerTime,AuthCode
If the output file name already exists (IE: if the same input file name is used before the original output file is deleted), then a date stamp is appended after the _OUT suffix. In this case, the output filename is INPUT_OUTyyyymmddhhmmss.CSV
| Field | Parameter | Description | |
| 1 | TxnType | Transaction type that you would like to send. Can be Purchase, Refund, Tipping or Billing type transactions. Valid values are 'A'=Auth, 'C'=Completion, 'P'=Purchase, 'R'=Refund, 'V'=Validate, 'B'=Bill | |
| 2 | Account | DPS account number. Values can be 0-9999 depending upon account to settle to. | |
| 3 | MerchantReference | Free transaction reference field. E.g.: booking reference, order reference or invoice number. |
|
| 4 | CardNumber/BillingId/ DpsBillingId |
Card Number. Note - must be followed by a single ' character if this file is loaded and saved using Microsoft Excel spreadsheet |
|
| 5 | ExpiryDate | Card Expiry Date in MMYY format |
|
| 6 | Amount | Amount in d.cc format e.g. $1.23 would be 1.23 |
|
| 7 | PreAuthNumber/ DpsTxnRef |
Either PreAuthNumber or DpsTxnRef (Preferred) needs to present for completion requests to match against original authorisation. DpsTxnRef will also need to be present for Refund transactions to match the original Purchase, Completion or Billing transaction. | |
| 8 | CPC | Corporate Purchase Card transactions. Extended data, which will appear on corporate cardholders statements if your merchant account supports it. |
|
| 9 | CardHolderName | Cardholder Name if known. | |
| 10 | Result | Success of the transaction. 0=declined/failed, 1=accepted | |
| 11 | ResponseCode | 2 character response code e.g.: "00" | |
| 12 | ResponseText | Text associated with response code. E.g.: "ACCEPTED" | |
| 13 | AuthCode | Authorisation (Approval) code if accepted. | |
| 14 | DpsTxnRef | DPS unique transaction reference of the new transaction | |
| 15 | AcquirerDate | YYYYMMDD | |
| 16 | AcquirerTime | HHMMSS | |
| 17 | DateSettlement | YYYYMMDD | |
P,0,Ref1,"4988720008880035",0102,133.20,,345,A J CARDHOULD,1,00,ACCEPTED,886453,
100035REF1,19990912,180922,19990912
The above output line describes a Purchase transaction for account 0, reference "Ref1", card number 4988720007770035, Expiry Date January 2002, amount $133.20, CVC2 value 345, Card holder name is "A J CARDHOULD", Result is 1 (approved), ResponseCode is "00", Text is ACCEPTED, TxnRef is 100035REF1, Date is 12th Sep 1999, Time is 6:09:22pm, Approval Code is 886453 and Date of Settlement is 12 Sept 1999
| Input Sample | |
| P,9997,Reference,4111111111111119,0106,1.23,,,TEST NAME | |
| Output Sample | |
| P,9997,Reference,4111111111111119,0106,1.23,,,TEST NAME,1,00,APPROVED,031507,0000000300a7a5e9,20050311,031507,20050311 | |
Note: The DPSTxnRef (0000000300a7a5e9) that can be used later for refund transactions is highlighted in the output.
| Input Sample | |
| R,9997,Reference,,,1.23,0000000300a7a5e9,,TEST NAME | |
| Output Sample | |
| R,9997,Reference,,,1.23,0000000300a7a5e9,,TEST NAME,1,00,APPROVED,032042,0000000300a7a5ea,20050311,032042,20050311 | |
Note: The DpsTxnRef is highlighted above. This value is given as the output in the original purchase, complete or billing transaction. All refund transactions need to be matched with the original transaction.
| Input Sample | |
| A,9997,Reference,4111111111111119,0106,1.23,,,TEST NAME | |
| Output Sample | |
| A,9997,Reference,4111111111111119,0106,1.23,,,TEST
NAME1,1,00,APPROVED,00113400a7a5c400000003,0000000300a7a5e9,20050307,001134, 20050307 |
|
Note: The Pre-Authorisation code (00113400a7a5c400000003) is given back and can
be used to complete transactions.
Note: The DpsTxnRef (0000000300a7a5e9) is given back and is the preffered
method for matching the completions.
| Input Sample | |
| C,9997,Reference,,,1.23,03471400a7a5eb00000003,,TEST NAME | |
| Output Sample | |
| C,9997,Reference,4111111111111119,0106,1.23,03471400a7a5eb00000003,,TEST NAME,1,00,APPROVED,035204,0000000300a7a5ed,20050311,035204,20050311 | |
Note: The Pre-Auth Number is highlighted above. This value was given as the output from the original authorisation transaction.
| Input Sample | |
| C,9997,Reference,,,1.23,0000000300a7a5e9,,TEST NAME | |
| Output Sample | |
| C,9997,Reference,4111111111111119,0106,1.23,0000000300a7a5e9,,TEST NAME,1,00,APPROVED,001314,0000000300a7a5c5,20050307,001314,20050307 | |
Note: The DpsTxnRef is highlighted above. This value was given as the output from the original authorisation transaction. A further DpsTxnRef is given back in the completion response and is unique to the complete transaction and would be used to match a refund against the transaction.
| Input Sample | |
| B,9997,Reference,00000000022367439876215729745683,,1.23,,,TEST NAME | |
| Output Sample | |
| B,9997,Reference,00000000022367439876215729745683,,1.23,0000000300a7a5e9,,TEST NAME,1,00,APPROVED,001314,0000000300a7a5c5,20050307,001314,20050307 | |
Note: On the Setup tab of the PXBAT control panel the check box named "DPS
BillingId" needs to be unchecked.
Note: The BillingId used here was 00000000022367439876215729745683
| Input Sample | |
| B,9997,Reference,0000000000518077,,1.23,,,TEST NAME | |
| Output Sample | |
| B,9997,Reference,0000000000518077,,1.23,,,TEST NAME,1,00,APPROVED,104753,00000004010486cd,20050614,104753,20050614 | |
Note: On the Setup tab of the PXBAT control panel the check box named "DPS
BillingId" needs to be checked.
Note: The DpsBillingId used here was 0000000000518077
Example - P,9997,Reference,4111111111111119,0106,1.23,,A4387436 Payment March ,TEST NAME
| Value | Description |
| P | Purchase |
| R | Refund |
| A | Auth |
| C | Completion |
| V | Validate |
| B | Bill |
| H | Reserved. (Add Bill Card) |
| J | Reserved. (Validate & Add Bill Card ) |