|
|
|
xAuthorize CC Support - Gateway Integration Guide
Printer-friendly version
Table of Contents
Introduction
xAuthorize uses standard interface specifications that can easily be implemented by payment gateways for rapid inclusion in our list of payment services.
The process for becoming suppoted by the xAuthorize services involves the following steps:
- The payment gateway must provide a URL for a script page which accepts the xAuthorize standard fields and responds with the proper field names.
- The payment gateway is responsible for implementing and testing the script page before xAuthorize can perform testing.
- Once the script page is ready, the payment gateway will need to supply xAuthorize with test account information (including test card numbers).
- xAuthorize will further test the interface to verify its functionality.
- xAuthorize will then release support for the newly added payment gateway.
Component Properties
The following is a list of properties that xAuthorize will post to the script page provided by the payment gateway:
| Property Name |
Format |
Description |
| Address |
String |
Credit card billing street address |
| Amount |
#.## |
Transaction amount |
| ApprovalCode |
String |
Transaction approval code received through voice-authorization. Used for force transactions (TransType="force"). |
| CardCode |
String |
CVV2 or CVC2 code |
| CardNumber |
Numeric |
Credit card number |
| City |
String |
Credit card billing city |
| Company |
String |
Credit card billing company name |
| Country |
String |
Credit card billing country |
| CustomerID |
String |
Customer ID code |
| Description |
String |
Transaction description |
| Email |
String |
Customer's email address |
| ExpDate |
MM/YY |
Credit card expiration date |
| Fax |
String |
Customer's fax number |
| FirstName |
String |
Customer's first name |
| IP |
String |
Customer's IP address |
| LastName |
String |
Customer's last name |
| Login |
String |
Gateway login information (example: Merchant ID) |
| Login2 |
String |
Additional gateway login information |
| OrderID |
String |
Order ID code for transaction |
| Password |
String |
Gateway password |
| Phone |
String |
Customer's phone number |
| State |
String |
Credit card billing state |
| TransID |
String |
Transaction ID returned by Gateway. Used for capture, void and Credit transactions. |
| TransType |
String |
Consult with specific gateway for transaction types supported.
sale: The card will be authorized and the funds will be captured.
A TransID property is returned to be used in future "void" or "credit"
authorize: Only authorizes the funds without capturing.
To capture the funds, use a "capture" transaction and provide the TransID.
capture: Captures a previously authorized transaction. You must supply the TransID
returned by an authorize transaction.
force: Captures a transactions where the TransID is not available. The approval code must be supplied for this type of transaction. Use this method to capture a transaction that has been approved by phone.
credit: Credit funds back to a card. You must supply the TransID returned by a
previous transaction. The amount must not exceed the amount of the previous
transaction. The transactions must be settled before doing a credit. If
the transaction hasn't been settled, use a void instead.
void: Voids a transaction which hasn't been settled. You must supply the TransID
returned by the original transaction.
|
| Zip |
String |
Credit card billing zip code |
Response Properties
The following is a list of properties that should be returned by the payment gateways.
The response format should be pipe-delimeted name/value pairs.
The response field names are NOT case sensitive.
| Property Name |
Format |
Description |
| ApprovalCode |
String |
Credit card approval code |
| AVSCode |
String |
AVS response Code |
| CVV2Code |
String |
CVV2 response code |
| ResponseCode |
Integer |
Response code for transaction:
1 - Approved
2 - Declined
3 - Error
|
| ResponseReason |
String |
Provides further transaction information, for example, provides information for why a card was declined |
| TransID |
String |
Transaction ID returned by gateway |
Sample Response (Approved):
ResponseCode=1|ResponseReason=|ApprovalCode=12345|TransID=1122334455|AVSCode=Y|CVV2Code=N
Sample Response (Declined):
ResponseCode=2|ResponseReason=Invalid card number|ApprovalCode=|TransID=|AVSCode=|CVV2Code=
Sample Response (Error):
ResponseCode=3|ResponseReason=Server timeout|ApprovalCode=|TransID=|AVSCode=|CVV2Code=
Interface Testing
Once the interface has been implemented and tested thoroughly by the payment gateway, test account information should be sent to xAuthorize for further testing.
The following information should be sent to integration@xauthorize.com:
- Payment gateway name
- Payment gateway web address (main company website)
- Contact information (for troubleshooting)
- Script page URL (where the transaction will be sent)
- List of transaction types supported by gateway (sale, authorize, etc..)
- Test account number
- Test credit card number
Once all needed information has been received, xAuthorize will complete the interface testing and release support for the payment gateway. Normally this final steps is performed within 24 hours.
Further integration inquiries should be directed to our integration team.
Click for contact information
|
|
