|
Introduction
This document provides technical specifications for processing financial transactions through Paysafe PaymentXP Gateway Host by interfacing with the Gateway API.
The audiences of this document are for business analysts and software programmers who design, implement, and support the intended system.
Gateway API
Gateway API is a server side application that provides a direct link to the Paysafe PaymentXP Gateway Host. All communications between the client machines and the Gateway API takes place over a Hypertext Transfer Protocol (HTTP) over a 128-bit Secure Socket Layer (HTTPS) on the Internet. Any device or platform with the ability to originate an HTTPS connection can perform financial transactions through the Gateway API.
The request is constructed using name/value pairs as defined per transaction type. The response received would also be in name/value pairs as defined per transaction type.
Test Transaction Information
To verify your transactions processed successfully, log on to the Payment XP gateway at www.paymentxp.com. The credentials are below.
Field |
Value |
URL |
www.paymentxp.com |
Username |
10012 |
Password |
Password@3 |
Test transactions can be submitted with the following information:
Card Type |
Card Number |
Merchant ID |
10012 |
Merchant Key |
Please contact Paysafe for testing credentials |
Hosted Payment Key |
Please contact Paysafe for testing credentials |
Visa |
4111111111111111 |
MasterCard |
5431111111111111 |
Discover |
6011601160116611 |
American Express |
341111111111111 |
Credit Card Expiration |
Use any date beyond today's date in MMYY
format |
Bank Routing Number*
You may use the routing number provided here
or any other valid routing number |
325070760 |
ACH Account Number |
1234567890 |
How to settle a Transaction to Test Refunds
- Login into paymentxp.com
- Click on Reports>Transaction Detail
- Locate the transaction you would like to settle in order to test a refund
- Click on the Transaction ID number
- Click the Settle button
Token Methods
Credit Card Transactions
NOTE: The token will expire in 20 minutes after initialization.
Description:
This method returns a Token that can be used to perform various credit card transactions through the functions below. The Token will replace the values passed in the GetToken method to be used with these functions.
Resource Url:
https://webservice.paymentxp.com/wh/GetToken.aspx
Method:
POST
Request
Parameter | Is Required | Data Type | Max Length | Description |
CardNumber
|
Yes
|
String
|
76
|
Identifies the cardholder’s credit card number. For swiped transaction, if track 2 data exists, then use track2. Otherwise, use track 1 data.
|
CVV2
|
No
|
String
|
4
|
Card Verification Value.
|
ExpirationDateMMYY
|
Yes
|
String
|
4
|
Identifies the cardholder’s account expiration date (format:MMYY).
|
MerchantID
|
Yes
|
Number
|
9
|
The identification that is assigned to the merchant.
|
Response
Field Name | Description |
Token | A unique identifier that represents the account information. |
StatusID | The result of the request. Status 0 indicates an approved token request. |
Message | Status message for token request |
ACH Transactions
NOTE: The token will expire in 20 minutes after initialization.
Description:
GetToken for ACH Transactions
Resource Url:
https://webservice.paymentxp.com/wh/GetToken.aspx
Method:
POST
Request
Parameter | Is Required | Data Type | Max Length | Description |
AccountNumber
|
Yes
|
String
|
17
|
Account Number or DDA
|
MerchantID
|
Yes
|
Number
|
9
|
The identification that is assigned to the merchant.
|
RoutingNumber
|
Yes
|
String
|
9
|
Routing number or ABA
|
Response
Field Name | Description |
Token | A unique identifier that represents the account information. |
StatusID | The result of the request. Status 0 indicates an approved token request. |
Message | Status message for token request |
Hosted Payment
NOTE: The token will expire in 20 minutes after initialization.
Description:
GetToken for Payment Hosted
Resource Url:
https://webservice.paymentxp.com/wh/GetToken.aspx
Method:
POST
Request
Parameter | Is Required | Data Type | Max Length | Description |
MerchantID
|
Yes
|
Number
|
9
|
The identification that is assigned to the merchant.
|
MerchantKey
|
Yes
|
String
|
36
|
Unique Key assigned by Paysafe
|
TransactionAmount
|
Yes
|
Number
|
9
|
Identifies the transaction’s total amount in US Dollars.
|
Response
Field Name | Description |
Token | A unique identifier that represents the account information. |
StatusID | The result of the request. Status 0 indicates an approved token request. |
Message | Status message for token request |
Customer Hosted
NOTE: The token will expire in 20 minutes after initialization.
Description:
GetToken for Customer Hosted
Resource Url:
https://webservice.paymentxp.com/wh/GetToken.aspx
Method:
POST
Request
Parameter | Is Required | Data Type | Max Length | Description |
CustomerID
|
Yes
|
String
|
255
|
If you supply an existing CustomerID, then the page willedit the existing customer information. If the CustomerID does not exists, then it will create it.
|
MerchantID
|
Yes
|
Number
|
9
|
The identification that is assigned to the merchant.
|
MerchantKey
|
Yes
|
String
|
36
|
Unique Key assigned by Paysafe
|
Response
Field Name | Description |
Token | A unique identifier that represents the account information. |
StatusID | The result of the request. Status 0 indicates an approved token request. |
Message | Status message for token request |
Credit Card Methods
CreditCardAuthorization
Description:
This method authorizes a credit card transaction by requesting an authorization number from the card issuer. An approved authorization means that the transaction dollar amount has been reserved for usage but not yet deducted from the cardholder’s account. Funds are not settled (transferred to the merchant) until the CreditCardSettle() method is called using the authorization number returned by this method.
Resource Url:
https://webservice.paymentxp.com/wh/WebHost.aspx
Method:
POST
For COF support: For Stored Credentials support five new fields ('InitiatedBy','InitialTransactionID', 'StoredCredentialIndicator' , 'ScheduleIndicator' and 'MarketSegment') have been added. All of the five fields are optional. But merchant must send all or none.
For straight Sale transaction supporting COF merchant should send 4 fields ('InitiatedBy', 'StoredCredentialIndicator' , 'ScheduleIndicator' and 'MarketSegment'). For recurring transactions supporting COF merchant must send all 5 fields.
Request
Parameter | Is Required | Data Type | Max Length | Description |
BillingAddress
|
No
|
String
|
50
|
The billing address of the cardholder. Used to check for AVS identification.
|
BillingCity
|
No
|
String
|
50
|
The billing city of the cardholder.
|
BillingCountry
|
No
|
String
|
50
|
The billing country of the cardholder.
|
BillingFullName
|
No
|
String
|
50
|
The name of the cardholder as it appears on the card.
|
BillingMethod
|
No
|
String
|
50
|
Values: 'initial_recurring' or 'recurring'
|
BillingNameFirst
|
Yes
|
String
|
50
|
The first name of the cardholder.
Note: Required if BillingFullName not present
|
BillingNameLast
|
Yes
|
String
|
50
|
The last name of the cardholder.
Note: Required if BillingFullName not present
|
BillingState
|
No
|
String
|
25
|
The billing state of the cardholder.
|
BillingZipCode
|
No
|
String
|
10
|
The billing zip code of the cardholder. Used to check for AVS identification.
|
CardNumber
|
Yes
|
String
|
76
|
Identifies the cardholder’s credit card number. For swiped transaction, if track 2 data exists, then use track2. Otherwise, use track 1 data. Note: not required if you supplied a Token
|
ClerkID
|
No
|
String
|
15
|
The cashier/clerk who initiated the transaction.
|
ClientIPAddress
|
No
|
String
|
25
|
The IP address of the client device.
|
Custominfo1 (1-20)
|
No
|
String
|
255
|
For merchant use.
|
CVV2
|
No
|
String
|
4
|
Card Verification Value. Leave this field empty if you’re doing swiped transactions or are using a Paysafe Token
|
EmailAddress
|
No
|
String
|
50
|
The e-mail address of the cardholder.
|
EncryptedDevice
|
No
|
String
|
2000
|
String identifying device.
|
ExpirationDateMMYY
|
Yes
|
String
|
4
|
Identifies the cardholder’s account expiration date (format:MMYY). Note:Leave this field empty if you are swiping transactions or are using a Paysafe Token
|
InitialTransactionID
|
No
|
String
|
30
|
Original payment gateway transaction id.
|
InitiatedBy
|
No
|
String
|
50
|
Who initiated the transaction. Values: 'customer' or 'merchant'
|
IsRecurring
|
No
|
Boolean
|
1
|
Indicates transaction is a recurring transaction
|
MarketSegment
|
No
|
String
|
50
|
Values: 'Ecommerce' or 'Retail' or 'Moto'
|
MerchantID
|
Yes
|
Number
|
9
|
The identification that is assigned to the merchant.
|
MerchantKey
|
Yes
|
String
|
36
|
A unique identification that is assigned to the merchant id.
|
PaymentMemo
|
No
|
String
|
50
|
Additional payment memo.
|
PhoneNumber
|
No
|
String
|
10
|
The phone number of the cardholder.
|
ReferenceNumber
|
No
|
String
|
50
|
The merchant/customer transaction identifier.
|
ScheduleIndicator
|
No
|
String
|
50
|
Values: 'Scheduled' or 'Unscheduled'
|
ShippingAddress1
|
No
|
String
|
50
|
The shipping address for the product(s) purchased in the transaction.
|
ShippingAddress2
|
No
|
String
|
50
|
Additional shipping address information for the product(s)purchased in the transaction.
|
ShippingCity
|
No
|
String
|
50
|
The shipping city for the product(s) purchased in the transaction.
|
ShippingCountry
|
No
|
String
|
50
|
The shipping country for the product(s) purchased in the transaction.
|
ShippingState
|
No
|
String
|
25
|
The shipping state for the product(s) purchased in the transaction.
|
ShippingZipCode
|
No
|
String
|
10
|
The shipping zip code for the product(s) purchased in the transaction.
|
StoredCredentialIndicator
|
No
|
String
|
50
|
The indicator of the stored credential. Values: 'stored' or 'used' Use 'stored' when processing the initial transaction in which you are storing a customer's payment details (customer credentials) in the Customer Vault or other third-party payment storage system. Use 'used' when processing a subsequent or follow-up transaction using the customer payment details (customer credentials) you have already stored to the Customer Vault or third-party payment storage method.
|
Token
|
No
|
String
|
40
|
If you have a Paysafe Token, then use it here. When using the Paysafe Token, CardNumber, ExpirationDateMMYY, and CVV2 should not be passed.
|
TransactionAmount
|
Yes
|
Number
|
9
|
Identifies the transaction’s total amount in US dollars. Enter values between 1.00-999999.99
|
TransactionType
|
Yes
|
String
|
23
|
CreditCardAuthorization
|
Response
Field Name | Description |
PostedDate | The date and time the transaction was posted. |
StatusID | The result of the transaction. Status 0 indicates an approved transaction. |
TransactionID | The number that identifies the transaction in the Paysafe Solutions system. |
ReferenceNumber | The merchant/customer transaction identifier that was sent in the initial request. |
TransactionAmount | Identifies the transaction amount that was sent in the initial request. |
AuthorizationCode | Authorization code from the issuing bank. |
ResponseCode | The approval or decline code from the processor. |
ResponseMessage | The approval or decline message from the processor. |
CVV2ResponseCode | The CVV2 response code. |
CVV2ResponseMessage | The CVV2 response message. |
AVSResponseCode | The AVS response code. |
AVSResponseMessage | The AVS response message. |
URLPostback | URL to redirect customer after sale has been posted |
CardNumber | Identifies the last 4 cardholder’s account number. |
CustomerName | The name of the cardholder as it appears on the card. |
BillingNameFirst | The first name of the cardholder. |
BillingNameLast | The last name of the cardholder. |
BillingAddress | The billing address of the cardholder. Used to check for AVS identification. |
BillingCity | The billing city of the cardholder. |
BillingState | The billing state of the cardholder. |
BillingZip | The billing zip code of the cardholder. Used to check for AVS identification. |
BillingCountry | The billing country of the cardholder. |
BillingPhone | The phone number of the cardholder. |
BillingFax | The fax number of the cardholder |
BillingEmail | The e-mail address of the cardholder. |
CustomerID | An existing customer record. |
ProductDesc | Use to identify product name. |
Action | The action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available. |
ShippingAddress1 | The shipping address of the cardholder. |
ShippingAddress2 | The shipping address of the cardholder. |
ShippingCity | The shipping city of the cardholder. |
ShippingState | The shipping state of the cardholder. |
ShippingZipCode | The shipping zip code of the cardholder. Used to check for AVS identification. |
ShippingCountry | The shipping country of the cardholder. |
Custominfo1 (1-20) | For merchant use. |
TransTypeID | Identifies the type of transaction that was processed. View appendix F. |
SettleDate | The date and time the transaction was settled. |
VoidDate | The date and time the transaction was voided. |
RefundDate | The date and time the transaction was refunded. |
TransactionStatusID | Identifies the status of the transaction that was processed. View appendix G. |
CreditCardCapture
Description:
This method captures (transfers to the merchant) a transaction previously authorized with the Authorize() method. Captured transactions are scheduled for settlement at the determined batch time.
Resource Url:
https://webservice.paymentxp.com/wh/WebHost.aspx
Method:
POST
For COF support: For Stored Credentials support five new fields ('InitiatedBy','InitialTransactionID', 'StoredCredentialIndicator' , 'ScheduleIndicator' and 'MarketSegment') have been added. All of the five fields are optional. But merchant must send all or none.
For straight Sale transaction supporting COF merchant should send 4 fields ('InitiatedBy', 'StoredCredentialIndicator' , 'ScheduleIndicator' and 'MarketSegment'). For recurring transactions supporting COF merchant must send all 5 fields.
Request
Parameter | Is Required | Data Type | Max Length | Description |
BillingMethod
|
No
|
String
|
50
|
Values: 'initial_recurring' or 'recurring'
|
ClerkID
|
No
|
String
|
15
|
The cashier/clerk who initiated the transaction.
|
InitialTransactionID
|
No
|
String
|
30
|
Original payment gateway transaction id.
|
InitiatedBy
|
No
|
String
|
50
|
Who initiated the transaction. Values: 'customer' or 'merchant'
|
MarketSegment
|
No
|
String
|
50
|
Values: 'Ecommerce' or 'Retail' or 'Moto'
|
MerchantID
|
Yes
|
Number
|
9
|
The identification that is assigned to the merchant.
|
MerchantKey
|
Yes
|
String
|
36
|
A unique identification that is assigned to the merchant id.
|
ReferenceNumber
|
Yes
|
String
|
50
|
The merchant/customer transaction identifier.
|
ScheduleIndicator
|
No
|
String
|
50
|
Values: 'Scheduled' or 'Unscheduled'
|
StoredCredentialIndicator
|
No
|
String
|
50
|
The indicator of the stored credential. Values: 'stored' or 'used' Use 'stored' when processing the initial transaction in which you are storing a customer's payment details (customer credentials) in the Customer Vault or other third-party payment storage system. Use 'used' when processing a subsequent or follow-up transaction using the customer payment details (customer credentials) you have already stored to the Customer Vault or third-party payment storage method.
|
TransactionAmount
|
Yes
|
Number
|
9
|
Identifies the transaction’s total amount in US dollars. Enter values between 1.00-999999.99
|
TransactionID
|
Yes
|
Number
|
19
|
Identifies the transaction to be settled. This is the TransactionID value returned from the CreditCardAuthorization() method call. The transaction id to settle.
|
TransactionType
|
Yes
|
String
|
16
|
CreditCardSettle
|
Response
Field Name | Description |
PostedDate | The date and time the transaction was posted. |
StatusID | The result of the transaction. Status 0 indicates an approved transaction. |
TransactionID | The number that identifies the transaction in the Paysafe Solutions system. |
ReferenceNumber | The merchant/customer transaction identifier that was sent in the initial request. |
TransactionAmount | Identifies the transaction amount that was sent in the initial request. |
AuthorizationCode | Authorization code from the issuing bank. |
ResponseCode | The approval or decline code from the processor. |
ResponseMessage | The approval or decline message from the processor. |
CVV2ResponseCode | The CVV2 response code. |
CVV2ResponseMessage | The CVV2 response message. |
AVSResponseCode | The AVS response code. |
AVSResponseMessage | The AVS response message. |
URLPostback | URL to redirect customer after sale has been posted |
CardNumber | Identifies the last 4 cardholder’s account number. |
CustomerName | The name of the cardholder as it appears on the card. |
BillingNameFirst | The first name of the cardholder. |
BillingNameLast | The last name of the cardholder. |
BillingAddress | The billing address of the cardholder. Used to check for AVS identification. |
BillingCity | The billing city of the cardholder. |
BillingState | The billing state of the cardholder. |
BillingZip | The billing zip code of the cardholder. Used to check for AVS identification. |
BillingCountry | The billing country of the cardholder. |
BillingPhone | The phone number of the cardholder. |
BillingFax | The fax number of the cardholder |
BillingEmail | The e-mail address of the cardholder. |
CustomerID | An existing customer record. |
ProductDesc | Use to identify product name. |
Action | The action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available. |
ShippingAddress1 | The shipping address of the cardholder. |
ShippingAddress2 | The shipping address of the cardholder. |
ShippingCity | The shipping city of the cardholder. |
ShippingState | The shipping state of the cardholder. |
ShippingZipCode | The shipping zip code of the cardholder. Used to check for AVS identification. |
ShippingCountry | The shipping country of the cardholder. |
Custominfo1 (1-20) | For merchant use. |
TransTypeID | Identifies the type of transaction that was processed. View appendix F. |
SettleDate | The date and time the transaction was settled. |
VoidDate | The date and time the transaction was voided. |
RefundDate | The date and time the transaction was refunded. |
TransactionStatusID | Identifies the status of the transaction that was processed. View appendix G. |
CreditCardCharge
Description:
This method performs both authorization and settlement into one operation.
Resource Url:
https://webservice.paymentxp.com/wh/WebHost.aspx
Method:
POST
For COF support: For Stored Credentials support five new fields ('InitiatedBy','InitialTransactionID', 'StoredCredentialIndicator' , 'ScheduleIndicator' and 'MarketSegment') have been added. All of the five fields are optional. But merchant must send all or none.
For straight Sale transaction supporting COF merchant should send 4 fields ('InitiatedBy', 'StoredCredentialIndicator' , 'ScheduleIndicator' and 'MarketSegment'). For recurring transactions supporting COF merchant must send all 5 fields.
Request
Parameter | Is Required | Data Type | Max Length | Description |
BillingAddress
|
No
|
String
|
50
|
The billing address of the cardholder. Used to check for AVS identification.
|
BillingCity
|
No
|
String
|
50
|
The billing city of the cardholder.
|
BillingCountry
|
No
|
String
|
50
|
The billing country of the cardholder.
|
BillingFullName
|
No
|
String
|
50
|
The name of the cardholder as it appears on the card.
|
BillingMethod
|
No
|
String
|
50
|
Values: 'initial_recurring' or 'recurring'
|
BillingNameFirst
|
Yes
|
String
|
50
|
The first name of the cardholder.
Note: Required if BillingFullName not present
|
BillingNameLast
|
Yes
|
String
|
50
|
The last name of the cardholder.
Note: Required if BillingFullName not present
|
BillingState
|
No
|
String
|
25
|
The billing state of the cardholder.
|
BillingZipCode
|
No
|
String
|
10
|
The billing zip code of the cardholder. Used to check for AVS identification.
|
CardNumber
|
Yes
|
String
|
76
|
Identifies the cardholder’s credit card number. For swiped transaction, if track 2 data exists, then use track2. Otherwise, use track 1 data. Note: not required if you supplied a Token
|
ClerkID
|
No
|
String
|
15
|
The cashier/clerk who initiated the transaction.
|
ClientIPAddress
|
No
|
String
|
25
|
The IP address of the client device.
|
Custominfo1 (1-20)
|
No
|
String
|
255
|
For merchant use.
|
CVV2
|
No
|
String
|
4
|
Card Verification Value. Leave this field empty if you’re doing swiped transactions or are using a Paysafe Token
|
EmailAddress
|
No
|
String
|
50
|
The e-mail address of the cardholder.
|
EncryptedDevice
|
No
|
String
|
2000
|
String identifying device.
|
ExpirationDateMMYY
|
Yes
|
String
|
4
|
Identifies the cardholder’s account expiration date (format:MMYY). Note:: Leave this field empty if you are swiping transactions or are using a Paysafe Token
|
InitialTransactionID
|
No
|
String
|
30
|
Original payment gateway transaction id.
|
InitiatedBy
|
No
|
String
|
50
|
Who initiated the transaction. Values: 'customer' or 'merchant'
|
IsRecurring
|
No
|
Boolean
|
1
|
Indicates transaction is a recurring transaction
|
MarketSegment
|
No
|
String
|
50
|
Values: 'Ecommerce' or 'Retail' or 'Moto'
|
MerchantID
|
Yes
|
Number
|
9
|
The identification that is assigned to the merchant.
|
MerchantKey
|
Yes
|
String
|
36
|
A unique identification that is assigned to the merchant id.
|
PaymentMemo
|
No
|
String
|
50
|
Additional payment memo.
|
PhoneNumber
|
No
|
String
|
10
|
The phone number of the cardholder.
|
PostBackURL
|
No
|
String
|
255
|
URL to redirect customer after sale has been posted
|
ReferenceNumber
|
No
|
String
|
50
|
The merchant/customer transaction identifier.
|
ScheduleIndicator
|
No
|
String
|
50
|
Values: 'Scheduled' or 'Unscheduled'
|
ShippingAddress1
|
No
|
String
|
50
|
The shipping address for the product(s) purchased in the transaction.
|
ShippingAddress2
|
No
|
String
|
50
|
Additional shipping address information for the product(s)purchased in the transaction.
|
ShippingCity
|
No
|
String
|
50
|
The shipping city for the product(s) purchased in the transaction.
|
ShippingCountry
|
No
|
String
|
50
|
The shipping country for the product(s) purchased in the transaction.
|
ShippingState
|
No
|
String
|
25
|
The shipping state for the product(s) purchased in the transaction.
|
ShippingZipCode
|
No
|
String
|
10
|
The shipping zip code for the product(s) purchased in the transaction.
|
StoredCredentialIndicator
|
No
|
String
|
50
|
The indicator of the stored credential. Values: 'stored' or 'used' Use 'stored' when processing the initial transaction in which you are storing a customer's payment details (customer credentials) in the Customer Vault or other third-party payment storage system. Use 'used' when processing a subsequent or follow-up transaction using the customer payment details (customer credentials) you have already stored to the Customer Vault or third-party payment storage method.
|
Token
|
No
|
String
|
40
|
If you have a Paysafe Token, then use it here.
|
TransactionAmount
|
Yes
|
Number
|
9
|
Identifies the transaction’s total amount in US dollars. Enter values between 1.00-999999.99
|
TransactionType
|
Yes
|
String
|
16
|
CreditCardCharge
|
Response
Field Name | Description |
PostedDate | The date and time the transaction was posted. |
StatusID | The result of the transaction. Status 0 indicates an approved transaction. |
TransactionID | The number that identifies the transaction in the Paysafe Solutions system. |
ReferenceNumber | The merchant/customer transaction identifier that was sent in the initial request. |
TransactionAmount | Identifies the transaction amount that was sent in the initial request. |
AuthorizationCode | Authorization code from the issuing bank. |
ResponseCode | The approval or decline code from the processor. |
ResponseMessage | The approval or decline message from the processor. |
CVV2ResponseCode | The CVV2 response code. |
CVV2ResponseMessage | The CVV2 response message. |
AVSResponseCode | The AVS response code. |
AVSResponseMessage | The AVS response message. |
URLPostback | URL to redirect customer after sale has been posted |
CardNumber | Identifies the last 4 cardholder’s account number. |
CustomerName | The name of the cardholder as it appears on the card. |
BillingNameFirst | The first name of the cardholder. |
BillingNameLast | The last name of the cardholder. |
BillingAddress | The billing address of the cardholder. Used to check for AVS identification. |
BillingCity | The billing city of the cardholder. |
BillingState | The billing state of the cardholder. |
BillingZip | The billing zip code of the cardholder. Used to check for AVS identification. |
BillingCountry | The billing country of the cardholder. |
BillingPhone | The phone number of the cardholder. |
BillingFax | The fax number of the cardholder |
BillingEmail | The e-mail address of the cardholder. |
CustomerID | An existing customer record. |
ProductDesc | Use to identify product name. |
Action | The action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available. |
ShippingAddress1 | The shipping address of the cardholder. |
ShippingAddress2 | The shipping address of the cardholder. |
ShippingCity | The shipping city of the cardholder. |
ShippingState | The shipping state of the cardholder. |
ShippingZipCode | The shipping zip code of the cardholder. Used to check for AVS identification. |
ShippingCountry | The shipping country of the cardholder. |
Custominfo1 (1-20) | For merchant use. |
TransTypeID | Identifies the type of transaction that was processed. View appendix F. |
SettleDate | The date and time the transaction was settled. |
VoidDate | The date and time the transaction was voided. |
RefundDate | The date and time the transaction was refunded. |
TransactionStatusID | Identifies the status of the transaction that was processed. View appendix G. |
CreditCardCredit
Description:
This method credits a credit card account with an originating Settle or Charge transaction. The credit is based on a prior transaction performed through either CreditCardSettle() or CreditCardCharge().
Resource Url:
https://webservice.paymentxp.com/wh/WebHost.aspx
Method:
POST
Request
Parameter | Is Required | Data Type | Max Length | Description |
ClerkID
|
No
|
String
|
15
|
The cashier/clerk who initiated the transaction.
|
MerchantID
|
Yes
|
Number
|
9
|
The identification that is assigned to the merchant.
|
MerchantKey
|
Yes
|
String
|
36
|
A unique identification that is assigned to the merchant id.
|
ReferenceNumber
|
Yes
|
String
|
50
|
The merchant/customer transaction identifier.
|
TransactionAmount
|
Yes
|
Number
|
9
|
Identifies the transaction’s total amount in US dollars. Enter values between 1.00-999999.99
|
TransactionID
|
Yes
|
Number
|
19
|
This is the TransactionID value returned from the CreditCardAuthorization() or CreditCardCharge() method.
|
TransactionType
|
Yes
|
String
|
16
|
CreditCardCredit
|
Response
Field Name | Description |
PostedDate | The date and time the transaction was posted. |
StatusID | The result of the transaction. Status 0 indicates an approved transaction. |
TransactionID | The number that identifies the transaction in the Paysafe Solutions system. |
ReferenceNumber | The merchant/customer transaction identifier that was sent in the initial request. |
TransactionAmount | Identifies the transaction amount that was sent in the initial request. |
AuthorizationCode | Authorization code from the issuing bank. |
ResponseCode | The approval or decline code from the processor. |
ResponseMessage | The approval or decline message from the processor. |
CVV2ResponseCode | The CVV2 response code. |
CVV2ResponseMessage | The CVV2 response message. |
AVSResponseCode | The AVS response code. |
AVSResponseMessage | The AVS response message. |
URLPostback | URL to redirect customer after sale has been posted |
CardNumber | Identifies the last 4 cardholder’s account number. |
CustomerName | The name of the cardholder as it appears on the card. |
BillingNameFirst | The first name of the cardholder. |
BillingNameLast | The last name of the cardholder. |
BillingAddress | The billing address of the cardholder. Used to check for AVS identification. |
BillingCity | The billing city of the cardholder. |
BillingState | The billing state of the cardholder. |
BillingZip | The billing zip code of the cardholder. Used to check for AVS identification. |
BillingCountry | The billing country of the cardholder. |
BillingPhone | The phone number of the cardholder. |
BillingFax | The fax number of the cardholder |
BillingEmail | The e-mail address of the cardholder. |
CustomerID | An existing customer record. |
ProductDesc | Use to identify product name. |
Action | The action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available. |
ShippingAddress1 | The shipping address of the cardholder. |
ShippingAddress2 | The shipping address of the cardholder. |
ShippingCity | The shipping city of the cardholder. |
ShippingState | The shipping state of the cardholder. |
ShippingZipCode | The shipping zip code of the cardholder. Used to check for AVS identification. |
ShippingCountry | The shipping country of the cardholder. |
Custominfo1 (1-20) | For merchant use. |
TransTypeID | Identifies the type of transaction that was processed. View appendix F. |
SettleDate | The date and time the transaction was settled. |
VoidDate | The date and time the transaction was voided. |
RefundDate | The date and time the transaction was refunded. |
TransactionStatusID | Identifies the status of the transaction that was processed. View appendix G. |
CreditCardVoid
Description:
This method cancels a previously completed Authorization or Charge transaction. A transaction that has already been settled using the CreditCardSettle() method cannot be voided, but instead do perform a Credit on the account.
Resource Url:
https://webservice.paymentxp.com/wh/WebHost.aspx
Method:
POST
For COF support: For Stored Credentials support five new fields ('InitiatedBy','InitialTransactionID', 'StoredCredentialIndicator' , 'ScheduleIndicator' and 'MarketSegment') have been added. All of the five fields are optional. But merchant must send all or none.
For straight Sale transaction supporting COF merchant should send 4 fields ('InitiatedBy', 'StoredCredentialIndicator' , 'ScheduleIndicator' and 'MarketSegment'). For recurring transactions supporting COF merchant must send all 5 fields.
Request
Parameter | Is Required | Data Type | Max Length | Description |
ClerkID
|
No
|
String
|
15
|
The cashier/clerk who initiated the transaction.
|
InitialTransactionID
|
No
|
String
|
30
|
Original payment gateway transaction id.
|
InitiatedBy
|
No
|
String
|
50
|
Who initiated the transaction. Values: 'customer' or 'merchant'
|
MarketSegment
|
No
|
String
|
50
|
Values: 'Ecommerce' or 'Retail' or 'Moto'
|
MerchantID
|
Yes
|
Number
|
9
|
The identification that is assigned to the merchant.
|
MerchantKey
|
Yes
|
String
|
36
|
A unique identification that is assigned to the merchant id.
|
ReferenceNumber
|
No
|
String
|
50
|
The merchant/customer transaction identifier.
|
ScheduleIndicator
|
No
|
String
|
50
|
Values: 'Scheduled' or 'Unscheduled'
|
StoredCredentialIndicator
|
No
|
String
|
50
|
The indicator of the stored credential. Values: 'stored' or 'used' Use 'stored' when processing the initial transaction in which you are storing a customer's payment details (customer credentials) in the Customer Vault or other third-party payment storage system. Use 'used' when processing a subsequent or follow-up transaction using the customer payment details (customer credentials) you have already stored to the Customer Vault or third-party payment storage method.
|
TransactionID
|
Yes
|
Number
|
19
|
The TransactionID value returned by CreditCardAuthorization() or CreditCardCharge() transaction.
|
TransactionType
|
Yes
|
String
|
14
|
CreditCardVoid
|
Response
Field Name | Description |
PostedDate | The date and time the transaction was posted. |
StatusID | The result of the transaction. Status 0 indicates an approved transaction. |
TransactionID | The number that identifies the transaction in the Paysafe Solutions system. |
ReferenceNumber | The merchant/customer transaction identifier that was sent in the initial request. |
TransactionAmount | Identifies the transaction amount that was sent in the initial request. |
AuthorizationCode | Authorization code from the issuing bank. |
ResponseCode | The approval or decline code from the processor. |
ResponseMessage | The approval or decline message from the processor. |
CVV2ResponseCode | The CVV2 response code. |
CVV2ResponseMessage | The CVV2 response message. |
AVSResponseCode | The AVS response code. |
AVSResponseMessage | The AVS response message. |
URLPostback | URL to redirect customer after sale has been posted |
CardNumber | Identifies the last 4 cardholder’s account number. |
CustomerName | The name of the cardholder as it appears on the card. |
BillingNameFirst | The first name of the cardholder. |
BillingNameLast | The last name of the cardholder. |
BillingAddress | The billing address of the cardholder. Used to check for AVS identification. |
BillingCity | The billing city of the cardholder. |
BillingState | The billing state of the cardholder. |
BillingZip | The billing zip code of the cardholder. Used to check for AVS identification. |
BillingCountry | The billing country of the cardholder. |
BillingPhone | The phone number of the cardholder. |
BillingFax | The fax number of the cardholder |
BillingEmail | The e-mail address of the cardholder. |
CustomerID | An existing customer record. |
ProductDesc | Use to identify product name. |
Action | The action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available. |
ShippingAddress1 | The shipping address of the cardholder. |
ShippingAddress2 | The shipping address of the cardholder. |
ShippingCity | The shipping city of the cardholder. |
ShippingState | The shipping state of the cardholder. |
ShippingZipCode | The shipping zip code of the cardholder. Used to check for AVS identification. |
ShippingCountry | The shipping country of the cardholder. |
Custominfo1 (1-20) | For merchant use. |
TransTypeID | Identifies the type of transaction that was processed. View appendix F. |
SettleDate | The date and time the transaction was settled. |
VoidDate | The date and time the transaction was voided. |
RefundDate | The date and time the transaction was refunded. |
TransactionStatusID | Identifies the status of the transaction that was processed. View appendix G. |
CreditCardCreditReversal
Description:
This method cancels a previously completed/authorized Credit transaction. A Credit transaction that has already been authorized for settlement using the CreditCardCredit() method but not yet submitted for settlement, cannot be voided but instead perform a CreditCardCreditReversal to reverse the amount.
Resource Url:
https://webservice.paymentxp.com/wh/WebHost.aspx
Method:
POST
Request
Parameter | Is Required | Data Type | Max Length | Description |
ClerkID
|
No
|
String
|
15
|
The cashier/clerk who initiated the transaction.
|
MerchantID
|
Yes
|
Number
|
9
|
The identification that is assigned to the merchant.
|
MerchantKey
|
Yes
|
String
|
15
|
A unique identification that is assigned to the merchant id.
|
ReferenceNumber
|
No
|
String
|
50
|
The merchant/customer transaction identifier.
|
TransactionID
|
Yes
|
Number
|
19
|
The TransactionID value returned by CreditCardAuthorization() or CreditCardCharge() transaction.
|
TransactionType
|
Yes
|
String
|
14
|
CreditCardCreditReversal
|
Response
Field Name | Description |
PostedDate | The date and time the transaction was posted. |
StatusID | The result of the transaction. Status 0 indicates an approved transaction. |
TransactionID | The number that identifies the transaction in the Paysafe Solutions system. |
ReferenceNumber | The merchant/customer transaction identifier that was sent in the initial request. |
TransactionAmount | Identifies the transaction amount that was sent in the initial request. |
AuthorizationCode | Authorization code from the issuing bank. |
ResponseCode | The approval or decline code from the processor. |
ResponseMessage | The approval or decline message from the processor. |
CVV2ResponseCode | The CVV2 response code. |
CVV2ResponseMessage | The CVV2 response message. |
AVSResponseCode | The AVS response code. |
AVSResponseMessage | The AVS response message. |
URLPostback | URL to redirect customer after sale has been posted |
CardNumber | Identifies the last 4 cardholder’s account number. |
CustomerName | The name of the cardholder as it appears on the card. |
BillingNameFirst | The first name of the cardholder. |
BillingNameLast | The last name of the cardholder. |
BillingAddress | The billing address of the cardholder. Used to check for AVS identification. |
BillingCity | The billing city of the cardholder. |
BillingState | The billing state of the cardholder. |
BillingZip | The billing zip code of the cardholder. Used to check for AVS identification. |
BillingCountry | The billing country of the cardholder. |
BillingPhone | The phone number of the cardholder. |
BillingFax | The fax number of the cardholder |
BillingEmail | The e-mail address of the cardholder. |
CustomerID | An existing customer record. |
ProductDesc | Use to identify product name. |
Action | The action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available. |
ShippingAddress1 | The shipping address of the cardholder. |
ShippingAddress2 | The shipping address of the cardholder. |
ShippingCity | The shipping city of the cardholder. |
ShippingState | The shipping state of the cardholder. |
ShippingZipCode | The shipping zip code of the cardholder. Used to check for AVS identification. |
ShippingCountry | The shipping country of the cardholder. |
Custominfo1 (1-20) | For merchant use. |
TransTypeID | Identifies the type of transaction that was processed. View appendix F. |
SettleDate | The date and time the transaction was settled. |
VoidDate | The date and time the transaction was voided. |
RefundDate | The date and time the transaction was refunded. |
TransactionStatusID | Identifies the status of the transaction that was processed. View appendix G. |
CreditCardAdjust
Description:
This method modifies the Transaction Amount of a previously processed CreditCardCharge(), CreditCardAuthorization(), or AddCustomerCCCharge(). This method can be used to modify the captured amount up to the original Transaction Amount. To Adjust over the original Transaction Amount, contact your Integration Specialist for more details.
Resource Url:
https://webservice.paymentxp.com/wh/WebHost.aspx
Method:
POST
Request
Parameter | Is Required | Data Type | Max Length | Description |
MerchantID
|
Yes
|
Number
|
9
|
The identification that is assigned to the merchant.
|
MerchantKey
|
Yes
|
String
|
36
|
A unique identification that is assigned to the merchant id.
|
TransactionAmount
|
Yes
|
Number
|
9
|
Identifies the transaction’s total amount in US dollars. Enter values between 1.00-999999.99
|
TransactionID
|
Yes
|
Number
|
19
|
The TransactionID value returned by CreditCardAuthorization() or CreditCardCharge() transaction.
|
TransactionType
|
Yes
|
String
|
14
|
CreditCardAdjust
|
Response
Field Name | Description |
PostedDate | The date and time the transaction was posted. |
StatusID | The result of the transaction. Status 0 indicates an approved transaction. |
TransactionID | The number that identifies the transaction in the Paysafe Solutions system. |
ReferenceNumber | The merchant/customer transaction identifier that was sent in the initial request. |
TransactionAmount | Identifies the transaction amount that was sent in the initial request. |
AuthorizationCode | Authorization code from the issuing bank. |
ResponseCode | The approval or decline code from the processor. |
ResponseMessage | The approval or decline message from the processor. |
CVV2ResponseCode | The CVV2 response code. |
CVV2ResponseMessage | The CVV2 response message. |
AVSResponseCode | The AVS response code. |
AVSResponseMessage | The AVS response message. |
URLPostback | URL to redirect customer after sale has been posted |
CardNumber | Identifies the last 4 cardholder’s account number. |
CustomerName | The name of the cardholder as it appears on the card. |
BillingNameFirst | The first name of the cardholder. |
BillingNameLast | The last name of the cardholder. |
BillingAddress | The billing address of the cardholder. Used to check for AVS identification. |
BillingCity | The billing city of the cardholder. |
BillingState | The billing state of the cardholder. |
BillingZip | The billing zip code of the cardholder. Used to check for AVS identification. |
BillingCountry | The billing country of the cardholder. |
BillingPhone | The phone number of the cardholder. |
BillingFax | The fax number of the cardholder |
BillingEmail | The e-mail address of the cardholder. |
CustomerID | An existing customer record. |
ProductDesc | Use to identify product name. |
Action | The action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available. |
ShippingAddress1 | The shipping address of the cardholder. |
ShippingAddress2 | The shipping address of the cardholder. |
ShippingCity | The shipping city of the cardholder. |
ShippingState | The shipping state of the cardholder. |
ShippingZipCode | The shipping zip code of the cardholder. Used to check for AVS identification. |
ShippingCountry | The shipping country of the cardholder. |
Custominfo1 (1-20) | For merchant use. |
TransTypeID | Identifies the type of transaction that was processed. View appendix F. |
SettleDate | The date and time the transaction was settled. |
VoidDate | The date and time the transaction was voided. |
RefundDate | The date and time the transaction was refunded. |
TransactionStatusID | Identifies the status of the transaction that was processed. View appendix G. |
CreditCardCaptureOnly
Description:
This method creates a credit card transaction for settlement by with an offline authorization number from the card issuer. An approved authorization through other means is required to be submitted.
Resource Url:
https://webservice.paymentxp.com/wh/WebHost.aspx
Method:
POST
For COF support: For Stored Credentials support five new fields ('InitiatedBy','InitialTransactionID', 'StoredCredentialIndicator' , 'ScheduleIndicator' and 'MarketSegment') have been added. All of the five fields are optional. But merchant must send all or none.
For straight Sale transaction supporting COF merchant should send 4 fields ('InitiatedBy', 'StoredCredentialIndicator' , 'ScheduleIndicator' and 'MarketSegment'). For recurring transactions supporting COF merchant must send all 5 fields.
Request
Parameter | Is Required | Data Type | Max Length | Description |
AuthCode
|
Yes
|
String
|
6
|
6 digit authorization code received through offline authorization methods.
|
BillingAddress
|
No
|
String
|
50
|
The billing address of the cardholder. Used to check for AVS identification.
|
BillingCity
|
No
|
String
|
50
|
The billing city of the cardholder.
|
BillingCountry
|
No
|
String
|
50
|
The billing country of the cardholder.
|
BillingFullName
|
No
|
String
|
50
|
The name of the cardholder as it appears on the card.
|
BillingMethod
|
No
|
String
|
50
|
Values: 'initial_recurring' or 'recurring'
|
BillingNameFirst
|
Yes
|
String
|
50
|
The first name of the cardholder.
Note: Required if BillingFullName not present
|
BillingNameLast
|
Yes
|
String
|
50
|
The last name of the cardholder.
Note: Required if BillingFullName not present
|
BillingState
|
No
|
String
|
25
|
The billing state of the cardholder.
|
BillingZipCode
|
No
|
String
|
10
|
The billing zip code of the cardholder. Used to check for AVS identification.
|
CardNumber
|
Yes
|
String
|
76
|
Identifies the cardholder’s credit card number. For swiped transaction, if track 2 data exists, then use track2. Otherwise, use track 1 data. Note: Not required if you supplied a Token
|
ClerkID
|
No
|
String
|
15
|
The cashier/clerk who initiated the transaction.
|
ClientIPAddress
|
No
|
String
|
25
|
The IP address of the client device.
|
Custominfo1 (1-20)
|
No
|
String
|
255
|
For merchant use.
|
CVV2
|
No
|
String
|
4
|
Card Verification Value. Leave this field empty if you’re doing swiped transactions or are using a Paysafe Token
|
EmailAddress
|
No
|
String
|
50
|
The e-mail address of the cardholder.
|
EncryptedDevice
|
No
|
String
|
2000
|
String identifying device.
|
ExpirationDateMMYY
|
Yes
|
String
|
4
|
Identifies the cardholder’s account expiration date (format:MMYY). Note:Leave this field empty if you are swiping transactions or are using a Paysafe Token
|
InitialTransactionID
|
No
|
String
|
30
|
Original payment gateway transaction id.
|
InitiatedBy
|
No
|
String
|
50
|
Who initiated the transaction. Values: 'customer' or 'merchant'
|
MarketSegment
|
No
|
String
|
50
|
Values: 'Ecommerce' or 'Retail' or 'Moto'
|
MerchantID
|
Yes
|
Number
|
9
|
The identification that is assigned to the merchant.
|
MerchantKey
|
Yes
|
String
|
36
|
A unique identification that is assigned to the merchant id.
|
PaymentMemo
|
No
|
String
|
50
|
Additional payment memo.
|
PhoneNumber
|
No
|
String
|
10
|
The phone number of the cardholder.
|
ReferenceNumber
|
No
|
String
|
50
|
The merchant/customer transaction identifier.
|
ScheduleIndicator
|
No
|
String
|
50
|
Values: 'Scheduled' or 'Unscheduled'
|
ShippingAddress1
|
No
|
String
|
50
|
The shipping address for the product(s) purchased in the transaction.
|
ShippingAddress2
|
No
|
String
|
50
|
Additional shipping address information for the product(s)purchased in the transaction.
|
ShippingCity
|
No
|
String
|
50
|
The shipping city for the product(s) purchased in the transaction.
|
ShippingCountry
|
No
|
String
|
50
|
The shipping country for the product(s) purchased in the transaction.
|
ShippingState
|
No
|
String
|
25
|
The shipping state for the product(s) purchased in the transaction.
|
ShippingZipCode
|
No
|
String
|
10
|
The shipping zip code for the product(s) purchased in the transaction.
|
StoredCredentialIndicator
|
No
|
String
|
50
|
The indicator of the stored credential. Values: 'stored' or 'used' Use 'stored' when processing the initial transaction in which you are storing a customer's payment details (customer credentials) in the Customer Vault or other third-party payment storage system. Use 'used' when processing a subsequent or follow-up transaction using the customer payment details (customer credentials) you have already stored to the Customer Vault or third-party payment storage method.
|
Token
|
No
|
String
|
40
|
If you have a Paysafe Token, then use it here. When using the Paysafe Token, CardNumber, ExpirationDateMMYY, and CVV2 should not be passed.
|
TransactionAmount
|
Yes
|
Number
|
9
|
Identifies the transaction’s total amount in US dollars. Enter values between 1.00-999999.99
|
TransactionType
|
Yes
|
String
|
23
|
CreditCardCaptureOnly
|
Response
Field Name | Description |
PostedDate | The date and time the transaction was posted. |
StatusID | The result of the transaction. Status 0 indicates an approved transaction. |
TransactionID | The number that identifies the transaction in the Paysafe Solutions system. |
ReferenceNumber | The merchant/customer transaction identifier that was sent in the initial request. |
TransactionAmount | Identifies the transaction amount that was sent in the initial request. |
AuthorizationCode | Authorization code from the issuing bank. |
ResponseCode | The approval or decline code from the processor. |
ResponseMessage | The approval or decline message from the processor. |
CVV2ResponseCode | The CVV2 response code. |
CVV2ResponseMessage | The CVV2 response message. |
AVSResponseCode | The AVS response code. |
AVSResponseMessage | The AVS response message. |
URLPostback | URL to redirect customer after sale has been posted |
CardNumber | Identifies the last 4 cardholder’s account number. |
CustomerName | The name of the cardholder as it appears on the card. |
BillingNameFirst | The first name of the cardholder. |
BillingNameLast | The last name of the cardholder. |
BillingAddress | The billing address of the cardholder. Used to check for AVS identification. |
BillingCity | The billing city of the cardholder. |
BillingState | The billing state of the cardholder. |
BillingZip | The billing zip code of the cardholder. Used to check for AVS identification. |
BillingCountry | The billing country of the cardholder. |
BillingPhone | The phone number of the cardholder. |
BillingFax | The fax number of the cardholder |
BillingEmail | The e-mail address of the cardholder. |
CustomerID | An existing customer record. |
ProductDesc | Use to identify product name. |
Action | The action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available. |
ShippingAddress1 | The shipping address of the cardholder. |
ShippingAddress2 | The shipping address of the cardholder. |
ShippingCity | The shipping city of the cardholder. |
ShippingState | The shipping state of the cardholder. |
ShippingZipCode | The shipping zip code of the cardholder. Used to check for AVS identification. |
ShippingCountry | The shipping country of the cardholder. |
Custominfo1 (1-20) | For merchant use. |
TransTypeID | Identifies the type of transaction that was processed. View appendix F. |
SettleDate | The date and time the transaction was settled. |
VoidDate | The date and time the transaction was voided. |
RefundDate | The date and time the transaction was refunded. |
TransactionStatusID | Identifies the status of the transaction that was processed. View appendix G. |
CreditCardCreditBlind
Description:
This method credits a credit card without the need of an originating Sales Transaction. Contact your Integration Specialist for more details.
Resource Url:
https://webservice.paymentxp.com/wh/WebHost.aspx
Method:
POST
Request
Parameter | Is Required | Data Type | Max Length | Description |
BillingAddress
|
No
|
String
|
50
|
The billing address of the cardholder. Used to check for AVS identification.
|
BillingCity
|
No
|
String
|
50
|
The billing city of the cardholder.
|
BillingCountry
|
No
|
String
|
50
|
The billing country of the cardholder.
|
BillingFullName
|
No
|
String
|
50
|
The name of the cardholder as it appears on the card.
|
BillingNameFirst
|
Yes
|
String
|
50
|
The first name of the cardholder.
Note: Required if BillingFullName not present
|
BillingNameLast
|
Yes
|
String
|
50
|
The last name of the cardholder.
Note: Required if BillingFullName not present
|
BillingState
|
No
|
String
|
25
|
The billing state of the cardholder.
|
BillingZipCode
|
No
|
String
|
10
|
The billing zip code of the cardholder. Used to check for AVS identification.
|
CardNumber
|
Yes
|
String
|
76
|
Identifies the cardholder’s credit card number. For swiped transaction, if track 2 data exists, then use track2. Otherwise, use track 1 data. Note: not required if you supplied a Token
|
ClerkID
|
No
|
String
|
15
|
The cashier/clerk who initiated the transaction.
|
ClientIPAddress
|
No
|
String
|
25
|
The IP address of the client device.
|
Custominfo1 (1-20)
|
No
|
String
|
255
|
For merchant use.
|
CVV2
|
No
|
String
|
4
|
Card Verification Value.
|
EmailAddress
|
No
|
String
|
50
|
The e-mail address of the cardholder.
|
EncryptedDevice
|
No
|
String
|
2000
|
String identifying device.
|
ExpirationDateMMYY
|
Yes
|
String
|
4
|
Identifies the cardholder’s account expiration date (format:MMYY). Note:Leave this field empty if you are swiping transactions or are using a Paysafe Token
|
MerchantID
|
Yes
|
Number
|
9
|
The identification that is assigned to the merchant.
|
MerchantKey
|
Yes
|
String
|
36
|
A unique identification that is assigned to the merchant id.
|
PaymentMemo
|
No
|
String
|
50
|
Additional payment memo.
|
PhoneNumber
|
No
|
String
|
10
|
The phone number of the cardholder.
|
ReferenceNumber
|
No
|
String
|
50
|
The merchant/customer transaction identifier.
|
ShippingAddress1
|
No
|
String
|
50
|
The shipping address for the product(s) purchased in the transaction.
|
ShippingAddress2
|
No
|
String
|
50
|
Additional shipping address information for the product(s) purchased in the transaction.
|
ShippingCity
|
No
|
String
|
50
|
The shipping city for the product(s) purchased in the transaction.
|
ShippingCountry
|
No
|
String
|
50
|
The shipping country for the product(s) purchased in the transaction.
|
ShippingState
|
No
|
String
|
25
|
The shipping state for the product(s) purchased in the transaction.
|
ShippingZipCode
|
No
|
String
|
10
|
The shipping zip code for the product(s) purchased in the transaction.
|
TransactionAmount
|
Yes
|
Number
|
9
|
Identifies the transaction’s total amount in US dollars. Enter values between 1.00-999999.99
|
TransactionType
|
Yes
|
String
|
23
|
CreditCardCreditBlind
|
Response
Field Name | Description |
PostedDate | The date and time the transaction was posted. |
StatusID | The result of the transaction. Status 0 indicates an approved transaction. |
TransactionID | The number that identifies the transaction in the Paysafe Solutions system. |
ReferenceNumber | The merchant/customer transaction identifier that was sent in the initial request. |
TransactionAmount | Identifies the transaction amount that was sent in the initial request. |
AuthorizationCode | Authorization code from the issuing bank. |
ResponseCode | The approval or decline code from the processor. |
ResponseMessage | The approval or decline message from the processor. |
CVV2ResponseCode | The CVV2 response code. |
CVV2ResponseMessage | The CVV2 response message. |
AVSResponseCode | The AVS response code. |
AVSResponseMessage | The AVS response message. |
URLPostback | URL to redirect customer after sale has been posted |
CardNumber | Identifies the last 4 cardholder’s account number. |
CustomerName | The name of the cardholder as it appears on the card. |
BillingNameFirst | The first name of the cardholder. |
BillingNameLast | The last name of the cardholder. |
BillingAddress | The billing address of the cardholder. Used to check for AVS identification. |
BillingCity | The billing city of the cardholder. |
BillingState | The billing state of the cardholder. |
BillingZip | The billing zip code of the cardholder. Used to check for AVS identification. |
BillingCountry | The billing country of the cardholder. |
BillingPhone | The phone number of the cardholder. |
BillingFax | The fax number of the cardholder |
BillingEmail | The e-mail address of the cardholder. |
CustomerID | An existing customer record. |
ProductDesc | Use to identify product name. |
Action | The action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available. |
ShippingAddress1 | The shipping address of the cardholder. |
ShippingAddress2 | The shipping address of the cardholder. |
ShippingCity | The shipping city of the cardholder. |
ShippingState | The shipping state of the cardholder. |
ShippingZipCode | The shipping zip code of the cardholder. Used to check for AVS identification. |
ShippingCountry | The shipping country of the cardholder. |
Custominfo1 (1-20) | For merchant use. |
TransTypeID | Identifies the type of transaction that was processed. View appendix F. |
SettleDate | The date and time the transaction was settled. |
VoidDate | The date and time the transaction was voided. |
RefundDate | The date and time the transaction was refunded. |
TransactionStatusID | Identifies the status of the transaction that was processed. View appendix G. |
CreditCardCloseBatch
Description:
This method can only be used when the settlement time is set to MANUAL. This method will initiate a batch closure and schedule the batch for settlement. Contact your Integration Specialist for more details.
Resource Url:
https://webservice.paymentxp.com/wh/WebHost.aspx
Method:
POST
Request
Parameter | Is Required | Data Type | Max Length | Description |
MerchantID
|
Yes
|
Number
|
9
|
The identification that is assigned to the merchant.
|
MerchantKey
|
Yes
|
String
|
36
|
A unique identification that is assigned to the merchant id.
|
TransactionType
|
Yes
|
String
|
23
|
CreditCardCloseBatch
|
Response
Field Name | Description |
PostedDate | The date and time the transaction was posted. |
StatusID | The result of the transaction. Status 0 indicates an approved transaction. |
TransactionID | The number that identifies the transaction in the Paysafe Solutions system. |
ReferenceNumber | The merchant/customer transaction identifier that was sent in the initial request. |
TransactionAmount | Identifies the transaction amount that was sent in the initial request. |
AuthorizationCode | Authorization code from the issuing bank. |
ResponseCode | The approval or decline code from the processor. |
ResponseMessage | The approval or decline message from the processor. |
CVV2ResponseCode | The CVV2 response code. |
CVV2ResponseMessage | The CVV2 response message. |
AVSResponseCode | The AVS response code. |
AVSResponseMessage | The AVS response message. |
URLPostback | URL to redirect customer after sale has been posted |
CardNumber | Identifies the last 4 cardholder’s account number. |
CustomerName | The name of the cardholder as it appears on the card. |
BillingNameFirst | The first name of the cardholder. |
BillingNameLast | The last name of the cardholder. |
BillingAddress | The billing address of the cardholder. Used to check for AVS identification. |
BillingCity | The billing city of the cardholder. |
BillingState | The billing state of the cardholder. |
BillingZip | The billing zip code of the cardholder. Used to check for AVS identification. |
BillingCountry | The billing country of the cardholder. |
BillingPhone | The phone number of the cardholder. |
BillingFax | The fax number of the cardholder |
BillingEmail | The e-mail address of the cardholder. |
CustomerID | An existing customer record. |
ProductDesc | Use to identify product name. |
Action | The action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available. |
ShippingAddress1 | The shipping address of the cardholder. |
ShippingAddress2 | The shipping address of the cardholder. |
ShippingCity | The shipping city of the cardholder. |
ShippingState | The shipping state of the cardholder. |
ShippingZipCode | The shipping zip code of the cardholder. Used to check for AVS identification. |
ShippingCountry | The shipping country of the cardholder. |
Custominfo1 (1-20) | For merchant use. |
TransTypeID | Identifies the type of transaction that was processed. View appendix F. |
SettleDate | The date and time the transaction was settled. |
VoidDate | The date and time the transaction was voided. |
RefundDate | The date and time the transaction was refunded. |
TransactionStatusID | Identifies the status of the transaction that was processed. View appendix G. |
AddCustomerCCCharge
Description:
This method creates a credit card charge transaction from a customer record.
Resource Url:
https://webservice.paymentxp.com/wh/WebHost.aspx
Method:
POST
For COF support: For Stored Credentials support five new fields ('InitiatedBy','InitialTransactionID', 'StoredCredentialIndicator' , 'ScheduleIndicator' and 'MarketSegment') have been added. All of the five fields are optional. But merchant must send all or none.
For straight Sale transaction supporting COF merchant should send 4 fields ('InitiatedBy', 'StoredCredentialIndicator' , 'ScheduleIndicator' and 'MarketSegment'). For recurring transactions supporting COF merchant must send all 5 fields.
Request
Parameter | Is Required | Data Type | Max Length | Description |
BillingMethod
|
No
|
String
|
50
|
Values: 'initial_recurring' or 'recurring'
|
ClerkID
|
No
|
String
|
15
|
The cashier/clerk who initiated the transaction.
|
ClientIPAddress
|
No
|
String
|
25
|
Identifies the client IP Address for fraud protection
|
CustomerID
|
Yes
|
String
|
50
|
An existing customer record that is used to retrieve cardholder data to be able to perform a credit card charge transaction.
|
CustomInfo1
|
No
|
String
|
255
|
For merchant use.
|
CustomInfo10
|
No
|
String
|
255
|
For merchant use.
|
CustomInfo11
|
No
|
String
|
255
|
For merchant use.
|
CustomInfo12
|
No
|
String
|
255
|
For merchant use.
|
CustomInfo13
|
No
|
String
|
255
|
For merchant use.
|
CustomInfo14
|
No
|
String
|
255
|
For merchant use.
|
CustomInfo15
|
No
|
String
|
255
|
For merchant use.
|
CustomInfo16
|
No
|
String
|
255
|
For merchant use.
|
CustomInfo17
|
No
|
String
|
255
|
For merchant use.
|
CustomInfo18
|
No
|
String
|
255
|
For merchant use.
|
CustomInfo19
|
No
|
String
|
255
|
For merchant use.
|
CustomInfo2
|
No
|
String
|
255
|
For merchant use.
|
CustomInfo20
|
No
|
String
|
255
|
For merchant use.
|
CustomInfo3
|
No
|
String
|
255
|
For merchant use.
|
CustomInfo4
|
No
|
String
|
255
|
For merchant use.
|
CustomInfo5
|
No
|
String
|
255
|
For merchant use.
|
CustomInfo6
|
No
|
String
|
255
|
For merchant use.
|
CustomInfo7
|
No
|
String
|
255
|
For merchant use.
|
CustomInfo8
|
No
|
String
|
255
|
For merchant use.
|
CustomInfo9
|
No
|
String
|
255
|
For merchant use.
|
CVV2
|
No
|
String
|
4
|
Card Verification Value (CVV). Leave this field empty for swiped transactions or when using a Paysafe Token.
|
InitialTransactionID
|
No
|
String
|
30
|
Original payment gateway transaction id.
|
InitiatedBy
|
No
|
String
|
50
|
Who initiated the transaction. Values: 'customer' or 'merchant'
|
MarketSegment
|
No
|
String
|
50
|
Values: 'Ecommerce' or 'Retail' or 'Moto'
|
MerchantID
|
Yes
|
Number
|
9
|
The identification that is assigned to the merchant.
|
MerchantKey
|
Yes
|
String
|
36
|
A unique identification that is assigned to the merchant id.
|
PaymentMemo
|
No
|
String
|
50
|
Additional payment memo.
|
PostBackURL
|
No
|
String
|
255
|
URL to redirect customer after sale has been posted
|
ReferenceNumber
|
No
|
String
|
50
|
The merchant/customer transaction identifier.
|
ScheduleIndicator
|
No
|
String
|
50
|
Values: 'Scheduled' or 'Unscheduled'
|
StoredCredentialIndicator
|
No
|
String
|
50
|
The indicator of the stored credential. Values: 'stored' or 'used' Use 'stored' when processing the initial transaction in which you are storing a customer's payment details (customer credentials) in the Customer Vault or other third-party payment storage system. Use 'used' when processing a subsequent or follow-up transaction using the customer payment details (customer credentials) you have already stored to the Customer Vault or third-party payment storage method.
|
TransactionAmount
|
Yes
|
Number
|
9
|
Identifies the transaction amount that was sent in the initial request
|
TransactionType
|
Yes
|
String
|
19
|
AddCustomerCCCharge
|
Response
Field Name | Description |
PostedDate | The date and time the transaction was posted. |
StatusID | The result of the transaction. Status 0 indicates an approved transaction. |
TransactionID | The number that identifies the transaction in the Paysafe Solutions system. |
ReferenceNumber | The merchant/customer transaction identifier that was sent in the initial request. |
TransactionAmount | Identifies the transaction amount that was sent in the initial request. |
AuthorizationCode | Authorization code from the issuing bank. |
ResponseCode | The approval or decline code from the processor. |
ResponseMessage | The approval or decline message from the processor. |
CVV2ResponseCode | The CVV2 response code. |
CVV2ResponseMessage | The CVV2 response message. |
AVSResponseCode | The AVS response code. |
AVSResponseMessage | The AVS response message. |
URLPostback | URL to redirect customer after sale has been posted |
CardNumber | Identifies the last 4 cardholder’s account number. |
CustomerName | The name of the cardholder as it appears on the card. |
BillingNameFirst | The first name of the cardholder. |
BillingNameLast | The last name of the cardholder. |
BillingAddress | The billing address of the cardholder. Used to check for AVS identification. |
BillingCity | The billing city of the cardholder. |
BillingState | The billing state of the cardholder. |
BillingZip | The billing zip code of the cardholder. Used to check for AVS identification. |
BillingCountry | The billing country of the cardholder. |
BillingPhone | The phone number of the cardholder. |
BillingFax | The fax number of the cardholder |
BillingEmail | The e-mail address of the cardholder. |
CustomerID | An existing customer record. |
ProductDesc | Use to identify product name. |
Action | The action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available. |
ShippingAddress1 | The shipping address of the cardholder. |
ShippingAddress2 | The shipping address of the cardholder. |
ShippingCity | The shipping city of the cardholder. |
ShippingState | The shipping state of the cardholder. |
ShippingZipCode | The shipping zip code of the cardholder. Used to check for AVS identification. |
ShippingCountry | The shipping country of the cardholder. |
Custominfo1 (1-20) | For merchant use. |
TransTypeID | Identifies the type of transaction that was processed. View appendix F. |
SettleDate | The date and time the transaction was settled. |
VoidDate | The date and time the transaction was voided. |
RefundDate | The date and time the transaction was refunded. |
TransactionStatusID | Identifies the status of the transaction that was processed. View appendix G. |
CreditCardHosted
Description:
Use this method to let Paysafe perform collection of sensitive credit card information on our secure servers.
Resource Url:
https://webservice.paymentxp.com/wh/EnterPayment.aspx
Method:
POST
Request
Parameter | Is Required | Data Type | Max Length | Description |
BillingAddress
|
No
|
String
|
50
|
The billing address of the cardholder. Used to check for AVS identification.
|
BillingCity
|
No
|
String
|
50
|
The billing city of the cardholder.
|
BillingCountry
|
No
|
String
|
50
|
The billing country of the cardholder.
|
BillingFullName
|
No
|
String
|
50
|
The name of the cardholder as it appears on the card.
|
BillingNameFirst
|
Yes
|
String
|
50
|
The first name of the cardholder.
Note: Required if BillingFullName not present
|
BillingNameLast
|
Yes
|
String
|
50
|
The last name of the cardholder.
Note: Required if BillingFullName not present
|
BillingState
|
No
|
String
|
25
|
The billing state of the cardholder.
|
BillingZipCode
|
No
|
String
|
10
|
The billing zip code of the cardholder. Used to check for AVS identification.
|
ClerkID
|
No
|
String
|
15
|
The cashier/clerk who initiated the transaction.
|
ClientIPAddress
|
No
|
String
|
25
|
The IP address of the client device.
|
CustomerID
|
No
|
String
|
255
|
Use existing customer record to populate billing information.
|
Custominfo1 (1-20)
|
No
|
String
|
255
|
For merchant use.
|
EmailAddress
|
No
|
String
|
50
|
The e-mail address of the cardholder.
|
EnableSwiper
|
No
|
String
|
1
|
Set to 1 to enable card swipe capabilities. Set to 0 otherwise. Defaults to 0.
|
MerchantID
|
Yes
|
Number
|
9
|
The identification that is assigned to the merchant.
|
MerchantKey
|
Yes
|
String
|
100
|
A unique identification that is assigned to the merchant id. Note: For merchants using Hosted Payment functionality, pass the ‘Hosted Payment Key’ token provided by Paysafe for each merchant into the MerchantKey data field.
|
PaymentMemo
|
No
|
String
|
50
|
Additional payment memo.
|
PhoneNumber
|
No
|
String
|
10
|
The phone number of the cardholder.
|
PostBackURL
|
No
|
String
|
255
|
URL to redirect customer after sale has been posted. If left blank, customer will be redirected to our default results page.
|
ProductDescription
|
No
|
String
|
255
|
Use to identify product name.
|
ReferenceNumber
|
No
|
String
|
50
|
The merchant/customer transaction identifier.
|
ReturnURL
|
No
|
String
|
255
|
URL provider as a link on the results page to send customerback to merchant website.
|
ShippingAddress1
|
No
|
String
|
50
|
The shipping address for the product(s) purchased in the transaction.
|
ShippingAddress2
|
No
|
String
|
50
|
Additional shipping address information for the product(s)purchased in the transaction.
|
ShippingCity
|
No
|
String
|
50
|
The shipping city for the product(s) purchased in the transaction.
|
ShippingCountry
|
No
|
String
|
50
|
The shipping country for the product(s) purchased in the transaction.
|
ShippingState
|
No
|
String
|
25
|
The shipping state for the product(s) purchased in the transaction.
|
ShippingZipCode
|
No
|
String
|
10
|
The shipping zip code for the product(s) purchased in the transaction.
|
SilentPostBackURL
|
No
|
String
|
255
|
Status post back URL via HTTP POST.
|
Token
|
No
|
String
|
40
|
Paysafe Token. If you supply a token, you don’t need to supply the MerchantKey, and TransactionAmount
|
TransactionAmount
|
Yes
|
Number
|
9
|
Identifies the transaction’s total amount in US dollars. Note: Not required if you’re using a Paysafe Token
|
TransactionType
|
Yes
|
String
|
16
|
CreditCardHosted, CreditCardCharge: Performs a Charge CreditCardAuthorization: Performs an Authorization
|
Response
Field Name | Description |
PostedDate | The date and time the transaction was posted. |
StatusID | The result of the transaction. Status 0 indicates an approved transaction. |
TransactionID | The number that identifies the transaction in the Paysafe Solutions system. |
ReferenceNumber | The merchant/customer transaction identifier that was sent in the initial request. |
TransactionAmount | Identifies the transaction amount that was sent in the initial request. |
AuthorizationCode | Authorization code from the issuing bank. |
ResponseCode | The approval or decline code from the processor. |
ResponseMessage | The approval or decline message from the processor. |
CVV2ResponseCode | The CVV2 response code. |
CVV2ResponseMessage | The CVV2 response message. |
AVSResponseCode | The AVS response code. |
AVSResponseMessage | The AVS response message. |
URLPostback | URL to redirect customer after sale has been posted |
CardNumber | Identifies the last 4 cardholder’s account number. |
CustomerName | The name of the cardholder as it appears on the card. |
BillingNameFirst | The first name of the cardholder. |
BillingNameLast | The last name of the cardholder. |
BillingAddress | The billing address of the cardholder. Used to check for AVS identification. |
BillingCity | The billing city of the cardholder. |
BillingState | The billing state of the cardholder. |
BillingZip | The billing zip code of the cardholder. Used to check for AVS identification. |
BillingCountry | The billing country of the cardholder. |
BillingPhone | The phone number of the cardholder. |
BillingFax | The fax number of the cardholder |
BillingEmail | The e-mail address of the cardholder. |
CustomerID | An existing customer record. |
ProductDesc | Use to identify product name. |
Action | The action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available. |
ShippingAddress1 | The shipping address of the cardholder. |
ShippingAddress2 | The shipping address of the cardholder. |
ShippingCity | The shipping city of the cardholder. |
ShippingState | The shipping state of the cardholder. |
ShippingZipCode | The shipping zip code of the cardholder. Used to check for AVS identification. |
ShippingCountry | The shipping country of the cardholder. |
Custominfo1 (1-20) | For merchant use. |
TransTypeID | Identifies the type of transaction that was processed. View appendix F. |
SettleDate | The date and time the transaction was settled. |
VoidDate | The date and time the transaction was voided. |
RefundDate | The date and time the transaction was refunded. |
TransactionStatusID | Identifies the status of the transaction that was processed. View appendix G. |
CreditCardReBill
Description:
Use this method to re-process a historical transaction.
Resource Url:
https://webservice.paymentxp.com/wh/WebHost.aspx
Method:
POST
For COF support: For Stored Credentials support five new fields ('InitiatedBy','InitialTransactionID', 'StoredCredentialIndicator' , 'ScheduleIndicator' and 'MarketSegment') have been added. All of the five fields are optional. But merchant must send all or none.
For straight Sale transaction supporting COF merchant should send 4 fields ('InitiatedBy', 'StoredCredentialIndicator' , 'ScheduleIndicator' and 'MarketSegment'). For recurring transactions supporting COF merchant must send all 5 fields.
Request
Parameter | Is Required | Data Type | Max Length | Description |
BillingMethod
|
No
|
String
|
50
|
Values: 'initial_recurring' or 'recurring'
|
ClerkID
|
No
|
String
|
15
|
The cashier/clerk who initiated the transaction.
|
Custominfo1 (1-20)
|
No
|
String
|
255
|
For merchant use.
|
InitialTransactionID
|
No
|
String
|
30
|
Original payment gateway transaction id.
|
InitiatedBy
|
No
|
String
|
50
|
Who initiated the transaction. Values: 'customer' or 'merchant'
|
MarketSegment
|
No
|
String
|
50
|
Values: 'Ecommerce' or 'Retail' or 'Moto'
|
MerchantID
|
Yes
|
Number
|
9
|
The identification that is assigned to the merchant.
|
MerchantKey
|
Yes
|
String
|
36
|
A unique identification that is assigned to the merchant id.
|
PaymentMemo
|
No
|
String
|
50
|
Additional payment memo.
|
PostBackURL
|
No
|
String
|
255
|
URL to redirect customer after sale has been posted
|
ReferenceNumber
|
No
|
String
|
50
|
The merchant/customer transaction identifier.
|
ScheduleIndicator
|
No
|
String
|
50
|
Values: 'Scheduled' or 'Unscheduled'
|
StoredCredentialIndicator
|
No
|
String
|
50
|
The indicator of the stored credential. Values: 'stored' or 'used' Use 'stored' when processing the initial transaction in which you are storing a customer's payment details (customer credentials) in the Customer Vault or other third-party payment storage system. Use 'used' when processing a subsequent or follow-up transaction using the customer payment details (customer credentials) you have already stored to the Customer Vault or third-party payment storage method.
|
TransactionAmount
|
Yes
|
Number
|
9
|
Identifies the transaction’s total amount in US dollars.
|
TransactionID
|
Yes
|
Number
|
9
|
Transaction ID you want to re-process
|
TransactionType
|
Yes
|
String
|
16
|
CreditCardReBill
|
Response
Field Name | Description |
PostedDate | The date and time the transaction was posted. |
StatusID | The result of the transaction. Status 0 indicates an approved transaction. |
TransactionID | The number that identifies the transaction in the Paysafe Solutions system. |
ReferenceNumber | The merchant/customer transaction identifier that was sent in the initial request. |
TransactionAmount | Identifies the transaction amount that was sent in the initial request. |
AuthorizationCode | Authorization code from the issuing bank. |
ResponseCode | The approval or decline code from the processor. |
ResponseMessage | The approval or decline message from the processor. |
CVV2ResponseCode | The CVV2 response code. |
CVV2ResponseMessage | The CVV2 response message. |
AVSResponseCode | The AVS response code. |
AVSResponseMessage | The AVS response message. |
URLPostback | URL to redirect customer after sale has been posted |
CardNumber | Identifies the last 4 cardholder’s account number. |
CustomerName | The name of the cardholder as it appears on the card. |
BillingNameFirst | The first name of the cardholder. |
BillingNameLast | The last name of the cardholder. |
BillingAddress | The billing address of the cardholder. Used to check for AVS identification. |
BillingCity | The billing city of the cardholder. |
BillingState | The billing state of the cardholder. |
BillingZip | The billing zip code of the cardholder. Used to check for AVS identification. |
BillingCountry | The billing country of the cardholder. |
BillingPhone | The phone number of the cardholder. |
BillingFax | The fax number of the cardholder |
BillingEmail | The e-mail address of the cardholder. |
CustomerID | An existing customer record. |
ProductDesc | Use to identify product name. |
Action | The action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available. |
ShippingAddress1 | The shipping address of the cardholder. |
ShippingAddress2 | The shipping address of the cardholder. |
ShippingCity | The shipping city of the cardholder. |
ShippingState | The shipping state of the cardholder. |
ShippingZipCode | The shipping zip code of the cardholder. Used to check for AVS identification. |
ShippingCountry | The shipping country of the cardholder. |
Custominfo1 (1-20) | For merchant use. |
TransTypeID | Identifies the type of transaction that was processed. View appendix F. |
SettleDate | The date and time the transaction was settled. |
VoidDate | The date and time the transaction was voided. |
RefundDate | The date and time the transaction was refunded. |
TransactionStatusID | Identifies the status of the transaction that was processed. View appendix G. |
CreditCardRecurringCharge
Description:
This method schedules a credit card charge via a recurring payment. In most cases, CreditCardRebill() Method is preferred.
Resource Url:
https://webservice.paymentxp.com/wh/WebHost.aspx
Method:
POST
Request
Parameter | Is Required | Data Type | Max Length | Description |
BillingAddress
|
No
|
String
|
50
|
The billing address of the cardholder. Used to check for AVS identification.
|
BillingCity
|
No
|
String
|
50
|
The billing city of the cardholder.
|
BillingCountry
|
No
|
String
|
50
|
The billing country of the cardholder.
|
BillingMethod
|
No
|
String
|
50
|
Values: 'initial_recurring' or 'recurring'
|
BillingNameFirst
|
Yes
|
String
|
50
|
The first name of the cardholder.
Note: Required if BillingFullName not present
|
BillingNameLast
|
Yes
|
String
|
50
|
The last name of the cardholder.
Note: Required if BillingFullName not present
|
BillingState
|
No
|
String
|
25
|
The billing state of the cardholder.
|
BillingZipCode
|
No
|
String
|
10
|
The billing zip code of the cardholder. Used to check for AVS identification.
|
CardNumber
|
Yes
|
String
|
76
|
Identifies the cardholder’s credit card number. For swiped transaction, if track 2 data exists, then use track2. Otherwise, use track 1 data. Not required if using a Paysafe Token
|
ClerkID
|
No
|
String
|
15
|
The cashier/clerk who initiated the transaction.
|
CustomInfo1
|
No
|
String
|
255
|
For merchant use.
|
CustomInfo2
|
No
|
String
|
255
|
For merchant use.
|
CustomInfo3
|
No
|
String
|
255
|
For merchant use.
|
DayOfMonthOption
|
Yes
|
Number
|
1
|
0=None, 1, 2, 3, 4, 5, 6,7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31
|
EmailAddress
|
No
|
String
|
50
|
The e-mail address of the cardholder.
|
EndDate
|
No
|
Number
|
8
|
End date for recurring payment. Format MMddyyyy. Leaveblank if there is no end date.
|
ExpirationDateMMYY
|
Yes
|
String
|
4
|
Identifies the cardholder’s account expiration date (format:MMYY). Note:Leave this field empty if you are swiping transactions or are using a Paysafe Token
|
FaxNumber
|
No
|
String
|
10
|
The fax number of the cardholder.
|
MerchantID
|
Yes
|
Number
|
9
|
The identification that is assigned to the merchant.
|
MerchantKey
|
Yes
|
String
|
36
|
A unique identification that is assigned to the merchant id.
|
MonthlyOption
|
Yes
|
Number
|
1
|
0=None, 1= Set day of month option (MonthOfYearOption and DayOfMonthOption are required), 2= Set the advanced option per month (WeekOption, WeekdayOption, and MonthofYearOption are required)
|
MonthOfYearOption
|
No
|
Number
|
1
|
0=None, 1=One, 2=Two, 3=Three, 4=Four, 5=Five, 6=Six, 7=Seven, 8=Eight, 9=Nine, 10=Ten, 11=Eleven, 12=Twelve Only applicable when MonthlyOption=2
|
OccurenceOption
|
Yes
|
Number
|
1
|
1=Daily, 2=Monthly
|
PaymentMemo
|
No
|
String
|
50
|
Additional payment memo.
|
PhoneNumber
|
No
|
String
|
10
|
The phone number of the cardholder.
|
ReferenceNumber
|
No
|
String
|
50
|
The merchant/customer transaction identifier.
|
ShippingAddress
|
No
|
String
|
50
|
The shipping address for the product(s) purchased in the transaction.
|
ShippingCity
|
No
|
String
|
50
|
The shipping city for the product(s) purchased in the transaction.
|
ShippingCountry
|
No
|
String
|
50
|
The shipping country for the product(s) purchased in the transaction.
|
ShippingNameFirst
|
No
|
String
|
50
|
The first name of the recipient.
|
ShippingNameLast
|
No
|
String
|
50
|
The last name of the recipient.
|
ShippingState
|
No
|
String
|
25
|
The shipping state for the product(s) purchased in the transaction.
|
ShippingZipCode
|
No
|
String
|
10
|
The shipping zip code for the product(s) purchased in the transaction.
|
StartDate
|
Yes
|
Number
|
8
|
Start date for recurring payment. Format MMddyyyy.
|
Token
|
No
|
String
|
36
|
Paysafe Token
|
TransactionAmount
|
Yes
|
Number
|
9
|
Identifies the transaction’s total amount in US dollars.
|
TransactionType
|
Yes
|
String
|
25
|
CreditCardRecurringCharge
|
WeekdayOption
|
No
|
Number
|
1
|
0=None, 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday, 6=Saturday, 7=Sunday Only applicable when MonthlyOption=2
|
WeekOption
|
No
|
Number
|
1
|
0=None, 1=First, 2=Second, 3=Third, 4=Fourth, 5=Last week of the month. Only applicable when MonthlyOption=2
|
Response
Field Name | Description |
PostedDate | The date and time the transaction was posted. |
StatusID | The result of the transaction. Status 0 indicates an approved transaction. |
RecurID | The number that identifies the transaction in the Paysafe Solutions system. |
ReferenceNumber | The merchant/customer transaction identifier that was sent in the initial request. |
TransactionAmount | Identifies the transaction amount that was sent in the initial request. |
ScheduleDescription | A text description of the recurring payment schedule. |
ScheduleDate | The date the recurring payment charge will be processed. |
ResponseMessage | The approval or decline message from the processor. |
CreditCardRecurringUpdate
Description:
This method updates an existing recurring rule in the database.
Resource Url:
https://webservice.paymentxp.com/wh/WebHost.aspx
Method:
POST
Request
Parameter | Is Required | Data Type | Max Length | Description |
BillingAddress
|
No
|
String
|
50
|
The billing address of the cardholder. Used to check for AVS identification.
|
BillingCity
|
No
|
String
|
50
|
The billing city of the cardholder.
|
BillingCountry
|
No
|
String
|
50
|
The billing country of the cardholder.
|
BillingNameFirst
|
No
|
String
|
50
|
The first name of the cardholder.
|
BillingNameLast
|
No
|
String
|
50
|
The last name of the cardholder.
|
BillingState
|
No
|
String
|
25
|
The billing state of the cardholder.
|
BillingZipCode
|
No
|
String
|
10
|
The billing zip code of the cardholder. Used to check for AVS identification.
|
CardNumber
|
No
|
String
|
76
|
Identifies the cardholder’s credit card number.
|
ClerkID
|
No
|
String
|
15
|
The cashier/clerk who initiated the transaction.
|
ClientIPAddress
|
No
|
String
|
50
|
|
CustomInfo1 (1-20)
|
No
|
String
|
255
|
For merchant use.
|
DayOfMonthOption
|
No
|
Number
|
1
|
0=None, 1, 2, 3, 4, 5, 6,7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31
|
EmailAddress
|
No
|
String
|
50
|
The e-mail address of the cardholder.
|
EndDate
|
No
|
Number
|
8
|
End date for recurring payment. Format MMddyyyy. Leave blank if there is no end date.
|
ExpirationDateMMYY
|
No
|
String
|
4
|
Identifies the cardholder’s account expiration date (format: MMYY).
|
FaxNumber
|
No
|
String
|
10
|
The fax number of the cardholder.
|
IsEnabled
|
No
|
Boolean
|
1
|
0=Disabled, 1=Enable
|
MerchantID
|
Yes
|
Number
|
9
|
The identification that is assigned to the merchant.
|
MerchantKey
|
Yes
|
String
|
36
|
A unique identification that is assigned to the merchant id.
|
MonthlyOption
|
No
|
Number
|
1
|
0=None, 1= Set day of month option (MonthOfYearOption and DayOfMonthOption are required), 2= Set the advanced option per month (WeekOption, WeekdayOption, and MonthofYearOption are required)
|
MonthOfYearOption
|
No
|
Number
|
1
|
0=None, 1=One, 2=Two, 3=Three, 4=Four, 5=Five, 6=Six, 7=Seven, 8=Eight, 9=Nine, 10=Ten, 11=Eleven, 12=Twelve Only applicable when MonthlyOption=2
|
OccurenceOption
|
No
|
Number
|
1
|
1=Daily, 2=Monthly
|
PaymentMemo
|
No
|
String
|
50
|
Additional payment memo.
|
PhoneNumber
|
No
|
String
|
10
|
The phone number of the cardholder.
|
RecurID
|
Yes
|
Number
|
10
|
The Rule ID assigned to the original rule.
|
ReferenceNumber
|
No
|
String
|
50
|
The merchant/customer transaction identifier.
|
ShippingAddress
|
No
|
String
|
50
|
The shipping address for the product(s) purchased in the transaction.
|
ShippingCity
|
No
|
String
|
50
|
The shipping city for the product(s) purchased in the transaction.
|
ShippingCountry
|
No
|
String
|
50
|
The shipping country for the product(s) purchased in the transaction.
|
ShippingNameFirst
|
No
|
String
|
50
|
The first name of the recipient.
|
ShippingNameLast
|
No
|
String
|
50
|
The last name of the recipient.
|
ShippingState
|
No
|
String
|
25
|
The shipping state for the product(s) purchased in the transaction.
|
ShippingZipCode
|
No
|
String
|
10
|
The shipping zip code for the product(s) purchased in the transaction.
|
StartDate
|
No
|
Number
|
8
|
Start date for recurring payment. Format MMddyyyy.
|
Token
|
No
|
String
|
36
|
Paysafe Token
|
TransactionAmount
|
No
|
Number
|
9
|
Identifies the transaction’s total amount in US dollars.
|
TransactionType
|
Yes
|
String
|
25
|
CreditCardRecurringUpdate
|
WeekdayOption
|
No
|
Number
|
1
|
0=None, 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday, 6=Saturday, 7=Sunday. Only applicable when MonthlyOption=2
|
WeekOption
|
No
|
Number
|
1
|
0=None, 1=First, 2=Second, 3=Third, 4=Fourth, 5=Last week of the month.Only applicable when MonthlyOption=2
|
Response
Field Name | Description |
PostedDate | The date and time the transaction was posted. |
StatusID | The result of the transaction. Status 0 indicates an approved transaction. |
RecurID | The number that identifies the transaction in the Paysafe Solutions system. |
ReferenceNumber | The merchant/customer transaction identifier sent in the initial request. |
TransactionAmount | Identifies the transaction amount sent in the initial request. |
ScheduleDescription | A text description of the recurring payment schedule. |
ScheduleDate | The date the recurring payment charge will be processed. |
ResponseMessage | The approval or decline message from the processor. |
GetCreditCardTransaction
Description:
This method retrieves a credit card transaction record from the database.
Resource Url:
https://webservice.paymentxp.com/wh/WebHost.aspx
Method:
POST
Request
Parameter | Is Required | Data Type | Max Length | Description |
MerchantID
|
Yes
|
Number
|
9
|
The identification that is assigned to the merchant.
|
MerchantKey
|
Yes
|
String
|
36
|
A unique identification that is assigned to the merchant id.
|
TransactionID
|
Yes
|
Number
|
19
|
The TransactionID value returned by CreditCardAuthorization() or CreditCardCharge()or CreditCardRebill() or CreditCardCredit() transaction.
|
TransactionType
|
Yes
|
String
|
14
|
GetCreditCardTransaction
|
Response
Field Name | Description |
PostedDate | The date and time the transaction was posted. |
StatusID | The result of the transaction. Status 0 indicates an approved transaction. |
TransactionID | The number that identifies the transaction in the Paysafe Solutions system. |
ReferenceNumber | The merchant/customer transaction identifier that was sent in the initial request. |
TransactionAmount | Identifies the transaction amount that was sent in the initial request. |
AuthorizationCode | Authorization code from the issuing bank. |
ResponseCode | The approval or decline code from the processor. |
ResponseMessage | The approval or decline message from the processor. |
CVV2ResponseCode | The CVV2 response code. |
CVV2ResponseMessage | The CVV2 response message. |
AVSResponseCode | The AVS response code. |
AVSResponseMessage | The AVS response message. |
URLPostback | URL to redirect customer after sale has been posted |
CardNumber | Identifies the last 4 cardholder’s account number. |
CustomerName | The name of the cardholder as it appears on the card. |
BillingNameFirst | The first name of the cardholder. |
BillingNameLast | The last name of the cardholder. |
BillingAddress | The billing address of the cardholder. Used to check for AVS identification. |
BillingCity | The billing city of the cardholder. |
BillingState | The billing state of the cardholder. |
BillingZip | The billing zip code of the cardholder. Used to check for AVS identification. |
BillingCountry | The billing country of the cardholder. |
BillingPhone | The phone number of the cardholder. |
BillingFax | The fax number of the cardholder |
BillingEmail | The e-mail address of the cardholder. |
CustomerID | An existing customer record. |
ProductDesc | Use to identify product name. |
Action | The action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available. |
ShippingAddress1 | The shipping address of the cardholder. |
ShippingAddress2 | The shipping address of the cardholder. |
ShippingCity | The shipping city of the cardholder. |
ShippingState | The shipping state of the cardholder. |
ShippingZipCode | The shipping zip code of the cardholder. Used to check for AVS identification. |
ShippingCountry | The shipping country of the cardholder. |
Custominfo1 (1-20) | For merchant use. |
TransTypeID | Identifies the type of transaction that was processed. View appendix F. |
SettleDate | The date and time the transaction was settled. |
VoidDate | The date and time the transaction was voided. |
RefundDate | The date and time the transaction was refunded. |
TransactionStatusID | Identifies the status of the transaction that was processed. View appendix G. |
Credit Card Batch File Upload
To use this interface option, all transaction data must be correctly formatted and saved in a batch file. Batch files can be formatted as comma-delimited. Our program polls the FTP directories every fifteen minutes to look for files that have been uploaded for processing.
FTP
Upon request, we will issue you a test account for development and testing. Once you’ve been certified, a production account will be created for you. The certification process includes the following steps:
- Create a test batch file
- Send the test file to Paysafe' FTP server
- Notify Paysafe' Integration Department that the file has been uploaded
- Our developer will validate the batch file by running it against a test database
- If the file contains errors, the developer will notify you; otherwise, you will receive production account via email.
All files sent to us via SFTP shall be encrypted using PGP. Please contact us to obtain a free version of the PGP software and our public PGP key.
Batch File
Credit Card File Specification (Comma-Delimited)
The following guidelines shall be used for formatting transaction data sent in a comma-delimited batch file.
Parameter |
Type |
Length |
Description |
*Description |
Text |
50 |
Purpose of transaction. |
*Trans Code |
Text |
2 |
312 = Credit Card Charge, 314 = Credit Card Refund |
*CardNumber |
Text |
76 |
Identifies the cardholder’s account number. Not required for a refund transaction. |
*ExpirationDateMMYY |
Text |
4 |
Identifies the cardholder’s account expiration date (format: MMYY). |
*TransactionAmount |
Numeric |
9 |
Identifies the transaction’s total amount in US dollars. |
BillingNameFirst |
Text |
50 |
The first name of the cardholder. |
BillingNameLast |
Text |
50 |
The last name of the cardholder. |
BillingAddress |
Text |
50 |
The billing address of the cardholder. Used to check for AVS identification. |
BillingCity |
Text |
50 |
The billing city of the cardholder. |
BillingState |
Text |
25 |
The billing state of the cardholder. |
BillingZipCode |
Text |
10 |
The billing zip code of the cardholder. Used to check for AVS identification. |
BillingCountry |
Text |
50 |
The billing country of the cardholder. |
EmailAddress |
Text |
50 |
The e-mail address of the cardholder. |
PhoneNumber |
Text |
10 |
The phone number of the cardholder. |
ClerkID |
Text |
15 |
The cashier/clerk who initiated the transaction. |
ReferenceNumber |
Text |
50 |
The merchant/customer transaction identifier. |
OrigTransID |
Numeric |
19 |
This is the TransactionID value for the original transaction. (Use for refunds). |
ShippingAddress1 |
Text |
50 |
The shipping address for the product(s) purchased in the transaction. |
ShippingAddress2 |
Text |
50 |
The shipping address for the product(s) purchased in the transaction. |
ShippingCity |
Text |
50 |
The shipping city for the product(s) purchased in the transaction. |
ShippingState |
Text |
25 |
The shipping state for the product(s) purchased in the transaction. |
ShippingZipCode |
Text |
10 |
The shipping zip code for the product(s) purchased in the transaction. |
ShippingCountry |
Text |
50 |
The shipping country for the product(s) purchased in the transaction. |
ClientIPAddress |
Text |
25 |
The IP address of the client device. |
CustomInfo1 |
Text |
255 |
For merchant use. |
CustomInfo2 |
Text |
255 |
For merchant use. |
CustomInfo3 |
Text |
255 |
For merchant use. |
CustomInfo4 |
Text |
255 |
For merchant use. |
CustomInfo5 |
Text |
255 |
For merchant use. |
CustomInfo6 |
Text |
255 |
For merchant use. |
CustomInfo7 |
Text |
255 |
For merchant use. |
CustomInfo8 |
Text |
255 |
For merchant use. |
CustomInfo9 |
Text |
255 |
For merchant use. |
CustomInfo10 |
Text |
255 |
For merchant use. |
CustomInfo11 |
Text |
255 |
For merchant use. |
CustomInfo12 |
Text |
255 |
For merchant use. |
CustomInfo13 |
Text |
255 |
For merchant use. |
CustomInfo14 |
Text |
255 |
For merchant use. |
CustomInfo15 |
Text |
255 |
For merchant use. |
CustomInfo16 |
Text |
255 |
For merchant use. |
CustomInfo17 |
Text |
255 |
For merchant use. |
CustomInfo18 |
Text |
255 |
For merchant use. |
CustomInfo19 |
Text |
255 |
For merchant use. |
CustomInfo20 |
Text |
255 |
For merchant use. |
Note: Transaction data included in the batch file must be in comma-delimited format with quoted text
File Naming Convention - The batch file should be saved with an .ccb file extension using the following naming convention.
File Name |
Description |
YYMMDDNN.CCB |
YY = Year, MM = Month, DD = Day & NN = Batch No
Example: 04111401.ccb Year=2004, Month=11, Day=14 & Batch Number=01
|
Note: The batch number is required. This is used to differentiate between batch files when a merchant sends more than one batch on the same day. If only one batch file is sent for a particular date, the batch
number will always be entered as 01.
Response File Format
Response files are generated once a day, typically from 11:30 to 3 PM PST. Response file format is the same for both comma-delimited and NACHA batch file format.
Parameter |
Type |
Length |
Description |
RefID |
Text |
50 |
Merchant’s unique reference number |
Amount |
Numeric |
8 |
Amount of sale |
TransID |
Numeric |
10 |
Unique Key assigned by Paysafe |
Authcode |
Text |
6 |
Authorization Code |
Status |
Text |
25 |
Status is APPROVED or DECLINED |
Reason |
Text |
100 |
Reject reason |
File Naming Convention - The response file will have an .rsp file extension using the following naming convention.
File Name |
Description |
YYMMDDNN.RSP |
YY = Year, MM = Month, DD = Day & NN = Batch No
Example: 10111401.rsp Year=2010, Month=11, Day=14 & Batch Number=01
|
ACH Integration Methods
This section describes integration requirements for invoking the HTTPS Post interface with an XML response. Transactions processed using this interface require the user to collect ACH information and sending the transaction data securely (via HTTPS) to our ACH gateway for processing. Through this interface, you can process ACH debits or credits. To use this interface please contact Paysafe for a MerchantID and MerchantKey.
ACHDebit
Description:
Use these functions to create new ACH transactions. Below are the parameters for this method.
Resource Url:
https://webservice.paymentxp.com/wh/WebHost.aspx
Method:
POST
Request
Parameter | Is Required | Data Type | Max Length | Description |
AccountName
|
Yes
|
String
|
23
|
Name on account (Checking or Savings)
|
AccountNumber
|
Yes
|
String
|
17
|
Account Number or DDA
|
ACHCheckType
|
Yes
|
Number
|
1
|
Enter 1 or 2. Note: Value must be an integer 1 = Business to consumer transaction 2 = Business to business transaction
|
Amount
|
Yes
|
Number
|
8
|
Amount of sale
|
BankAccountType
|
Yes
|
Number
|
1
|
Enter 1 or 2. Note: 1 = Checking account 2 = Savings account
|
BillingAddress
|
No
|
String
|
50
|
The billing address of the cardholder. Used to check for AVS identification.
|
BillingCity
|
No
|
String
|
50
|
The billing city of the cardholder.
|
BillingCountry
|
No
|
String
|
50
|
The billing country of the cardholder.
|
BillingFullName
|
No
|
String
|
50
|
The name of the cardholder as it appears on the card.
|
BillingNameFirst
|
No
|
String
|
50
|
The first name of the cardholder.
|
BillingNameLast
|
No
|
String
|
50
|
The last name of the cardholder.
|
BillingState
|
No
|
String
|
25
|
The billing state of the cardholder.
|
BillingZipCode
|
No
|
String
|
10
|
The billing zip code of the cardholder. Used to check for AVS identification
|
CheckNumber
|
Yes
|
String
|
25
|
Pass an empty string if check number does not exist. Note: Required only for RCK transaction type.
|
ClerkID
|
No
|
String
|
15
|
The cashier/clerk who initiated the transaction.
|
ClientIPAddress
|
No
|
String
|
25
|
The IP address of the client device.
|
CustomerID
|
No
|
String
|
50
|
An existing customer record that is used to retrieve cardholder data to be able to perform an ACH Debit transaction.
|
Custominfo1 (1-20)
|
No
|
String
|
255
|
For merchant use.
|
Description
|
Yes
|
String
|
10
|
Purpose of transaction. Description is required for ACH. This field shows up on customer’s bank statement.
|
EmailAddress
|
No
|
String
|
50
|
The e-mail address of the cardholder.
|
MerchantID
|
Yes
|
String
|
10
|
Unique ID assigned by Paysafe
|
MerchantKey
|
Yes
|
String
|
36
|
Unique Key assigned by Paysafe
|
PhoneNumber
|
No
|
Number
|
10
|
The phone number of the cardholder.
|
ProcessDate
|
Yes
|
String
|
8
|
Date to process the transaction Format: MMddyyyy
|
ReferenceNumber
|
No
|
String
|
50
|
Merchant’s unique reference number
|
RoutingNumber
|
Yes
|
String
|
9
|
Routing number or ABA
|
ShippingAddress1
|
No
|
String
|
50
|
The shipping address for the product(s) purchased in the transaction.
|
ShippingAddress2
|
No
|
String
|
50
|
The shipping address for the product(s) purchased in the transaction.
|
ShippingCity
|
No
|
String
|
50
|
The shipping city for the product(s) purchased in the transaction.
|
ShippingCountry
|
No
|
String
|
50
|
The shipping country for the product(s) purchased in the transaction.
|
ShippingState
|
No
|
String
|
25
|
The shipping state for the product(s) purchased in the transaction.
|
ShippingZipCode
|
No
|
String
|
10
|
The shipping zip code for the product(s) purchased in thetransaction.
|
TransactionType
|
Yes
|
String
|
19
|
ACHDebit
|
Response
Field Name | Description |
PostedDate | The date and time the transaction was posted. |
StatusID | The result of the transaction. Status 1 indicates an approved transaction. |
TransactionID | The number that identifies the transaction in the Paysafe Solutions system. |
ReferenceNumber | The merchant/customer transaction identifier that was sent in the initial request. |
TransactionAmount | Identifies the transaction amount that was sent in the initial request. |
Message | The message from the processor. |
Status | Status Description |
CustomerName | The name of the account holder as it appears on the account |
BillingNameFirst | The first name of the account holder. |
BillingNameLast | The last name of the account holder. |
BillingAddress | The billing address of the cardholder. Used to check for AVS identification. |
BillingCity | The billing city of the account holder. |
BillingState | The billing state of the account holder. |
BillingZip | The billing zip code of the account holder. Used to check for AVS identification. |
BillingCountry | The billing country of the account holder. |
BillingPhone | The phone number of the account holder. |
BillingFax | The fax number of the account holder |
BillingEmail | An existing customer record |
CustomerID | An existing customer record. |
RoutingNumber | Routing number or ABA |
AccountNumber | Account Number or DDA |
Action | The action that can be taken on this transaction. V=Void,S=Settle, C=Credit. A blank response means no action is available. |
TransTypeID | Identifies the type of transaction that was processed. View appendix F. |
VoidDate | The date and time the transaction was voided. |
TransactionStatusID | Identifies the status of the transaction that was processed. View appendix G. |
ACHCredit
Description:
Use these functions to create new ACH transactions. Below are the parameters for this method.
Resource Url:
https://webservice.paymentxp.com/wh/WebHost.aspx
Method:
POST
Request
Parameter | Is Required | Data Type | Max Length | Description |
AccountName
|
Yes
|
String
|
23
|
Name on account (Checking or Savings)
|
AccountNumber
|
Yes
|
String
|
17
|
Account Number or DDA
|
ACHCheckType
|
Yes
|
Number
|
1
|
Enter 1 or 2. Note: Value must be an integer 1 = Business to consumer transaction 2 = Business to business transaction
|
Amount
|
Yes
|
Number
|
8
|
Amount of sale
|
BankAccountType
|
Yes
|
Number
|
1
|
Enter 1 or 2. Note: 1 = Checking account 2 = Savings account
|
BillingAddress
|
No
|
String
|
50
|
The billing address of the cardholder. Used to check for AVS identification.
|
BillingCity
|
No
|
String
|
50
|
The billing city of the cardholder.
|
BillingCountry
|
No
|
String
|
50
|
The billing country of the cardholder.
|
BillingFullName
|
No
|
String
|
50
|
The name of the cardholder as it appears on the card.
|
BillingNameFirst
|
No
|
String
|
50
|
The first name of the cardholder.
|
BillingNameLast
|
No
|
String
|
50
|
The last name of the cardholder.
|
BillingPhone
|
No
|
Number
|
10
|
The phone number of the cardholder.
|
BillingState
|
No
|
String
|
25
|
The billing state of the cardholder.
|
BillingZipCode
|
No
|
String
|
10
|
The billing zip code of the cardholder. Used to check for AVS identification.
|
CheckNumber
|
Yes
|
String
|
25
|
Pass an empty string if check number does not exist. Note: Required only for RCK transaction type.
|
ClerkID
|
No
|
String
|
15
|
The cashier/clerk who initiated the transaction.
|
ClientIPAddress
|
No
|
String
|
25
|
The IP address of the client device.
|
CustomerID
|
No
|
String
|
50
|
An existing customer record that is used to retrieve cardholder data to be able to perform an ACH Credit transaction.
|
Custominfo1 (1-20)
|
No
|
String
|
255
|
For merchant use.
|
Description
|
Yes
|
String
|
10
|
Purpose of transaction. Description is required for ACH. This field shows up on customer’s bank statement.
|
EmailAddress
|
No
|
String
|
50
|
The e-mail address of the cardholder.
|
MerchantID
|
Yes
|
String
|
10
|
Unique ID assigned by Paysafe
|
MerchantKey
|
Yes
|
String
|
36
|
Unique Key assigned by Paysafe
|
ProcessDate
|
Yes
|
String
|
8
|
Date to process the transaction Format: MMddyyyy
|
ReferenceNumber
|
No
|
String
|
50
|
Merchant’s unique reference number
|
RoutingNumber
|
Yes
|
String
|
9
|
Routing number or ABA
|
ShippingAddress1
|
No
|
String
|
50
|
The shipping address for the product(s) purchased in the transaction.
|
ShippingAddress2
|
No
|
String
|
50
|
The shipping address for the product(s) purchased in the transaction.
|
ShippingCity
|
No
|
String
|
50
|
The shipping city for the product(s) purchased in the transaction.
|
ShippingCountry
|
No
|
String
|
50
|
The shipping country for the product(s) purchased in the transaction
|
ShippingState
|
No
|
String
|
25
|
The shipping state for the product(s) purchased in the transaction.
|
ShippingZipCode
|
No
|
String
|
10
|
The shipping zip code for the product(s) purchased in thetransaction.
|
TransactionType
|
Yes
|
String
|
19
|
ACHCredit
|
Response
Field Name | Description |
PostedDate | The date and time the transaction was posted. |
StatusID | The result of the transaction. Status 1 indicates an approved transaction. |
TransactionID | The number that identifies the transaction in the Paysafe Solutions system. |
ReferenceNumber | The merchant/customer transaction identifier that was sent in the initial request. |
TransactionAmount | Identifies the transaction amount that was sent in the initial request. |
Message | The message from the processor. |
Status | Status Description |
CustomerName | The name of the account holder as it appears on the account |
BillingNameFirst | The first name of the account holder. |
BillingNameLast | The last name of the account holder. |
BillingAddress | The billing address of the cardholder. Used to check for AVS identification. |
BillingCity | The billing city of the account holder. |
BillingState | The billing state of the account holder. |
BillingZip | The billing zip code of the account holder. Used to check for AVS identification. |
BillingCountry | The billing country of the account holder. |
BillingPhone | The phone number of the account holder. |
BillingFax | The fax number of the account holder |
BillingEmail | An existing customer record |
CustomerID | An existing customer record. |
RoutingNumber | Routing number or ABA |
AccountNumber | Account Number or DDA |
Action | The action that can be taken on this transaction. V=Void,S=Settle, C=Credit. A blank response means no action is available. |
TransTypeID | Identifies the type of transaction that was processed. View appendix F. |
VoidDate | The date and time the transaction was voided. |
TransactionStatusID | Identifies the status of the transaction that was processed. View appendix G. |
ACHRefund
Description:
Use the function to issue refunds to your customers. Below are the parameters for this method.
Resource Url:
https://webservice.paymentxp.com/wh/WebHost.aspx
Method:
POST
Request
Parameter | Is Required | Data Type | Max Length | Description |
CreditAmount
|
Yes
|
Number
|
8
|
Refund amount
|
MerchantID
|
Yes
|
String
|
10
|
Unique ID assigned by Paysafe
|
MerchantKey
|
Yes
|
String
|
36
|
Unique Key assigned by Paysafe
|
TransactionType
|
Yes
|
String
|
19
|
ACHRefund
|
TransID
|
Yes
|
Number
|
10
|
Transaction ID of original sale
|
Response
Field Name | Description |
PostedDate | The date and time the transaction was posted. |
StatusID | The result of the transaction. Status 1 indicates an approved transaction. |
TransactionID | The number that identifies the transaction in the Paysafe Solutions system. |
ReferenceNumber | The merchant/customer transaction identifier that was sent in the initial request. |
TransactionAmount | Identifies the transaction amount that was sent in the initial request. |
Message | The message from the processor. |
Status | Status Description |
CustomerName | The name of the account holder as it appears on the account |
BillingNameFirst | The first name of the account holder. |
BillingNameLast | The last name of the account holder. |
BillingAddress | The billing address of the cardholder. Used to check for AVS identification. |
BillingCity | The billing city of the account holder. |
BillingState | The billing state of the account holder. |
BillingZip | The billing zip code of the account holder. Used to check for AVS identification. |
BillingCountry | The billing country of the account holder. |
BillingPhone | The phone number of the account holder. |
BillingFax | The fax number of the account holder |
BillingEmail | An existing customer record |
CustomerID | An existing customer record. |
RoutingNumber | Routing number or ABA |
AccountNumber | Account Number or DDA |
Action | The action that can be taken on this transaction. V=Void,S=Settle, C=Credit. A blank response means no action is available. |
TransTypeID | Identifies the type of transaction that was processed. View appendix F. |
VoidDate | The date and time the transaction was voided. |
TransactionStatusID | Identifies the status of the transaction that was processed. View appendix G. |
ACHVoid
Description:
Use this function to void open. Below are the parameters for this method. Method will return a TransID, which is the identified for the ACH transaction.
Resource Url:
https://webservice.paymentxp.com/wh/WebHost.aspx
Method:
POST
Request
Parameter | Is Required | Data Type | Max Length | Description |
MerchantID
|
Yes
|
String
|
10
|
Unique ID assigned by Paysafe
|
MerchantKey
|
Yes
|
String
|
36
|
Unique Key assigned by Paysafe
|
TransactionType
|
Yes
|
String
|
19
|
ACHVoid
|
TransID
|
Yes
|
Number
|
10
|
Unique ID assigned by Paysafe
|
Response
Field Name | Description |
PostedDate | The date and time the transaction was posted. |
StatusID | The result of the transaction. Status 1 indicates an approved transaction. |
TransactionID | The number that identifies the transaction in the Paysafe Solutions system. |
ReferenceNumber | The merchant/customer transaction identifier that was sent in the initial request. |
TransactionAmount | Identifies the transaction amount that was sent in the initial request. |
Message | The message from the processor. |
Status | Status Description |
CustomerName | The name of the account holder as it appears on the account |
BillingNameFirst | The first name of the account holder. |
BillingNameLast | The last name of the account holder. |
BillingAddress | The billing address of the cardholder. Used to check for AVS identification. |
BillingCity | The billing city of the account holder. |
BillingState | The billing state of the account holder. |
BillingZip | The billing zip code of the account holder. Used to check for AVS identification. |
BillingCountry | The billing country of the account holder. |
BillingPhone | The phone number of the account holder. |
BillingFax | The fax number of the account holder |
BillingEmail | An existing customer record |
CustomerID | An existing customer record. |
RoutingNumber | Routing number or ABA |
AccountNumber | Account Number or DDA |
Action | The action that can be taken on this transaction. V=Void,S=Settle, C=Credit. A blank response means no action is available. |
TransTypeID | Identifies the type of transaction that was processed. View appendix F. |
VoidDate | The date and time the transaction was voided. |
TransactionStatusID | Identifies the status of the transaction that was processed. View appendix G. |
AddCustomerACHDebit
Description:
This method creates an ACH debit transaction from a customer record.
Resource Url:
https://webservice.paymentxp.com/wh/WebHost.aspx
Method:
POST
Request
Parameter | Is Required | Data Type | Max Length | Description |
Amount
|
Yes
|
Number
|
9
|
Identifies the transaction amount that was sent in the initial request.
|
CustomerID
|
Yes
|
String
|
50
|
An existing customer record that is used to retrieve cardholder data to be able to perform an ACH Credit transaction.
|
Custominfo1 (1-20)
|
No
|
String
|
255
|
For merchant use.
|
Description
|
Yes
|
String
|
10
|
Purpose of transaction. Description is required for ACH. This field shows up on customer’s bank statement.
|
MerchantID
|
Yes
|
Number
|
9
|
The identification that is assigned to the merchant.
|
MerchantKey
|
Yes
|
String
|
36
|
A unique identification that is assigned to the merchant id.
|
ProcessDate
|
Yes
|
String
|
8
|
Date to process the transaction Format: MMddyyyy
|
ReferenceNumber
|
No
|
String
|
50
|
The merchant/customer transaction identifier.
|
TransactionType
|
Yes
|
String
|
19
|
AddCustomerACHDebit
|
Response
Field Name | Description |
PostedDate | The date and time the transaction was posted. |
StatusID | The result of the transaction. Status 1 indicates an approved transaction. |
TransactionID | The number that identifies the transaction in the Paysafe Solutions system. |
ReferenceNumber | The merchant/customer transaction identifier that was sent in the initial request. |
TransactionAmount | Identifies the transaction amount that was sent in the initial request. |
Message | The message from the processor. |
Status | Status Description |
CustomerName | The name of the account holder as it appears on the account |
BillingNameFirst | The first name of the account holder. |
BillingNameLast | The last name of the account holder. |
BillingAddress | The billing address of the cardholder. Used to check for AVS identification. |
BillingCity | The billing city of the account holder. |
BillingState | The billing state of the account holder. |
BillingZip | The billing zip code of the account holder. Used to check for AVS identification. |
BillingCountry | The billing country of the account holder. |
BillingPhone | The phone number of the account holder. |
BillingFax | The fax number of the account holder |
BillingEmail | An existing customer record |
CustomerID | An existing customer record. |
RoutingNumber | Routing number or ABA |
AccountNumber | Account Number or DDA |
Action | The action that can be taken on this transaction. V=Void,S=Settle, C=Credit. A blank response means no action is available. |
TransTypeID | Identifies the type of transaction that was processed. View appendix F. |
VoidDate | The date and time the transaction was voided. |
TransactionStatusID | Identifies the status of the transaction that was processed. View appendix G. |
AddCustomerACHCredit
Description:
This method creates an ACH credit transaction from a customer record.
Resource Url:
https://webservice.paymentxp.com/wh/WebHost.aspx
Method:
POST
Request
Parameter | Is Required | Data Type | Max Length | Description |
Amount
|
Yes
|
Number
|
9
|
Identifies the transaction amount that was sent in the initial request.
|
CustomerID
|
Yes
|
String
|
50
|
An existing customer record that is used to retrieve cardholder data to be able to perform an ACH Credit transaction.
|
Custominfo1 (1-20)
|
No
|
String
|
255
|
For merchant use.
|
Description
|
Yes
|
String
|
10
|
Purpose of transaction. Description is required for ACH. This field shows up on customer’s bank statement.
|
MerchantID
|
Yes
|
Number
|
9
|
The identification that is assigned to the merchant.
|
MerchantKey
|
Yes
|
String
|
36
|
A unique identification that is assigned to the merchant id.
|
ProcessDate
|
Yes
|
String
|
8
|
Date to process the transaction Format: MMddyyyy
|
ReferenceNumber
|
No
|
String
|
50
|
Pass an empty string if check number does not exist. Note: Required only for RCK transaction type.
|
TransactionType
|
Yes
|
String
|
19
|
AddCustomerACHCredit
|
Response
Field Name | Description |
PostedDate | The date and time the transaction was posted. |
StatusID | The result of the transaction. Status 1 indicates an approved transaction. |
TransactionID | The number that identifies the transaction in the Paysafe Solutions system. |
ReferenceNumber | The merchant/customer transaction identifier that was sent in the initial request. |
TransactionAmount | Identifies the transaction amount that was sent in the initial request. |
Message | The message from the processor. |
Status | Status Description |
CustomerName | The name of the account holder as it appears on the account |
BillingNameFirst | The first name of the account holder. |
BillingNameLast | The last name of the account holder. |
BillingAddress | The billing address of the cardholder. Used to check for AVS identification. |
BillingCity | The billing city of the account holder. |
BillingState | The billing state of the account holder. |
BillingZip | The billing zip code of the account holder. Used to check for AVS identification. |
BillingCountry | The billing country of the account holder. |
BillingPhone | The phone number of the account holder. |
BillingFax | The fax number of the account holder |
BillingEmail | An existing customer record |
CustomerID | An existing customer record. |
RoutingNumber | Routing number or ABA |
AccountNumber | Account Number or DDA |
Action | The action that can be taken on this transaction. V=Void,S=Settle, C=Credit. A blank response means no action is available. |
TransTypeID | Identifies the type of transaction that was processed. View appendix F. |
VoidDate | The date and time the transaction was voided. |
TransactionStatusID | Identifies the status of the transaction that was processed. View appendix G. |
GetAchTransaction
Description:
This method retrieves an ACH transaction record from the database.
Resource Url:
https://webservice.paymentxp.com/wh/WebHost.aspx
Method:
POST
Request
Parameter | Is Required | Data Type | Max Length | Description |
MerchantID
|
Yes
|
Number
|
9
|
The identification that is assigned to the merchant.
|
MerchantKey
|
Yes
|
String
|
36
|
A unique identification that is assigned to the merchant id.
|
TransactionType
|
Yes
|
String
|
14
|
GetAchTransaction
|
TransID
|
Yes
|
Number
|
19
|
The TransactionID value returned by ACHDebit() or ACHCredt ()or ACHVoid() or ACHRefund() transaction.
|
Response
Field Name | Description |
PostedDate | The date and time the transaction was posted. |
StatusID | The result of the transaction. Status 1 indicates an approved transaction. |
TransactionID | The number that identifies the transaction in the Paysafe Solutions system. |
ReferenceNumber | The merchant/customer transaction identifier that was sent in the initial request. |
TransactionAmount | Identifies the transaction amount that was sent in the initial request. |
Message | The message from the processor. |
Status | Status Description |
CustomerName | The name of the account holder as it appears on the account |
BillingNameFirst | The first name of the account holder. |
BillingNameLast | The last name of the account holder. |
BillingAddress | The billing address of the cardholder. Used to check for AVS identification. |
BillingCity | The billing city of the account holder. |
BillingState | The billing state of the account holder. |
BillingZip | The billing zip code of the account holder. Used to check for AVS identification. |
BillingCountry | The billing country of the account holder. |
BillingPhone | The phone number of the account holder. |
BillingFax | The fax number of the account holder |
BillingEmail | An existing customer record |
CustomerID | An existing customer record. |
RoutingNumber | Routing number or ABA |
AccountNumber | Account Number or DDA |
Action | The action that can be taken on this transaction. V=Void,S=Settle, C=Credit. A blank response means no action is available. |
TransTypeID | Identifies the type of transaction that was processed. View appendix F. |
VoidDate | The date and time the transaction was voided. |
TransactionStatusID | Identifies the status of the transaction that was processed. View appendix G. |
ACHRecurringDebitInsert
Description:
This method creates a recurring ACH debit transaction rule.
Resource Url:
https://webservice.paymentxp.com/wh/WebHost.aspx
Method:
POST
Request
Parameter | Is Required | Data Type | Max Length | Description |
AccountName
|
Yes
|
String
|
23
|
Name on account (Checking or Savings)
|
AccountNumber
|
Yes
|
String
|
17
|
Account Number or DDA
|
ACHCheckType
|
Yes
|
Number
|
1
|
Enter 1 or 2. Note: Value must be an integer 1 = Business to consumer transaction 2 = Business to business transaction
|
Amount
|
Yes
|
Number
|
8
|
Amount of sale
|
BankAccountType
|
Yes
|
Number
|
1
|
Enter 1 or 2. Note: 1 = Checking account 2 = Savings account
|
BillingAddress
|
No
|
String
|
50
|
The billing address of the account holder.
|
BillingCity
|
No
|
String
|
50
|
The billing city of the account holder.
|
BillingCountry
|
No
|
String
|
50
|
The billing country of the account holder.
|
BillingFullName
|
No
|
String
|
50
|
The name of the account holder as it appears on the account.
|
BillingNameFirst
|
No
|
String
|
50
|
The first name of the account holder.
|
BillingNameLast
|
No
|
String
|
50
|
The last name of the account holder.
|
BillingPhone
|
No
|
Number
|
10
|
The phone number of the account holder.
|
BillingState
|
No
|
String
|
25
|
The billing state of the account holder.
|
BillingZipCode
|
No
|
String
|
10
|
The billing zip code of the account holder.
|
CheckNumber
|
Yes
|
String
|
25
|
Pass an empty string if check number does not exist. Note: Required only for RCK transaction type.
|
ClerkID
|
No
|
String
|
15
|
The cashier/clerk who initiated the transaction.
|
ClientIPAddress
|
No
|
String
|
25
|
The IP address of the client device.
|
CustomerID
|
No
|
String
|
50
|
An existing customer record that is used to retrieve account holder data to be able to perform an ACH Credit transaction.
|
Custominfo1 (1-20)
|
No
|
String
|
255
|
For merchant use.
|
DayOfMonthOption
|
Yes
|
Number
|
1
|
0=None, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31
|
Description
|
Yes
|
String
|
10
|
Purpose of transaction. Description is required for ACH. This field shows up on customer’s bank statement.
|
EmailAddress
|
No
|
String
|
50
|
The e-mail address of the account holder.
|
EndDate
|
No
|
Number
|
8
|
End date for recurring payment. Format MMddyyyy. Leave blank if there is no end date.
|
MerchantID
|
Yes
|
Number
|
9
|
The identification that is assigned to the merchant.
|
MerchantKey
|
Yes
|
String
|
36
|
A unique identification that is assigned to the merchant id.
|
MonthlyOption
|
Yes
|
Number
|
1
|
0=None, 1= Set day of month option (MonthOfYearOption and DayOfMonthOption are required), 2= Set the advanced option per month (WeekOption, WeekdayOption, and MonthofYearOption are required)
|
MonthOfYearOption
|
No
|
Number
|
1
|
0=None, 1=One, 2=Two, 3=Three, 4=Four, 5=Five, 6=Six, 7=Seven, 8=Eight, 9=Nine, 10=Ten, 11=Eleven, 12=Twelve Only applicable when MonthlyOption=2
|
OccurenceOption
|
Yes
|
Number
|
1
|
1=Daily, 2=Monthly
|
RoutingNumber
|
Yes
|
String
|
9
|
Routing number or ABA
|
ShippingAddress1
|
No
|
String
|
50
|
The shipping address for the product(s) purchased in the transaction.
|
ShippingAddress2
|
No
|
String
|
50
|
The shipping address for the product(s) purchased in the transaction.
|
ShippingCity
|
No
|
String
|
50
|
The shipping city for the product(s) purchased in the transaction.
|
ShippingCountry
|
No
|
String
|
50
|
The shipping country for the product(s) purchased in the transaction.
|
ShippingState
|
No
|
String
|
25
|
The shipping state for the product(s) purchased in the transaction.
|
ShippingZipCode
|
No
|
String
|
10
|
The shipping zip code for the product(s) purchased in the transaction.
|
StartDate
|
Yes
|
Number
|
8
|
Start date for recurring payment. Format MMddyyyy.
|
Token
|
No
|
String
|
36
|
Paysafe Token
|
TransactionType
|
Yes
|
String
|
25
|
ACHRecurringDebitInsert
|
TransID
|
No
|
Number
|
10
|
Transaction ID assigned by Paysafe from a historical transaction.
|
WeekdayOption
|
No
|
Number
|
1
|
0=None, 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday, 6=Saturday, 7=Sunday Only applicable when MonthlyOption=2
|
WeekOption
|
No
|
Number
|
1
|
0=None, 1=First, 2=Second, 3=Third, 4=Fourth, 5=Last week of the month. Only applicable when MonthlyOption=2
|
Response
Field Name | Description |
PostedDate | The date and time the transaction was posted. |
StatusID | The result of the transaction. Status 1 indicates an approved transaction. |
TransactionID | The number that identifies the transaction in the Paysafe Solutions system. |
ReferenceNumber | The merchant/customer transaction identifier that was sent in the initial request. |
TransactionAmount | Identifies the transaction amount that was sent in the initial request. |
Message | The message from the processor. |
Status | Status Description |
CustomerName | The name of the account holder as it appears on the account |
BillingNameFirst | The first name of the account holder. |
BillingNameLast | The last name of the account holder. |
BillingAddress | The billing address of the cardholder. Used to check for AVS identification. |
BillingCity | The billing city of the account holder. |
BillingState | The billing state of the account holder. |
BillingZip | The billing zip code of the account holder. Used to check for AVS identification. |
BillingCountry | The billing country of the account holder. |
BillingPhone | The phone number of the account holder. |
BillingFax | The fax number of the account holder |
BillingEmail | An existing customer record |
CustomerID | An existing customer record. |
RoutingNumber | Routing number or ABA |
AccountNumber | Account Number or DDA |
Action | The action that can be taken on this transaction. V=Void,S=Settle, C=Credit. A blank response means no action is available. |
TransTypeID | Identifies the type of transact | |