Web Service
The Web Service (WS) Client Application (CA) connects directly to the PaymentExpress Host WS via HTTPS Posts. Client applications talk to the Web Service using SOAP (Simple Object Access Protocol). SOAP provides a way to communicate between applications running on different operating systems, with different technologies and programming languages.
When consuming the web service at the "sec" subdomain (https://sec.paymentexpress.com/WS/PXWS.asmx) please ensure that your web service stack supports lax versioning: that is, it does not throw exceptions for new unknown data members in received data.
We no longer intend to update the web service exposed on the "www" subdomain (https://www.paymentexpress.com/WS/PXWS.asmx) with additional features or response elements as there are clients that were developed with the assumption that the schema will not change and they may fail to process messages that they were never designed for. Also, existing clients may perform actual schema validation against the old schema before even attempting to process the messages.
For this reason any future updates will be carried out on the new web service at the address below under the understanding that lax versioning is implemented on all clients consuming it. We will therefore not be required to establish a new end point in order to add extra data members. By the same token we will not require merchants to connect to a new endpoint in order to take advantage of any new features.
- Installation Instructions
- Submitting Transactions
- Exception Handling
- Auth-Complete
- Token Billing
- Refunds
- Extended Airline Booking Data
- Properties Description
| Downloads: | |
|
|
Installation Instructions
There is no Web Service installation to do on the client side as this is held at the Payment Express Host.
Files Installed/Updated
| Filename | Description |
Web Service Demo Client Application |
.Net C# Sample Code |
Web Service Address
The address to connect to the Web Service is at https://sec.paymentexpress.com/WS/PXWS.asmx. Each method call is self documented at this address by clicking on each method.
Figure 2 The Web Service and it's method calls
The Web Service (WSDL) Standard Schema can be found at https://sec.paymentexpress.com/WS/PXWS.asmx?WSDL
The SubmitTransaction SOAP method calls/outputs can be found at https://sec.paymentexpress.com/WS/PXWS.asmx?op=SubmitTransaction
The GetStatus SOAP method calls/outputs can be found at https://sec.paymentexpress.com/WS/PXWS.asmx?op=GetStatus
WSDL
A web services descriptor language (WSDL) file is an XML document that describes the arguments accepted by a specific web service as well as the methods and properties supported by that service. The WSDL specification provides the grammar and syntax rules for WSDL files. For the WSDL schema please see https://sec.paymentexpress.com/WS/PXWS.asmx?WSDL.
Information on implementing 3D secure using the SOAP web sevice can be found here.
SOAP Operations
The WS control offers a number of methods to initiate transactions, connect to the Payment Express Server and alter settings and retrieve information. This section details the available SOAP operations and their uses.
SubmitTransaction
Add the appropriate inputs (Amount, TxnType etc) with the SubmitTransaction SOAP operation to perform a purchase, refund, authorisation or completion transaction.
Input Elements
| Element | Required | Description |
Yes |
Amount of transaction in 1.23 format |
|
| billingId | No | Specified for token billing transactions |
No |
Card Holder Name as on Card. |
|
No |
Credit Card Number. Left justified, no embedded spaces or other delimitors. |
|
No |
Allows the Client type to be passed through at transaction time. |
|
No |
Card Verification number. This number is found on the back of a credit card in the signature panel - it is different from the embossed card number and provides an additional safety check. |
|
Yes |
Expiry date of card in 4 digit MMYY format. Note: do not include "/" or other delimitors. |
|
| dpsBillingId | No | The Billing Id generated by DPS when adding a card for recurring billing. Needed for rebilling transactions when you do not use your own BillingId. |
| dpsTxnRef | Yes1 | Only required for refund or completion transactions. |
| enableAddBillCard | Optional | Needed for recurring billing transactions when adding a card to the DPS system. Set element to 1 for true and 0 for false |
No |
Specify the currency here. |
|
No |
64 character free text field |
|
| enablePaxInfo | No | Used for Airline Reservation Systems. Enable collection of extended booking data to go through to the acquirer if they support it. |
| paxDateDepart | No | Used for Airline Reservation Systems. Date departing in DD/MM/YY format. |
| PaxDate, PaxDate2, PaxDate3 | No | Used for Airline Reservation Systems. Flight date information. |
| paxName | No | Used for Airline Reservation Systems. Passenger Name. |
| paxClass1, paxClass2, paxClass3, paxClass4 | No | Used for Airline Reservation Systems. Class flight information. |
| paxFareBasis1 , paxFareBasis2 , paxFareBasis3 , paxFareBasis4 | No | Used for Airline Reservation Systems. Fare Basis flight information. |
| paxFlightNumber1, paxFlightNumber2, paxFlightNumber3, paxFlightNumber4 | No | Used for Airline Reservation Systems. Flight number information. |
| paxLeg1, paxLeg2, paxLeg3, paxLeg4 | No | Used for Airline Reservation Systems. Leg 1 flight information. |
| paxLeg1, paxLeg2, paxLeg3, paxLeg4 | No | Used for Airline Reservation Systems. Leg 1 flight information. |
| paxStopOverCode1, paxStopOverCode3, paxStopOverCode3, paxStopOverCode4 | No | Used for Airline Reservation Systems. Stop over code flight information. |
| paxTicketNumber | No | Used for Airline Reservation Systems. Passenger Ticket Number. Format: AAATTTTTTTTTTC |
| paxCarrier | No | Used for Airline Reservation Systems. 2 character airline identifier. |
| paxOrigin | No | Used for Airline Reservation Systems. Passenger Origin. |
| paxTravelAgentInfo | No | Used for Airline Reservation Systems. Travel Agent description field. |
| postPassword | Yes | Combined with Username, selects Account |
| postUsername | Yes | Combined with Password, selects Account |
No |
Address to email a receipt to. Not currently implemented |
|
No |
Optional Free Text |
|
No |
Optional Free Text |
|
No |
Optional Free Text |
|
Yes |
Set by client to uniquely identify transaction. You will need to set this value if wanting to use GetStatus |
|
Yes |
Purchase, Refund, Auth, Complete, Validate |
|
No2 |
Address Verification System property. Values are 1 (Enable Verification), 0 (Disable Verification). |
|
No |
Address Verification System property. Valid values are 0,1,2 & 3. |
|
No |
Address Verification System property. Post Code that is listed on the customer's bank statement |
|
No |
Address Verification System property. Address that is listed on the customer's bank statement. |
|
No3 |
The Issue date of the customer's credit card, if Issuer requires this field to be present. |
|
No3 |
The Issue Number of your credit card if Issuer requires this field to be present. |
1 - dpsTxnRef is required for a Refund transaction or Complete transaction only. Must contain the DpsTxnRef returned by the original Purchase or Auth transaction to be refunded or completed.
2 - Feature not supported by all acquirers.
3 - Not required unless card issuer requires it.
Output Elements
These Elements are given when the SubmitTransaction method returns results.
| Element | Description |
Authorisation Code |
|
Indicates if the transaction was authorized or not. Either False (0) or True (1) |
|
| billingId | Billing Id specified for a token billing transaction |
| Any tips or hints for the CardHolder. Usually just the Response Text, associated with the ReCo | |
Card Holder Name as on Card. |
|
| A description of the transaction error to help the CardHolder, associated with the ReCo | |
| Response Text of the transaction to help the CardHolder, associated with the ReCo. | |
Card used (Visa,MasterCard,Bankcard etc) |
|
Date transaction will be settled to Bank Account in YYYYMMDD format. This is supported for most, but not all banks and card acquirers. If the DateSettlement is not available from the banking network, the DateSettlement will contain the current calendar date. |
|
| dpsBillingId | Contains the BillingId generated by DPS when adding a card for recurring billing. |
| dpsTxnRef | Unique transaction identifier returned for every transaction. Required input for Refund transactions or Complete transactions. |
| issuerCountryId | The ISO 3166-1 code for the country the credit card was issued in. -1 - Not checked 0 - Checked but country not recognized N - Where n is the ISO 3166-1 standard country code (e.g. NZ=554, AU=036) |
2 character response code. |
|
Response Text associated with ReCo |
|
If true; retry transaction, if false do not retry. |
|
If true then the result of the transaction could not be determined and you will have to call GetStatus to get the result. |
|
Set by client to uniquely identify transaction. |
SubmitTransaction2
This is used in the same way as SubmitTransaction call, however it also includes the Acquirer response in the result.
Additional Output Elements
| Element | Description |
2 character response code from the Acquiring bank |
|
Response Text associated with ReCo from the Acquiring bank |
GetStatus
GetStatus is used when the SubmitTransaction operation fails and the response was not received within a timeout period or the link to Payment Express Server or beyond failed while awaiting a response. In this circumstance, the result of the transaction is indeterminate. The GetStatus operation should be used to retrieve the actual result. GetStatus uses the original TxnRef values which uniquely identify the transaction to lookup the transaction at the Payment Express Host and return the results.
Input Elements
| Element | Required | Description |
| postPassword | Yes | Combined with Username, selects Account |
| postUsername | Yes | Combined with Password, selects Account |
Yes |
Value assigned to the txnRef property of the transaction to look up. |
Output Elements
| Element | Description |
Authorisation Code |
|
1 if transaction successful - 0 if declined or unsuccessful |
|
| billingId | Billing Id specified for a token billing transaction |
| Any tips or hints for the CardHolder. Usually just the Response Text, associated with the ReCo | |
Card Holder Name as on Card. |
|
| A description of the transaction error to help the CardHolder, associated with the ReCo | |
| Response Text of the transaction to help the CardHolder, associated with the ReCo. | |
Card used (Visa,MasterCard,Bankcard etc) |
|
Date transaction will be settled to Bank Account in YYYYMMDD format. This is supported for most, but not all banks and card acquirers. If the DateSettlement is not available from the banking network, the DateSettlement will contain the current calendar date. |
|
| dpsBillingId | Contains the BillingId generated by DPS when adding a card for recurring billing. |
| dpsTxnRef | Unique transaction identifier returned for every transaction. Required input for Refund transactions or Complete transactions. |
2 character response code. |
|
Response Text associated with ReCo |
|
If true; retry transaction, if false do not retry. |
|
If true then the result of the transaction could not be determined and you will have to call GetStatus again. |
|
Set by client to uniquely identify transaction. |
Example:
- Client Application loads the Web Service Input Elements
- Client Application uses the SubmitTransaction operation call and connects to the Web Service
- Web Service sends transaction
- Link between Web Service client application is interrupted
- Client application returns indeterminate result after timeout period
- Client Application calls the GetStatus operation
- Client Application receives the result of the transaction
Once the client application has confirmed the result of the transaction with the Payment Express Server with the GetStatus call, normal processing of subsequent transactions using SubmitTransaction method can resume.
Ensure that this txnRef value is loaded in txnRef property before calling GetStatus. Payment Express Host maintains transaction results for at least 48 hours therefore calls to GetStatus can rely on results being available for at least this period following transmission of the original transaction.
If a GetStatus method is made for a transaction that was successfully processed by Payment Express Host and was accepted by the bank, then the GetStatus method will result in the Web Service properties being set exactly as they would have been for the original transaction result, regardless of whether the original transaction result was actually received by the client application.
GetStatus2
This is used in the same way as GetStatus call, however it also includes the Acquirer response in the result.
Additional Output Elements
| Element | Description |
2 character response code from the Acquiring bank |
|
Response Text associated with ReCo from the Acquiring bank |
Exception Handling
Refer to the GetStatus operation. The Payment Express architecture does not provide for customer applications to "reverse" or "back out" transactions once started. Exception conditions arise when the link between the customer application and the Payment Express Host is interrupted. A response to a transaction request is not received or the StatusRequired parameter in the response is true. In this circumstance, the result of the transaction is unknown.
The transaction must not be assumed to have failed. In this case, the application must enter a "recovery" mode until the result of the transaction can be ascertained. The mechanism to perform this error recovery is easily accomplished using the procedure outlined in the GetStatus method documentation.
UpdateCard
UpdateCard call is used to update the expiry date of a BillingId, DpsBillingId or CardNumber2 associated with a credit card. This is useful when a customers credit card has expired and they receive a new one from their bank with the same credit card number.
Input Elements
| Element | Required | Description |
| postPassword | Yes | Indicates the DPS account under which the token is stored |
| postUsername | Yes | Authenticates the client application |
Yes |
An escaped XML document containing dateExpiry and BillingId, DpsBillingId or CardNumber2. |
Output Elements
| Element | Description |
An escaped XML document indicating the outcome of the operation. |
The input SOAP message contains an element named cardDetails. The cardDetails string value should be an XML document which has be escaped before submission. dateExpiry and either billingId, dpsBillingId or cardNumber2 must be supplied.
Request example:
<cardDetails>
<dpsBillingId>0000060000991568</dpsBillingId>
<dateExpiry>1111</dateExpiry>
</cardDetails>
The output SOAP message contains a single element named updateCardResult. The updateCardResult string value contains escaped XML which must be unescaped in order to parse the values. The updateSucceeded value indicates the success of the update and the reco and responseText values provide further details.
Output example:
<updateCardResult>
<updateSucceeded>1</updateSucceeded>
<reco>OK</reco>
<responseText>OK</responseText>
</updateCardResult>
Auth-Complete
Overview
Payment Express supports Authorisation and Complete transaction types. An Auth transaction verifies that funds are available for the requested card and amount, and reserves the specified amount. A Complete transaction is sent at a later date to cause funds transfer for the previously authorised amount, or a smaller amount if the total original value is no longer required. This transaction set is useful when the merchant needs to ensure that funds up to a certain limit are available but the actual total amount is not yet known or goods or services have not yet been delivered.
Operation
1) Authorization
Use the SubmitTransaction operation with TxnType set to "Auth" for for the amount to be authorised. The Auth response contains a DpsTxnRef. The funds are not transferred from the cardholder account.
2) Complete
After a successful Auth transaction, but within 7 days maximum, a Complete transaction must be sent containing the DpsTxnRef returned by the Auth transaction.
Token Billing
Overview
Token Billing allows for regular billing of a cardholder card, under the control of the merchant, without requiring the merchant to either store sensitive card data securely or to obtain credit card details every time a new payment is requested. This functionality is implemented by providing the ability for a merchant to request Payment Express to capture and store credit card number and expiry date and to link these stored details to a merchant supplied "BillingId". The BillingId is a 32 character field that contains a reference that is unique to the merchant's customer that will be associated with the credit card information stored securely at Payment Express. This is undertaken during the Setup Phase. For subsequent charges to the card (Rebill Phase), the merchant does not need to supply the card number or expiry date, only the BillingId originally associated during the Setup Phase
1) Setup Phase
A setup phase involves loading a card into Payment Express. Optionally the setup phase can include an online $1.00 authorisation (Validate) transaction which will determine that the card is valid and not on hot or stolen card lists and that it has the correct expiry date.
Customers will typically integrate directly into their call centre or web application for the setup phase.
To add a card for future rebilling, call the SubmitTransaction web service method/operation with the following properties -
TxnType property set to "Purchase" or "Auth"
EnableAddBillCard property set to "1" (true)
CardHolderName (optional, strongly recommended)
MerchantReference
CardNumber
DateExpiry
BillingId (Optional. If none is supplied then a DpsBillingId determined by Payment Express will be returned
for use)
2) Rebill Phase
The merchant application or Batch processor requests a new transaction and supplies the appropriate BillingId, or DpsBillingId a MerchantReference which appears on reports and the amount to be charged. EnableAddBillCard value will be set to 0 (False) for the rebill phase.
Payment Express retrieves the credit card number and expiry date stored in the Setup Phase and a purchase transaction is formatted and processed to the card acquirer.
CardNumber2
Note: CardNumber2 functionality is only available via SOAP Requests made to the subdomain "sec".
CardNumber2 is a token generated by DPS and associated with card details supplied. It is 16 numeric characters and conforms to a Luhn "mod 10" algorithm. This makes it ideal for storage within the database in place of a card number where the value is validated against checks which might normally be made against credit card numbers. A CardNumber2 value is always unique for a given card number. Should a card number be presented for tokenization multiple times the same CardNumber2 value will be returned.
CardNumber2 tokens are generated as normal by setting EmableAddBillCard to "1" (true). The token will be returnd in the cardNumber2 property of the TransactionResult2.
Charging a CardNumber2 token requires the merchant application or Batch processor requests a new transaction and supplies the appropriate cardNumber2 a MerchantReference which appears on reports and the amount to be charged. EnableAddBillCard value will be set to 0 (False) for the rebill phase. Payment Express retrieves the credit card number and expiry date stored in the Setup Phase and a purchase transaction is formatted and processed to the card acquirer.
CardNumber2 transactions use the card expiry date stored with the token regardless of wheter one is passed through in the transaction data. On a successful transaction with the real card number accociated with a CardNumber2 token the expiry date stored with this token will be updated to that which was used to process the transaction. If your client application displays details of stored tokens to cardholders eg: masked number and expiry date, then it is advisible upon a successful transaction for the merchant application to update the expiry date that is stored with the generated token.
Refunds
The Web Service is capable of handling refunds (credit) transactions, however you will need to match the original Purchase or Complete transaction for this to happen. The matching is done with the DpsTxnRef given from the response of a purchase or complete transaction. You are able to do multiple refund transactions to the maximum amount of the original matched transaction.
The TxnType will be Refund.
The Payment Manager is provided to merchants with all integrated solutions by DPS, so there is a ready built interface to handle refund transactions already. However, if you wish to integrate refunds into your own interfaces the following input properties need to be provided for a refund transaction:
TxnType = "Refund"
DpsTxnRef
MerchantReference (Optional)
Amount
Extended Airline Booking Data
The Web Service is capable of taking extended booking information, which is used to display on cardholders statements.
If you would like to add booking information to your transaction details you will need to set the EnablePaxInfo input property to true (1) and you will be able to use the following properties -
PaxCarrier,PaxCarrier2,PaxCarrier3,PaxCarrier4,PaxDateDepart, PaxDate,PaxDate3,PaxDate3,PaxDat4,
paxTime1,paxTime2,paxTime3,paxTime4,
PaxLeg1, PaxLeg2, PaxLeg3, PaxLeg4,
paxStopOverCode1, paxStopOverCode2, paxStopOverCode3, paxStopOverCode4,
paxClass1, paxClass2, paxClass3, paxClass4,
paxFareBasis1, paxFareBasis2, paxFareBasis3, paxFareBasis4,
paxFlightNumber1, paxFlightNumber2, paxFlightNumber3, paxFlightNumber4,
PaxOrigin, PaxName, PaxTicketNumber and PaxTravelAgentInfo.
Sample data:
PaxDateDepart = "14122008"
PaxName = "Brian Smith"
PaxOrigin = "AKL"
PaxLeg1 = "SYD"
PaxLeg2 = "LAX"
PaxLeg3 = "LHR"
PaxLeg4 = "AKL"
PaxTicketNumber = "0030458343"
PaxCarrier = "QB"
PaxTravelAgentInfo = "BA1234567890"
Properties Description
The following section provides a detailed description of each Web Service element and indicates if it used as an input or output. If a property is marked as input, it is not updated or output when a call to SubmitTransaction or GetStatus returns. This is important when a call is made to GetStatus for example, the original contents of Amount as input to the SubmitTransaction call are not output by GetStatus.
Authorized (output) Datatype: String Max 1 characters
Indicates if the transaction was authorized or not. Either False (0) or True (1)
Amount (input) Datatype: String Max 12 characters
Total Purchase, Refund, Auth or Complete amount. Format is d.cc where d is dollar amount (no currency indicator) and cc is cents amount. for example, $1.80 (one dollar and eighty cents) is represented as "1.80", not "1.8". A string value is used rather than the conventional Currency Datatype to allow for easy integration with Web applications. Note that the original value used as input to SubmitTransaction is not returned by any subsequent DoGetStatus and must be stored by the application if required. Maximum value allowable is $99,999.99. Note that acquirer or card limits may be lower than this amount. When submitting transactions for
currencies with no decimal division of units such as JPY the AmountInput must be
in an appropriate format e.g. "10".
AuthCode (output) Datatype: String Max 22 characters
Authorization code returned for approved transactions.
BillingId (input/output) Datatype: String Max 32 characters
BillingId generated by the customer system. This could be a customer number and is used as input to SubmitTransaction to rebill an existing customer. If EnableAddBillCard
CardHolderResponseDescription (output) Data type: String Max 32 characters
More detailed explanation of result. Intended for card holder.
CardHolderHelpText (output) Data type: String Max 32 characters
More detailed explanation of result. Intended for card holder.
CardHolderName (input) Datatype: String Max 64 characters
The cardholder name as it appears on customer card. Optional and may be left blank.
CardHolderResponseText (output) Data type: String Max 32 characters
Brief (Max 32 character) response text intended for card holder.
CardNumber (input) Datatype: String Max 19 characters
The card number. No leading or embedded blanks are permitted. Must contain a numeric value. Not required for Complete or Refund TxnType.
CardNumber2 (input) Datatype: String Min/Max 16 characters
A Billing Token value formatted to resemble a card number and pass a Luhn check. To use CardNumber2 tokens your account must be configured to generate them. Please contact our support team if you intend to use this feature.
CardName (output) Datatype: String Max 16 characters
The card type used for the transaction. Note that the list may be expanded as support for new cards is added. The CardName format is to capitalize the first letter with remaining letters in lowercase.
| CardName Value | Description |
Amex |
American Express |
Bankcard |
Bank Card |
| Diners | Diners Card |
Jcb |
JCB |
Mastercard |
Mastercard |
Visa |
Visa |
Cvc2 (input) Datatype: String Max 4 characters
Card Verification Code 2 number. Some payment cards are issued with additional identifying information. These cards will have the account number printed on the signature panel of the card followed by a three or four digit value. This value is generated by the issuing bank and can be verified by the bank. Payment card brands have varying names for the value:
American Express: Four-digit batch code (4DBC)
MasterCard: Card Verification Code 2 (CVC2)
Visa: Card Verification Value 2 (CVV2)
Supplying this value provides an indication of that the person participating in a transaction had physical possession of the card at some point in time. This is not currently implemented by all acquirer and may not necessarily be checked
ClientType (input) Datatype: String
Allows the Client type to be passed through at transaction time. Allowed values:
W - Web
V - IVR
m - MOTO
U - Unatended
I - Internet
Recurring - Recurring, if supported by your merchant bank expiry date will not be validated.
DateExpiry (input) Datatype: String Max 4 characters
Indicates card expiry date. Format is MMYY where MM is month 01-12 and Year 00-99. do not insert "/" or other delimiter. Not required for Complete or Refund transactions.
DateSettlement (output) Datatype: String Max 8 characters
Indicates Date of settlement (when money will be deposited in Merchant bank account) if this is supported by the Acquirer, otherwise contains the date the transaction was processed in YYYYMMDD format.
DateStart (input) Datatype: String Max characters
The Issue date of the customer's credit card, if Issuer requires this field to be present.
Format is MMYY where MM is month 01-12 and Year 00-99. do not insert "/" or other delimiter.
Used for Maestro/Solo cards.
IssueNumber (input) Datatype: INT
The Issue Number of your credit card if Issuer requires this field to be present.
issuerCountryId (output) Datatype: INT
The Country code for the country the credit card used was issued in.
-1 - Not checked
0 - Checked but country not recognized possibly invalid bin range or invalid card
N - Where n is the ISO 3166-1 standard country code (e.g. NZ=554, AU=036)
EnableAvsData (input) Datatype: INT
Address Verification System property. Values are 1 (Enable Verification), 0 (Disable Verification). Your bank may require that you use AVS, in which case you will need to set to 1.
AvsPostCode (input) Datatype: String Max 20 characters
Address Verification System property. Post Code that is listed on the customer's bank statement.
AvsStreetAddress (input) Datatype: String Max 60 characters
Address Verification System property. Address that is listed on the customer's bank statement.
AvsAction (input): 1 digit
Address Verification System property. Valid values are 0, 1, 2 & 3.
0 - do not check AVS details with acquirer, but pass them through to Payment Express only.
1 - Attempt AVS check. If the acquirer doesn't support AVS or AVS is unavailable, then the transaction will proceed as normal. If AVS is supported and the AVS check fails, then the transaction will be declined.
2 - The same as 1 except the transaction must be checked by AVS. If AVS isn't available, the transaction will be declined.
3 - AVS check will be attempted and any outcome will be recorded, but ignored i.e. transaction will not be declined if AVS fails or unavailable.
The value will most likely be 1 for most circumstances.
DpsBillingId (input/output) Datatype: String Max 16 characters
Returned for a successful billing transaction if EnableAddBillCard is set. Supplied as input to rebill a transaction if BillingId is not used. It is not allowed to specify both a BillingId and a DpsBillingId when rebilling a transaction.
DpsTxnRef (input/output) Datatype: String Max 16 characters
Returned for every transaction. If the transaction was approved, DpsTxnRef can be used as input to a Refund transaction. Used to specifiy a transaction for refund without supplying the original card number and expiry date.
EnableAddBillCard (input/output) Datatype: BOOL
If set to true on input to SubmitTransaction, the details necessary to charge the same customer in the future are securely stored. A BillingId may optionally be attached on input. DpsBillingId is returned. See Token Billing section for details on using this feature.
MerchantReference (input) Datatype: String Max 64 characters
Free Text Field for use by merchant (could be order number, customer number etc.).
InputCurrency (input) Datatype: String Max 4 characters
Indicates currency used for this transaction. If blank, currency will be determined by the bank account used which is selected using the Username/Password details. Not all acquirers can support multiple currencies. Valid valus for Currency are:
| CAD | Canadian Dollar |
| CHF | Swiss Franc |
| DKK | Danish Krone |
| EUR | Euro |
| FRF | French Franc |
| GBP | United Kingdom Pound |
| HKD | Hong Kong Dollar |
| JPY | Japanese Yen |
| NZD | New Zealand Dollar |
| SGD | Singapore Dollar |
| THB | Thai Baht |
| USD | United States Dollar |
| ZAR | Rand |
| AUD | Australian Dollar |
| WST | Samoan Tala |
| VUV | Vanuatu Vatu |
| TOP | Tongan Pa'anga |
| SBD | Solomon Islands Dollar |
| PGK | Papua New Guinea Kina |
| MYR | Malaysian Ringgit |
| KWD | Kuwaiti Dinar |
| FJD | Fiji Dollar |
EnablePaxInfo (input) Data type: Boolean True/False
Used for Airline Reservation Systems. Enable collection of extended booking data to go through to the acquirer. Value will need to be true (1) if ticket information is included with the transaction.
PaxDateDepart (input) Data type: String Max 8 characters
Used for Airline Reservation Systems. Date departing in YYYYMMDD format. Numeric.
PaxCarrier (input) Data type: String Max 2 characters
Used for Airline Reservation Systems. Carrier flight information. Alphanumeric.
PaxCarrier2 - 4 (input) Data type: String Max 2 characters
Used for Airline Reservation Systems. Carrier flight information. Alphanumeric.
PaxdateDepart (input) Data type: String Max 20 characters
Used for Airline Reservation Systems. Carrier flight information. Alphanumeric.
PaxDate2 - 4 (input) Data type: String Max 20 characters
Used for Airline Reservation Systems. Leg depart date flight information. Alphanumeric.
PaxTime1 - 4 (input) Data type: String Max 4 characters
Used for Airline Reservation Systems. Leg depart time flight information. Alphanumeric.
PaxClass1 - 4 (input) Data type: String Max 1 characters
Used for Airline Reservation Systems. Class flight information. Alphanumeric.
PaxStopoverCode1 - 4 (input) Data type: String Max 1 characters
Used for Airline Reservation Systems. Stop over code flight information. Alphanumeric.
paxFareBasis1 - 4 (input) Data type: String Max 6 characters
Used for Airline Reservation Systems. Fare basis flight information. Alphanumeric.
paxFlightNumber1 - 4 (input) Data type: String Max 6 characters
Used for Airline Reservation Systems. Flight number information. Alphanumeric.
PaxLeg1 - 4 (input) Data type: String Max 3 characters
Used for Airline Reservation Systems. Flight number information. Alphanumeric.
PaxName (input) Data type: String Max 20 characters
Used for Airline Reservation Systems. Passenger Name. Alphanumeric.
PaxOrigin (input) Data type: String Max 3 characters
Used for Airline Reservation Systems. Passenger Origin of departure. Alphanumeric.
PaxTicketNumber (input) Data type: String Max 10 characters
Used for Airline Reservation Systems. Passenger Ticket Number. Format: AAATTTTTTTTTTC. AAA is airline code, TTTTTTTTTT (10 chars) is actual ticket number and C is check digit. Numeric.
PaxTravelAgentInfo (input) Data type: String Max 25 characters
Used for Airline Reservation Systems. Travel Agent description field. Also known as the Booking Reference on some of DPS screens. Alphanumeric free text field.
PostPassword (input) Data type: String Max 32 characters
Used with PostUsername to determine account for settlement. Payment Express clients can be set up with more than one bank account. Each transaction may be designated for a specific account if required.
PostUsername (input) Data type: String Max 32 characters
Used with PostPassword to determine account for settlement. Payment Express clients can be set up with more than one bank account. Each transaction may be designated for a specific account if required.
ReCo (output) Datatype: String Max 2 characters
Response Code generated by DPS Server (for locally declined transactions) or by the Card Acquirer (for host originated responses). The ReCo should not be checked by the client application, as these values differ according to acquirer. Use the Success property to check for successful finishing of a transaction. Refer to the Response Codes section for a list of valid response code errors generated by Payment Express.
ResponseText (output) Datatype: String Max 32 characters
Response Text associated with the response code of the transaction
Retry (output) Datatype: Boolean True/False
If true, then the transaction should be sent again - the transaction was declined due to a temporary error. If false, then the transaction should not be sent again, regardless of whether it was accepted or declined.
The transaction result returned was not directly influenced by the card details supplied or the standing of the cardholder�s account with the card issuer. Rather, the transaction result can be attributed to a transient state. DPS recommend that, if possible, the merchant resubmit the transaction within reasonable frequencies given that the duration of the state affecting transactions is unknown. If transactions are being repeatedly rejected in excess of that expected to be handled by the application these should be raised for manual intervention and the DPS support team contacted by the merchant.
StatusRequired (output): 1 (true) or 0 (false)
If true then the status of the transaction could not be determined, either because the server could not be reached, because of an error, or because the transaction is still in progress. Your application should call GetStatus until StatusRequired is false (0).
TxnData1, TxnData2, TxnData3 (input): String Max 255 characters
Optional free text fields. Usually assigned at origin website.
TxnRef (input / output) Datatype: String Max 16 characters
An identifier provided by your application to uniquely identify the transaction. This is the TxnRef supplied by the client to initiate the transaction, or, if not supplied, a TxnRef value internally generated by DPS on return. This is required as an input for GetStatus operations.
| Value | Meaning |
Auth |
Authorise - amount is authorised, no funds transferred. |
Complete |
Complete a previous authorisation - funds are transferred. |
Purchase |
Purchase - Funds are transferred immediately. |
Refund |
Refund - Funds transferred immediately. Must be enabled as a special option. |
| Validate | Validation Transaction. Effects a $1.00 Auth to validate card details including expiry date. Often utilised with the EnableAddBillCard property set to 1 to automatically add to Billing Database if the transaction is approved (validate). Note that the Validate transaction type is not enabled by default on live accounts. Please make a request to DPS Support if you would like to utilise this transaction type. |