Introduction

This document provides technical specifications for processing financial transactions through Paysafe Solutions Transaction 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 Solutions Transaction 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 c22a63ee-2e7a-4ace-96ac-0958dc8d953f
Hosted Payment Key 1QZYRLqw0vbL6gZTinRv+WqfZF/jIrYDALbMppssqHRKKmtatc+kmCIjumfpqipE
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

  1. Login into paymentxp.com
  2. Click on Reports>Transaction Detail
  3. Locate the transaction you would like to settle in order to test a refund
  4. Click on the Transaction ID number
  5. 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

ParameterIs RequiredData TypeMax LengthDescription
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 NameDescription
TokenA unique identifier that represents the account information.
StatusIDThe result of the request. Status 0 indicates an approved token request.
MessageStatus 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

ParameterIs RequiredData TypeMax LengthDescription
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 NameDescription
TokenA unique identifier that represents the account information.
StatusIDThe result of the request. Status 0 indicates an approved token request.
MessageStatus 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

ParameterIs RequiredData TypeMax LengthDescription
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 NameDescription
TokenA unique identifier that represents the account information.
StatusIDThe result of the request. Status 0 indicates an approved token request.
MessageStatus 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

ParameterIs RequiredData TypeMax LengthDescription
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 NameDescription
TokenA unique identifier that represents the account information.
StatusIDThe result of the request. Status 0 indicates an approved token request.
MessageStatus 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

Request

ParameterIs RequiredData TypeMax LengthDescription
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. 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
IsRecurring No Boolean 1 Indicates transaction is a recurring 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.
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.
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 NameDescription
PostedDateThe date and time the transaction was posted.
StatusIDThe result of the transaction. Status 0 indicates an approved transaction.
TransactionIDThe number that identifies the transaction in the Paysafe Solutions system.
ReferenceNumberThe merchant/customer transaction identifier that was sent in the initial request.
TransactionAmountIdentifies the transaction amount that was sent in the initial request.
AuthorizationCodeAuthorization code from the issuing bank.
ResponseCodeThe approval or decline code from the processor.
ResponseMessageThe approval or decline message from the processor.
CVV2ResponseCodeThe CVV2 response code.
CVV2ResponseMessageThe CVV2 response message.
AVSResponseCodeThe AVS response code.
AVSResponseMessageThe AVS response message.
URLPostbackURL to redirect customer after sale has been posted
CardNumberIdentifies the last 4 cardholder’s account number.
CustomerNameThe name of the cardholder as it appears on the card.
BillingNameFirstThe first name of the cardholder.
BillingNameLastThe last name of the cardholder.
BillingAddressThe billing address of the cardholder. Used to check for AVS identification.
BillingCityThe billing city of the cardholder.
BillingStateThe billing state of the cardholder.
BillingZipThe billing zip code of the cardholder. Used to check for AVS identification.
BillingCountryThe billing country of the cardholder.
BillingPhoneThe phone number of the cardholder.
BillingFaxThe fax number of the cardholder
BillingEmailThe e-mail address of the cardholder.
CustomerIDAn existing customer record.
ProductDescUse to identify product name.
ActionThe action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available.
ShippingAddress1The shipping address of the cardholder.
ShippingAddress2The shipping address of the cardholder.
ShippingCityThe shipping city of the cardholder.
ShippingStateThe shipping state of the cardholder.
ShippingZipCodeThe shipping zip code of the cardholder. Used to check for AVS identification.
ShippingCountryThe shipping country of the cardholder.
Custominfo1 (1-20)For merchant use.
TransTypeIDIdentifies the type of transaction that was processed. View appendix F.
SettleDateThe date and time the transaction was settled.
VoidDateThe date and time the transaction was voided.
RefundDateThe date and time the transaction was refunded.
TransactionStatusIDIdentifies 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

Request

ParameterIs RequiredData TypeMax LengthDescription
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 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 NameDescription
PostedDateThe date and time the transaction was posted.
StatusIDThe result of the transaction. Status 0 indicates an approved transaction.
TransactionIDThe number that identifies the transaction in the Paysafe Solutions system.
ReferenceNumberThe merchant/customer transaction identifier that was sent in the initial request.
TransactionAmountIdentifies the transaction amount that was sent in the initial request.
AuthorizationCodeAuthorization code from the issuing bank.
ResponseCodeThe approval or decline code from the processor.
ResponseMessageThe approval or decline message from the processor.
CVV2ResponseCodeThe CVV2 response code.
CVV2ResponseMessageThe CVV2 response message.
AVSResponseCodeThe AVS response code.
AVSResponseMessageThe AVS response message.
URLPostbackURL to redirect customer after sale has been posted
CardNumberIdentifies the last 4 cardholder’s account number.
CustomerNameThe name of the cardholder as it appears on the card.
BillingNameFirstThe first name of the cardholder.
BillingNameLastThe last name of the cardholder.
BillingAddressThe billing address of the cardholder. Used to check for AVS identification.
BillingCityThe billing city of the cardholder.
BillingStateThe billing state of the cardholder.
BillingZipThe billing zip code of the cardholder. Used to check for AVS identification.
BillingCountryThe billing country of the cardholder.
BillingPhoneThe phone number of the cardholder.
BillingFaxThe fax number of the cardholder
BillingEmailThe e-mail address of the cardholder.
CustomerIDAn existing customer record.
ProductDescUse to identify product name.
ActionThe action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available.
ShippingAddress1The shipping address of the cardholder.
ShippingAddress2The shipping address of the cardholder.
ShippingCityThe shipping city of the cardholder.
ShippingStateThe shipping state of the cardholder.
ShippingZipCodeThe shipping zip code of the cardholder. Used to check for AVS identification.
ShippingCountryThe shipping country of the cardholder.
Custominfo1 (1-20)For merchant use.
TransTypeIDIdentifies the type of transaction that was processed. View appendix F.
SettleDateThe date and time the transaction was settled.
VoidDateThe date and time the transaction was voided.
RefundDateThe date and time the transaction was refunded.
TransactionStatusIDIdentifies 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

Request

ParameterIs RequiredData TypeMax LengthDescription
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. 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
IsRecurring No Boolean 1 Indicates transaction is a recurring 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.
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.
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.
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 NameDescription
PostedDateThe date and time the transaction was posted.
StatusIDThe result of the transaction. Status 0 indicates an approved transaction.
TransactionIDThe number that identifies the transaction in the Paysafe Solutions system.
ReferenceNumberThe merchant/customer transaction identifier that was sent in the initial request.
TransactionAmountIdentifies the transaction amount that was sent in the initial request.
AuthorizationCodeAuthorization code from the issuing bank.
ResponseCodeThe approval or decline code from the processor.
ResponseMessageThe approval or decline message from the processor.
CVV2ResponseCodeThe CVV2 response code.
CVV2ResponseMessageThe CVV2 response message.
AVSResponseCodeThe AVS response code.
AVSResponseMessageThe AVS response message.
URLPostbackURL to redirect customer after sale has been posted
CardNumberIdentifies the last 4 cardholder’s account number.
CustomerNameThe name of the cardholder as it appears on the card.
BillingNameFirstThe first name of the cardholder.
BillingNameLastThe last name of the cardholder.
BillingAddressThe billing address of the cardholder. Used to check for AVS identification.
BillingCityThe billing city of the cardholder.
BillingStateThe billing state of the cardholder.
BillingZipThe billing zip code of the cardholder. Used to check for AVS identification.
BillingCountryThe billing country of the cardholder.
BillingPhoneThe phone number of the cardholder.
BillingFaxThe fax number of the cardholder
BillingEmailThe e-mail address of the cardholder.
CustomerIDAn existing customer record.
ProductDescUse to identify product name.
ActionThe action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available.
ShippingAddress1The shipping address of the cardholder.
ShippingAddress2The shipping address of the cardholder.
ShippingCityThe shipping city of the cardholder.
ShippingStateThe shipping state of the cardholder.
ShippingZipCodeThe shipping zip code of the cardholder. Used to check for AVS identification.
ShippingCountryThe shipping country of the cardholder.
Custominfo1 (1-20)For merchant use.
TransTypeIDIdentifies the type of transaction that was processed. View appendix F.
SettleDateThe date and time the transaction was settled.
VoidDateThe date and time the transaction was voided.
RefundDateThe date and time the transaction was refunded.
TransactionStatusIDIdentifies 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

ParameterIs RequiredData TypeMax LengthDescription
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 NameDescription
PostedDateThe date and time the transaction was posted.
StatusIDThe result of the transaction. Status 0 indicates an approved transaction.
TransactionIDThe number that identifies the transaction in the Paysafe Solutions system.
ReferenceNumberThe merchant/customer transaction identifier that was sent in the initial request.
TransactionAmountIdentifies the transaction amount that was sent in the initial request.
AuthorizationCodeAuthorization code from the issuing bank.
ResponseCodeThe approval or decline code from the processor.
ResponseMessageThe approval or decline message from the processor.
CVV2ResponseCodeThe CVV2 response code.
CVV2ResponseMessageThe CVV2 response message.
AVSResponseCodeThe AVS response code.
AVSResponseMessageThe AVS response message.
URLPostbackURL to redirect customer after sale has been posted
CardNumberIdentifies the last 4 cardholder’s account number.
CustomerNameThe name of the cardholder as it appears on the card.
BillingNameFirstThe first name of the cardholder.
BillingNameLastThe last name of the cardholder.
BillingAddressThe billing address of the cardholder. Used to check for AVS identification.
BillingCityThe billing city of the cardholder.
BillingStateThe billing state of the cardholder.
BillingZipThe billing zip code of the cardholder. Used to check for AVS identification.
BillingCountryThe billing country of the cardholder.
BillingPhoneThe phone number of the cardholder.
BillingFaxThe fax number of the cardholder
BillingEmailThe e-mail address of the cardholder.
CustomerIDAn existing customer record.
ProductDescUse to identify product name.
ActionThe action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available.
ShippingAddress1The shipping address of the cardholder.
ShippingAddress2The shipping address of the cardholder.
ShippingCityThe shipping city of the cardholder.
ShippingStateThe shipping state of the cardholder.
ShippingZipCodeThe shipping zip code of the cardholder. Used to check for AVS identification.
ShippingCountryThe shipping country of the cardholder.
Custominfo1 (1-20)For merchant use.
TransTypeIDIdentifies the type of transaction that was processed. View appendix F.
SettleDateThe date and time the transaction was settled.
VoidDateThe date and time the transaction was voided.
RefundDateThe date and time the transaction was refunded.
TransactionStatusIDIdentifies 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

Request

ParameterIs RequiredData TypeMax LengthDescription
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 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 CreditCardVoid

Response

Field NameDescription
PostedDateThe date and time the transaction was posted.
StatusIDThe result of the transaction. Status 0 indicates an approved transaction.
TransactionIDThe number that identifies the transaction in the Paysafe Solutions system.
ReferenceNumberThe merchant/customer transaction identifier that was sent in the initial request.
TransactionAmountIdentifies the transaction amount that was sent in the initial request.
AuthorizationCodeAuthorization code from the issuing bank.
ResponseCodeThe approval or decline code from the processor.
ResponseMessageThe approval or decline message from the processor.
CVV2ResponseCodeThe CVV2 response code.
CVV2ResponseMessageThe CVV2 response message.
AVSResponseCodeThe AVS response code.
AVSResponseMessageThe AVS response message.
URLPostbackURL to redirect customer after sale has been posted
CardNumberIdentifies the last 4 cardholder’s account number.
CustomerNameThe name of the cardholder as it appears on the card.
BillingNameFirstThe first name of the cardholder.
BillingNameLastThe last name of the cardholder.
BillingAddressThe billing address of the cardholder. Used to check for AVS identification.
BillingCityThe billing city of the cardholder.
BillingStateThe billing state of the cardholder.
BillingZipThe billing zip code of the cardholder. Used to check for AVS identification.
BillingCountryThe billing country of the cardholder.
BillingPhoneThe phone number of the cardholder.
BillingFaxThe fax number of the cardholder
BillingEmailThe e-mail address of the cardholder.
CustomerIDAn existing customer record.
ProductDescUse to identify product name.
ActionThe action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available.
ShippingAddress1The shipping address of the cardholder.
ShippingAddress2The shipping address of the cardholder.
ShippingCityThe shipping city of the cardholder.
ShippingStateThe shipping state of the cardholder.
ShippingZipCodeThe shipping zip code of the cardholder. Used to check for AVS identification.
ShippingCountryThe shipping country of the cardholder.
Custominfo1 (1-20)For merchant use.
TransTypeIDIdentifies the type of transaction that was processed. View appendix F.
SettleDateThe date and time the transaction was settled.
VoidDateThe date and time the transaction was voided.
RefundDateThe date and time the transaction was refunded.
TransactionStatusIDIdentifies 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

ParameterIs RequiredData TypeMax LengthDescription
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 NameDescription
PostedDateThe date and time the transaction was posted.
StatusIDThe result of the transaction. Status 0 indicates an approved transaction.
TransactionIDThe number that identifies the transaction in the Paysafe Solutions system.
ReferenceNumberThe merchant/customer transaction identifier that was sent in the initial request.
TransactionAmountIdentifies the transaction amount that was sent in the initial request.
AuthorizationCodeAuthorization code from the issuing bank.
ResponseCodeThe approval or decline code from the processor.
ResponseMessageThe approval or decline message from the processor.
CVV2ResponseCodeThe CVV2 response code.
CVV2ResponseMessageThe CVV2 response message.
AVSResponseCodeThe AVS response code.
AVSResponseMessageThe AVS response message.
URLPostbackURL to redirect customer after sale has been posted
CardNumberIdentifies the last 4 cardholder’s account number.
CustomerNameThe name of the cardholder as it appears on the card.
BillingNameFirstThe first name of the cardholder.
BillingNameLastThe last name of the cardholder.
BillingAddressThe billing address of the cardholder. Used to check for AVS identification.
BillingCityThe billing city of the cardholder.
BillingStateThe billing state of the cardholder.
BillingZipThe billing zip code of the cardholder. Used to check for AVS identification.
BillingCountryThe billing country of the cardholder.
BillingPhoneThe phone number of the cardholder.
BillingFaxThe fax number of the cardholder
BillingEmailThe e-mail address of the cardholder.
CustomerIDAn existing customer record.
ProductDescUse to identify product name.
ActionThe action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available.
ShippingAddress1The shipping address of the cardholder.
ShippingAddress2The shipping address of the cardholder.
ShippingCityThe shipping city of the cardholder.
ShippingStateThe shipping state of the cardholder.
ShippingZipCodeThe shipping zip code of the cardholder. Used to check for AVS identification.
ShippingCountryThe shipping country of the cardholder.
Custominfo1 (1-20)For merchant use.
TransTypeIDIdentifies the type of transaction that was processed. View appendix F.
SettleDateThe date and time the transaction was settled.
VoidDateThe date and time the transaction was voided.
RefundDateThe date and time the transaction was refunded.
TransactionStatusIDIdentifies 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

Request

ParameterIs RequiredData TypeMax LengthDescription
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.
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
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.
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 NameDescription
PostedDateThe date and time the transaction was posted.
StatusIDThe result of the transaction. Status 0 indicates an approved transaction.
TransactionIDThe number that identifies the transaction in the Paysafe Solutions system.
ReferenceNumberThe merchant/customer transaction identifier that was sent in the initial request.
TransactionAmountIdentifies the transaction amount that was sent in the initial request.
AuthorizationCodeAuthorization code from the issuing bank.
ResponseCodeThe approval or decline code from the processor.
ResponseMessageThe approval or decline message from the processor.
CVV2ResponseCodeThe CVV2 response code.
CVV2ResponseMessageThe CVV2 response message.
AVSResponseCodeThe AVS response code.
AVSResponseMessageThe AVS response message.
URLPostbackURL to redirect customer after sale has been posted
CardNumberIdentifies the last 4 cardholder’s account number.
CustomerNameThe name of the cardholder as it appears on the card.
BillingNameFirstThe first name of the cardholder.
BillingNameLastThe last name of the cardholder.
BillingAddressThe billing address of the cardholder. Used to check for AVS identification.
BillingCityThe billing city of the cardholder.
BillingStateThe billing state of the cardholder.
BillingZipThe billing zip code of the cardholder. Used to check for AVS identification.
BillingCountryThe billing country of the cardholder.
BillingPhoneThe phone number of the cardholder.
BillingFaxThe fax number of the cardholder
BillingEmailThe e-mail address of the cardholder.
CustomerIDAn existing customer record.
ProductDescUse to identify product name.
ActionThe action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available.
ShippingAddress1The shipping address of the cardholder.
ShippingAddress2The shipping address of the cardholder.
ShippingCityThe shipping city of the cardholder.
ShippingStateThe shipping state of the cardholder.
ShippingZipCodeThe shipping zip code of the cardholder. Used to check for AVS identification.
ShippingCountryThe shipping country of the cardholder.
Custominfo1 (1-20)For merchant use.
TransTypeIDIdentifies the type of transaction that was processed. View appendix F.
SettleDateThe date and time the transaction was settled.
VoidDateThe date and time the transaction was voided.
RefundDateThe date and time the transaction was refunded.
TransactionStatusIDIdentifies 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

ParameterIs RequiredData TypeMax LengthDescription
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 NameDescription
PostedDateThe date and time the transaction was posted.
StatusIDThe result of the transaction. Status 0 indicates an approved transaction.
TransactionIDThe number that identifies the transaction in the Paysafe Solutions system.
ReferenceNumberThe merchant/customer transaction identifier that was sent in the initial request.
TransactionAmountIdentifies the transaction amount that was sent in the initial request.
AuthorizationCodeAuthorization code from the issuing bank.
ResponseCodeThe approval or decline code from the processor.
ResponseMessageThe approval or decline message from the processor.
CVV2ResponseCodeThe CVV2 response code.
CVV2ResponseMessageThe CVV2 response message.
AVSResponseCodeThe AVS response code.
AVSResponseMessageThe AVS response message.
URLPostbackURL to redirect customer after sale has been posted
CardNumberIdentifies the last 4 cardholder’s account number.
CustomerNameThe name of the cardholder as it appears on the card.
BillingNameFirstThe first name of the cardholder.
BillingNameLastThe last name of the cardholder.
BillingAddressThe billing address of the cardholder. Used to check for AVS identification.
BillingCityThe billing city of the cardholder.
BillingStateThe billing state of the cardholder.
BillingZipThe billing zip code of the cardholder. Used to check for AVS identification.
BillingCountryThe billing country of the cardholder.
BillingPhoneThe phone number of the cardholder.
BillingFaxThe fax number of the cardholder
BillingEmailThe e-mail address of the cardholder.
CustomerIDAn existing customer record.
ProductDescUse to identify product name.
ActionThe action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available.
ShippingAddress1The shipping address of the cardholder.
ShippingAddress2The shipping address of the cardholder.
ShippingCityThe shipping city of the cardholder.
ShippingStateThe shipping state of the cardholder.
ShippingZipCodeThe shipping zip code of the cardholder. Used to check for AVS identification.
ShippingCountryThe shipping country of the cardholder.
Custominfo1 (1-20)For merchant use.
TransTypeIDIdentifies the type of transaction that was processed. View appendix F.
SettleDateThe date and time the transaction was settled.
VoidDateThe date and time the transaction was voided.
RefundDateThe date and time the transaction was refunded.
TransactionStatusIDIdentifies 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

ParameterIs RequiredData TypeMax LengthDescription
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 NameDescription
PostedDateThe date and time the transaction was posted.
StatusIDThe result of the transaction. Status 0 indicates an approved transaction.
TransactionIDThe number that identifies the transaction in the Paysafe Solutions system.
ReferenceNumberThe merchant/customer transaction identifier that was sent in the initial request.
TransactionAmountIdentifies the transaction amount that was sent in the initial request.
AuthorizationCodeAuthorization code from the issuing bank.
ResponseCodeThe approval or decline code from the processor.
ResponseMessageThe approval or decline message from the processor.
CVV2ResponseCodeThe CVV2 response code.
CVV2ResponseMessageThe CVV2 response message.
AVSResponseCodeThe AVS response code.
AVSResponseMessageThe AVS response message.
URLPostbackURL to redirect customer after sale has been posted
CardNumberIdentifies the last 4 cardholder’s account number.
CustomerNameThe name of the cardholder as it appears on the card.
BillingNameFirstThe first name of the cardholder.
BillingNameLastThe last name of the cardholder.
BillingAddressThe billing address of the cardholder. Used to check for AVS identification.
BillingCityThe billing city of the cardholder.
BillingStateThe billing state of the cardholder.
BillingZipThe billing zip code of the cardholder. Used to check for AVS identification.
BillingCountryThe billing country of the cardholder.
BillingPhoneThe phone number of the cardholder.
BillingFaxThe fax number of the cardholder
BillingEmailThe e-mail address of the cardholder.
CustomerIDAn existing customer record.
ProductDescUse to identify product name.
ActionThe action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available.
ShippingAddress1The shipping address of the cardholder.
ShippingAddress2The shipping address of the cardholder.
ShippingCityThe shipping city of the cardholder.
ShippingStateThe shipping state of the cardholder.
ShippingZipCodeThe shipping zip code of the cardholder. Used to check for AVS identification.
ShippingCountryThe shipping country of the cardholder.
Custominfo1 (1-20)For merchant use.
TransTypeIDIdentifies the type of transaction that was processed. View appendix F.
SettleDateThe date and time the transaction was settled.
VoidDateThe date and time the transaction was voided.
RefundDateThe date and time the transaction was refunded.
TransactionStatusIDIdentifies 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

Request

ParameterIs RequiredData TypeMax LengthDescription
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.
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.
TransactionAmount Yes Number 9 Identifies the transaction amount that was sent in the initial request
TransactionType Yes String 19 AddCustomerCCCharge

Response

Field NameDescription
PostedDateThe date and time the transaction was posted.
StatusIDThe result of the transaction. Status 0 indicates an approved transaction.
TransactionIDThe number that identifies the transaction in the Paysafe Solutions system.
ReferenceNumberThe merchant/customer transaction identifier that was sent in the initial request.
TransactionAmountIdentifies the transaction amount that was sent in the initial request.
AuthorizationCodeAuthorization code from the issuing bank.
ResponseCodeThe approval or decline code from the processor.
ResponseMessageThe approval or decline message from the processor.
CVV2ResponseCodeThe CVV2 response code.
CVV2ResponseMessageThe CVV2 response message.
AVSResponseCodeThe AVS response code.
AVSResponseMessageThe AVS response message.
URLPostbackURL to redirect customer after sale has been posted
CardNumberIdentifies the last 4 cardholder’s account number.
CustomerNameThe name of the cardholder as it appears on the card.
BillingNameFirstThe first name of the cardholder.
BillingNameLastThe last name of the cardholder.
BillingAddressThe billing address of the cardholder. Used to check for AVS identification.
BillingCityThe billing city of the cardholder.
BillingStateThe billing state of the cardholder.
BillingZipThe billing zip code of the cardholder. Used to check for AVS identification.
BillingCountryThe billing country of the cardholder.
BillingPhoneThe phone number of the cardholder.
BillingFaxThe fax number of the cardholder
BillingEmailThe e-mail address of the cardholder.
CustomerIDAn existing customer record.
ProductDescUse to identify product name.
ActionThe action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available.
ShippingAddress1The shipping address of the cardholder.
ShippingAddress2The shipping address of the cardholder.
ShippingCityThe shipping city of the cardholder.
ShippingStateThe shipping state of the cardholder.
ShippingZipCodeThe shipping zip code of the cardholder. Used to check for AVS identification.
ShippingCountryThe shipping country of the cardholder.
Custominfo1 (1-20)For merchant use.
TransTypeIDIdentifies the type of transaction that was processed. View appendix F.
SettleDateThe date and time the transaction was settled.
VoidDateThe date and time the transaction was voided.
RefundDateThe date and time the transaction was refunded.
TransactionStatusIDIdentifies 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

ParameterIs RequiredData TypeMax LengthDescription
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 NameDescription
PostedDateThe date and time the transaction was posted.
StatusIDThe result of the transaction. Status 0 indicates an approved transaction.
TransactionIDThe number that identifies the transaction in the Paysafe Solutions system.
ReferenceNumberThe merchant/customer transaction identifier that was sent in the initial request.
TransactionAmountIdentifies the transaction amount that was sent in the initial request.
AuthorizationCodeAuthorization code from the issuing bank.
ResponseCodeThe approval or decline code from the processor.
ResponseMessageThe approval or decline message from the processor.
CVV2ResponseCodeThe CVV2 response code.
CVV2ResponseMessageThe CVV2 response message.
AVSResponseCodeThe AVS response code.
AVSResponseMessageThe AVS response message.
URLPostbackURL to redirect customer after sale has been posted
CardNumberIdentifies the last 4 cardholder’s account number.
CustomerNameThe name of the cardholder as it appears on the card.
BillingNameFirstThe first name of the cardholder.
BillingNameLastThe last name of the cardholder.
BillingAddressThe billing address of the cardholder. Used to check for AVS identification.
BillingCityThe billing city of the cardholder.
BillingStateThe billing state of the cardholder.
BillingZipThe billing zip code of the cardholder. Used to check for AVS identification.
BillingCountryThe billing country of the cardholder.
BillingPhoneThe phone number of the cardholder.
BillingFaxThe fax number of the cardholder
BillingEmailThe e-mail address of the cardholder.
CustomerIDAn existing customer record.
ProductDescUse to identify product name.
ActionThe action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available.
ShippingAddress1The shipping address of the cardholder.
ShippingAddress2The shipping address of the cardholder.
ShippingCityThe shipping city of the cardholder.
ShippingStateThe shipping state of the cardholder.
ShippingZipCodeThe shipping zip code of the cardholder. Used to check for AVS identification.
ShippingCountryThe shipping country of the cardholder.
Custominfo1 (1-20)For merchant use.
TransTypeIDIdentifies the type of transaction that was processed. View appendix F.
SettleDateThe date and time the transaction was settled.
VoidDateThe date and time the transaction was voided.
RefundDateThe date and time the transaction was refunded.
TransactionStatusIDIdentifies 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

Request

ParameterIs RequiredData TypeMax LengthDescription
ClerkID No String 15 The cashier/clerk who initiated the transaction.
Custominfo1 (1-20) No String 255 For merchant use.
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.
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 NameDescription
PostedDateThe date and time the transaction was posted.
StatusIDThe result of the transaction. Status 0 indicates an approved transaction.
TransactionIDThe number that identifies the transaction in the Paysafe Solutions system.
ReferenceNumberThe merchant/customer transaction identifier that was sent in the initial request.
TransactionAmountIdentifies the transaction amount that was sent in the initial request.
AuthorizationCodeAuthorization code from the issuing bank.
ResponseCodeThe approval or decline code from the processor.
ResponseMessageThe approval or decline message from the processor.
CVV2ResponseCodeThe CVV2 response code.
CVV2ResponseMessageThe CVV2 response message.
AVSResponseCodeThe AVS response code.
AVSResponseMessageThe AVS response message.
URLPostbackURL to redirect customer after sale has been posted
CardNumberIdentifies the last 4 cardholder’s account number.
CustomerNameThe name of the cardholder as it appears on the card.
BillingNameFirstThe first name of the cardholder.
BillingNameLastThe last name of the cardholder.
BillingAddressThe billing address of the cardholder. Used to check for AVS identification.
BillingCityThe billing city of the cardholder.
BillingStateThe billing state of the cardholder.
BillingZipThe billing zip code of the cardholder. Used to check for AVS identification.
BillingCountryThe billing country of the cardholder.
BillingPhoneThe phone number of the cardholder.
BillingFaxThe fax number of the cardholder
BillingEmailThe e-mail address of the cardholder.
CustomerIDAn existing customer record.
ProductDescUse to identify product name.
ActionThe action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available.
ShippingAddress1The shipping address of the cardholder.
ShippingAddress2The shipping address of the cardholder.
ShippingCityThe shipping city of the cardholder.
ShippingStateThe shipping state of the cardholder.
ShippingZipCodeThe shipping zip code of the cardholder. Used to check for AVS identification.
ShippingCountryThe shipping country of the cardholder.
Custominfo1 (1-20)For merchant use.
TransTypeIDIdentifies the type of transaction that was processed. View appendix F.
SettleDateThe date and time the transaction was settled.
VoidDateThe date and time the transaction was voided.
RefundDateThe date and time the transaction was refunded.
TransactionStatusIDIdentifies 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

ParameterIs RequiredData TypeMax LengthDescription
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 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 NameDescription
PostedDateThe date and time the transaction was posted.
StatusIDThe result of the transaction. Status 0 indicates an approved transaction.
RecurIDThe number that identifies the transaction in the Paysafe Solutions system.
ReferenceNumberThe merchant/customer transaction identifier that was sent in the initial request.
TransactionAmountIdentifies the transaction amount that was sent in the initial request.
ScheduleDescriptionA text description of the recurring payment schedule.
ScheduleDateThe date the recurring payment charge will be processed.
ResponseMessageThe 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

ParameterIs RequiredData TypeMax LengthDescription
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 NameDescription
PostedDateThe date and time the transaction was posted.
StatusIDThe result of the transaction. Status 0 indicates an approved transaction.
RecurIDThe number that identifies the transaction in the Paysafe Solutions system.
ReferenceNumberThe merchant/customer transaction identifier sent in the initial request.
TransactionAmountIdentifies the transaction amount sent in the initial request.
ScheduleDescriptionA text description of the recurring payment schedule.
ScheduleDateThe date the recurring payment charge will be processed.
ResponseMessageThe 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

ParameterIs RequiredData TypeMax LengthDescription
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 NameDescription
PostedDateThe date and time the transaction was posted.
StatusIDThe result of the transaction. Status 0 indicates an approved transaction.
TransactionIDThe number that identifies the transaction in the Paysafe Solutions system.
ReferenceNumberThe merchant/customer transaction identifier that was sent in the initial request.
TransactionAmountIdentifies the transaction amount that was sent in the initial request.
AuthorizationCodeAuthorization code from the issuing bank.
ResponseCodeThe approval or decline code from the processor.
ResponseMessageThe approval or decline message from the processor.
CVV2ResponseCodeThe CVV2 response code.
CVV2ResponseMessageThe CVV2 response message.
AVSResponseCodeThe AVS response code.
AVSResponseMessageThe AVS response message.
URLPostbackURL to redirect customer after sale has been posted
CardNumberIdentifies the last 4 cardholder’s account number.
CustomerNameThe name of the cardholder as it appears on the card.
BillingNameFirstThe first name of the cardholder.
BillingNameLastThe last name of the cardholder.
BillingAddressThe billing address of the cardholder. Used to check for AVS identification.
BillingCityThe billing city of the cardholder.
BillingStateThe billing state of the cardholder.
BillingZipThe billing zip code of the cardholder. Used to check for AVS identification.
BillingCountryThe billing country of the cardholder.
BillingPhoneThe phone number of the cardholder.
BillingFaxThe fax number of the cardholder
BillingEmailThe e-mail address of the cardholder.
CustomerIDAn existing customer record.
ProductDescUse to identify product name.
ActionThe action that can be taken on this transaction. V=Void, S=Settle, C=Credit. A blank response means no action is available.
ShippingAddress1The shipping address of the cardholder.
ShippingAddress2The shipping address of the cardholder.
ShippingCityThe shipping city of the cardholder.
ShippingStateThe shipping state of the cardholder.
ShippingZipCodeThe shipping zip code of the cardholder. Used to check for AVS identification.
ShippingCountryThe shipping country of the cardholder.
Custominfo1 (1-20)For merchant use.
TransTypeIDIdentifies the type of transaction that was processed. View appendix F.
SettleDateThe date and time the transaction was settled.
VoidDateThe date and time the transaction was voided.
RefundDateThe date and time the transaction was refunded.
TransactionStatusIDIdentifies 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

ParameterIs RequiredData TypeMax LengthDescription
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 NameDescription
PostedDateThe date and time the transaction was posted.
StatusIDThe result of the transaction. Status 1 indicates an approved transaction.
TransactionIDThe number that identifies the transaction in the Paysafe Solutions system.
ReferenceNumberThe merchant/customer transaction identifier that was sent in the initial request.
TransactionAmountIdentifies the transaction amount that was sent in the initial request.
MessageThe message from the processor.
StatusStatus Description
CustomerNameThe name of the account holder as it appears on the account
BillingNameFirstThe first name of the account holder.
BillingNameLastThe last name of the account holder.
BillingAddressThe billing address of the cardholder. Used to check for AVS identification.
BillingCityThe billing city of the account holder.
BillingStateThe billing state of the account holder.
BillingZipThe billing zip code of the account holder. Used to check for AVS identification.
BillingCountryThe billing country of the account holder.
BillingPhoneThe phone number of the account holder.
BillingFaxThe fax number of the account holder
BillingEmailAn existing customer record
CustomerIDAn existing customer record.
RoutingNumberRouting number or ABA
AccountNumberAccount Number or DDA
ActionThe action that can be taken on this transaction. V=Void,S=Settle, C=Credit. A blank response means no action is available.
TransTypeIDIdentifies the type of transaction that was processed. View appendix F.
VoidDateThe date and time the transaction was voided.
TransactionStatusIDIdentifies 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

ParameterIs RequiredData TypeMax LengthDescription
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 NameDescription
PostedDateThe date and time the transaction was posted.
StatusIDThe result of the transaction. Status 1 indicates an approved transaction.
TransactionIDThe number that identifies the transaction in the Paysafe Solutions system.
ReferenceNumberThe merchant/customer transaction identifier that was sent in the initial request.
TransactionAmountIdentifies the transaction amount that was sent in the initial request.
MessageThe message from the processor.
StatusStatus Description
CustomerNameThe name of the account holder as it appears on the account
BillingNameFirstThe first name of the account holder.
BillingNameLastThe last name of the account holder.
BillingAddressThe billing address of the cardholder. Used to check for AVS identification.
BillingCityThe billing city of the account holder.
BillingStateThe billing state of the account holder.
BillingZipThe billing zip code of the account holder. Used to check for AVS identification.
BillingCountryThe billing country of the account holder.
BillingPhoneThe phone number of the account holder.
BillingFaxThe fax number of the account holder
BillingEmailAn existing customer record
CustomerIDAn existing customer record.
RoutingNumberRouting number or ABA
AccountNumberAccount Number or DDA
ActionThe action that can be taken on this transaction. V=Void,S=Settle, C=Credit. A blank response means no action is available.
TransTypeIDIdentifies the type of transaction that was processed. View appendix F.
VoidDateThe date and time the transaction was voided.
TransactionStatusIDIdentifies 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

ParameterIs RequiredData TypeMax LengthDescription
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 NameDescription
PostedDateThe date and time the transaction was posted.
StatusIDThe result of the transaction. Status 1 indicates an approved transaction.
TransactionIDThe number that identifies the transaction in the Paysafe Solutions system.
ReferenceNumberThe merchant/customer transaction identifier that was sent in the initial request.
TransactionAmountIdentifies the transaction amount that was sent in the initial request.
MessageThe message from the processor.
StatusStatus Description
CustomerNameThe name of the account holder as it appears on the account
BillingNameFirstThe first name of the account holder.
BillingNameLastThe last name of the account holder.
BillingAddressThe billing address of the cardholder. Used to check for AVS identification.
BillingCityThe billing city of the account holder.
BillingStateThe billing state of the account holder.
BillingZipThe billing zip code of the account holder. Used to check for AVS identification.
BillingCountryThe billing country of the account holder.
BillingPhoneThe phone number of the account holder.
BillingFaxThe fax number of the account holder
BillingEmailAn existing customer record
CustomerIDAn existing customer record.
RoutingNumberRouting number or ABA
AccountNumberAccount Number or DDA
ActionThe action that can be taken on this transaction. V=Void,S=Settle, C=Credit. A blank response means no action is available.
TransTypeIDIdentifies the type of transaction that was processed. View appendix F.
VoidDateThe date and time the transaction was voided.
TransactionStatusIDIdentifies 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

ParameterIs RequiredData TypeMax LengthDescription
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 NameDescription
PostedDateThe date and time the transaction was posted.
StatusIDThe result of the transaction. Status 1 indicates an approved transaction.
TransactionIDThe number that identifies the transaction in the Paysafe Solutions system.
ReferenceNumberThe merchant/customer transaction identifier that was sent in the initial request.
TransactionAmountIdentifies the transaction amount that was sent in the initial request.
MessageThe message from the processor.
StatusStatus Description
CustomerNameThe name of the account holder as it appears on the account
BillingNameFirstThe first name of the account holder.
BillingNameLastThe last name of the account holder.
BillingAddressThe billing address of the cardholder. Used to check for AVS identification.
BillingCityThe billing city of the account holder.
BillingStateThe billing state of the account holder.
BillingZipThe billing zip code of the account holder. Used to check for AVS identification.
BillingCountryThe billing country of the account holder.
BillingPhoneThe phone number of the account holder.
BillingFaxThe fax number of the account holder
BillingEmailAn existing customer record
CustomerIDAn existing customer record.
RoutingNumberRouting number or ABA
AccountNumberAccount Number or DDA
ActionThe action that can be taken on this transaction. V=Void,S=Settle, C=Credit. A blank response means no action is available.
TransTypeIDIdentifies the type of transaction that was processed. View appendix F.
VoidDateThe date and time the transaction was voided.
TransactionStatusIDIdentifies 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

ParameterIs RequiredData TypeMax LengthDescription
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 NameDescription
PostedDateThe date and time the transaction was posted.
StatusIDThe result of the transaction. Status 1 indicates an approved transaction.
TransactionIDThe number that identifies the transaction in the Paysafe Solutions system.
ReferenceNumberThe merchant/customer transaction identifier that was sent in the initial request.
TransactionAmountIdentifies the transaction amount that was sent in the initial request.
MessageThe message from the processor.
StatusStatus Description
CustomerNameThe name of the account holder as it appears on the account
BillingNameFirstThe first name of the account holder.
BillingNameLastThe last name of the account holder.
BillingAddressThe billing address of the cardholder. Used to check for AVS identification.
BillingCityThe billing city of the account holder.
BillingStateThe billing state of the account holder.
BillingZipThe billing zip code of the account holder. Used to check for AVS identification.
BillingCountryThe billing country of the account holder.
BillingPhoneThe phone number of the account holder.
BillingFaxThe fax number of the account holder
BillingEmailAn existing customer record
CustomerIDAn existing customer record.
RoutingNumberRouting number or ABA
AccountNumberAccount Number or DDA
ActionThe action that can be taken on this transaction. V=Void,S=Settle, C=Credit. A blank response means no action is available.
TransTypeIDIdentifies the type of transaction that was processed. View appendix F.
VoidDateThe date and time the transaction was voided.
TransactionStatusIDIdentifies 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

ParameterIs RequiredData TypeMax LengthDescription
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 NameDescription
PostedDateThe date and time the transaction was posted.
StatusIDThe result of the transaction. Status 1 indicates an approved transaction.
TransactionIDThe number that identifies the transaction in the Paysafe Solutions system.
ReferenceNumberThe merchant/customer transaction identifier that was sent in the initial request.
TransactionAmountIdentifies the transaction amount that was sent in the initial request.
MessageThe message from the processor.
StatusStatus Description
CustomerNameThe name of the account holder as it appears on the account
BillingNameFirstThe first name of the account holder.
BillingNameLastThe last name of the account holder.
BillingAddressThe billing address of the cardholder. Used to check for AVS identification.
BillingCityThe billing city of the account holder.
BillingStateThe billing state of the account holder.
BillingZipThe billing zip code of the account holder. Used to check for AVS identification.
BillingCountryThe billing country of the account holder.
BillingPhoneThe phone number of the account holder.
BillingFaxThe fax number of the account holder
BillingEmailAn existing customer record
CustomerIDAn existing customer record.
RoutingNumberRouting number or ABA
AccountNumberAccount Number or DDA
ActionThe action that can be taken on this transaction. V=Void,S=Settle, C=Credit. A blank response means no action is available.
TransTypeIDIdentifies the type of transaction that was processed. View appendix F.
VoidDateThe date and time the transaction was voided.
TransactionStatusIDIdentifies 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

ParameterIs RequiredData TypeMax LengthDescription
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 NameDescription
PostedDateThe date and time the transaction was posted.
StatusIDThe result of the transaction. Status 1 indicates an approved transaction.
TransactionIDThe number that identifies the transaction in the Paysafe Solutions system.
ReferenceNumberThe merchant/customer transaction identifier that was sent in the initial request.
TransactionAmountIdentifies the transaction amount that was sent in the initial request.
MessageThe message from the processor.
StatusStatus Description
CustomerNameThe name of the account holder as it appears on the account
BillingNameFirstThe first name of the account holder.
BillingNameLastThe last name of the account holder.
BillingAddressThe billing address of the cardholder. Used to check for AVS identification.
BillingCityThe billing city of the account holder.
BillingStateThe billing state of the account holder.
BillingZipThe billing zip code of the account holder. Used to check for AVS identification.
BillingCountryThe billing country of the account holder.
BillingPhoneThe phone number of the account holder.
BillingFaxThe fax number of the account holder
BillingEmailAn existing customer record
CustomerIDAn existing customer record.
RoutingNumberRouting number or ABA
AccountNumberAccount Number or DDA
ActionThe action that can be taken on this transaction. V=Void,S=Settle, C=Credit. A blank response means no action is available.
TransTypeIDIdentifies the type of transaction that was processed. View appendix F.
VoidDateThe date and time the transaction was voided.
TransactionStatusIDIdentifies 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

ParameterIs RequiredData TypeMax LengthDescription
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 NameDescription
PostedDateThe date and time the transaction was posted.
StatusIDThe result of the transaction. Status 1 indicates an approved transaction.
TransactionIDThe number that identifies the transaction in the Paysafe Solutions system.
ReferenceNumberThe merchant/customer transaction identifier that was sent in the initial request.
TransactionAmountIdentifies the transaction amount that was sent in the initial request.
MessageThe message from the processor.
StatusStatus Description
CustomerNameThe name of the account holder as it appears on the account
BillingNameFirstThe first name of the account holder.
BillingNameLastThe last name of the account holder.
BillingAddressThe billing address of the cardholder. Used to check for AVS identification.
BillingCityThe billing city of the account holder.
BillingStateThe billing state of the account holder.
BillingZipThe billing zip code of the account holder. Used to check for AVS identification.
BillingCountryThe billing country of the account holder.
BillingPhoneThe phone number of the account holder.
BillingFaxThe fax number of the account holder
BillingEmailAn existing customer record
CustomerIDAn existing customer record.
RoutingNumberRouting number or ABA
AccountNumberAccount Number or DDA
ActionThe action that can be taken on this transaction. V=Void,S=Settle, C=Credit. A blank response means no action is available.
TransTypeIDIdentifies the type of transaction that was processed. View appendix F.
VoidDateThe date and time the transaction was voided.
TransactionStatusIDIdentifies the status of the transaction that was processed. View appendix G.

ACHRecurringDebitUpdate

Description: This method updates a recurring ACH debit transaction rule.

Resource Url: https://webservice.paymentxp.com/wh/WebHost.aspx

Method: POST

Request

ParameterIs RequiredData TypeMax LengthDescription
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.
IsEnabled No Number 1 0=Disable, 1=Enable Recurring Rule
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
RecurID Yes Number 10 The Rule ID assigned to the original rule.
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 NameDescription
PostedDateThe date and time the transaction was posted.
StatusIDThe result of the transaction. Status 1 indicates an approved transaction.
TransactionIDThe number that identifies the transaction in the Paysafe Solutions system.
ReferenceNumberThe merchant/customer transaction identifier that was sent in the initial request.
TransactionAmountIdentifies the transaction amount that was sent in the initial request.
MessageThe message from the processor.
StatusStatus Description
CustomerNameThe name of the account holder as it appears on the account
BillingNameFirstThe first name of the account holder.
BillingNameLastThe last name of the account holder.
BillingAddressThe billing address of the cardholder. Used to check for AVS identification.
BillingCityThe billing city of the account holder.
BillingStateThe billing state of the account holder.
BillingZipThe billing zip code of the account holder. Used to check for AVS identification.
BillingCountryThe billing country of the account holder.
BillingPhoneThe phone number of the account holder.
BillingFaxThe fax number of the account holder
BillingEmailAn existing customer record
CustomerIDAn existing customer record.
RoutingNumberRouting number or ABA
AccountNumberAccount Number or DDA
ActionThe action that can be taken on this transaction. V=Void,S=Settle, C=Credit. A blank response means no action is available.
TransTypeIDIdentifies the type of transaction that was processed. View appendix F.
VoidDateThe date and time the transaction was voided.
TransactionStatusIDIdentifies the status of the transaction that was processed. View appendix G.

ACH Batch File Upload Interface

To use this interface option, all transaction data must be correctly formatted and saved in a batch file. Batch files can be formatted as either comma-delimited or NACHA (fixed width). 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:

  1. Create a test batch file
  2. Send the test file to Paysafe' FTP server
  3. Notify Paysafe' Integration Department that the file has been uploaded
  4. Our developer will validate the batch file by running it against a test database
  5. 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

The following guidelines shall be used for formatting transaction data sent in a comma-delimited batch file.

Parameter Type Length Description
*Description Text 10 Purpose of transaction. Description is required for ACH. This field shows up on customer’s bank statement.
*Trans Code Text 2 27= Debit to checking account, 37= Debit to savings account
*ABA Expire Text 9 Routing Number or ABA
*Account No Text 17 Account Number or DDA
*Account Name Text 22 Name on account
Ref ID Text 50 User’s unique reference ID (Invoice #, Order # or Acct. No.)
*Amount Numeric 8 Transaction Amount (with decimal point)
*SECC Code Text 3 NACHA SECC Code indicating type of transaction. Example: PPD = Business to consumer transaction CCD = Business to business
*Company Name Text 16 Source of the entry or merchant name

Note: Transaction data included in the batch file must be in comma-delimited format with quoted text, as follows. Please remove any spaces before and after the comma delimiter.

Sample business to consumer transaction
Checking Account Sample: "Fees","27","123456789","123456","John Doe","1475","140.25","PPD","Company 1"
Savings Account Sample: "Fees","37","123456789","123456","John Doe","1475","140.25"," PPD ","Company 1"
Sample business to business transaction
Checking Account Sample: "Fees","27","123456789","123456","John Doe","1475","140.25","CCD","Company 1"
Savings Account Sample: "Fees","37","123456789","123456","John Doe","1475","140.25","CCD","Company 1"

File Naming Convention - The batch file should be saved with an .ach file extension using the following naming convention.

File Name Description
YYMMDDNN.ACH

YY = Year, MM = Month, DD = Day & NN = Batch No

Example: 04111401.ach 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.

Batch File - NACHA Format

The following guidelines shall be used for formatting transaction data sent in a NACHA formatted batch file.

File Header Record
No. Field Name Field Size Field Content
1 Record Type 1 ‘1’
2 Priority Code 2 Leave blank
3 Immediate Destination 10 Leave blank
4 Immediate Origin 10 Merchant name
5 Transmit/File Create Date 6 Leave blank
6 Transmit/File Create Time 4 Leave blank
7 File Id Modifier 1 Leave blank
8 Record Size 3 ‘094’
9 Blocking Factor 2 ‘10’
10 Format Code 1 ‘1’
11 Destination Name 23 Leave blank
12 Origin Name 23 Leave blank
13 Reference Code 8 Leave blank
Batch Header Record
No. Field Name Field Size Field Content
1 Record Type 1 ‘5’
2 Service Class Code 3 Leave blank
3 Company Name 16 Merchant name
4 Company Discretionary Data 20 Discretionary Data
5 Company ID 10 Merchant ID
6 Standard Entry Class Code 3 PPD or CCD
7 Company Entry Description 10 Purpose of the transaction
8 Company Descriptive Date 6 Description Date
9 Effective Entry Date 6 Leave blank
10 Settlement Date (Julian) 3 ‘1’
11 Originator Status Code 1 Leave blank
12 Originating DFI Identification 8 Leave blank
13 Batch Number 7 Batch Number
Entry Detail Record
No. Field Name Field Size Field Content
1 Record Type 1 ‘6’
2 Transaction Code 2 27= Debit CK, 37= Debit SA
3 Receiving DFI Identification 8 ABA Digits 1 to 8
4 Check Digit 1 ABA Digit 9
5 Account Number 17 Account Number (Checking or Savings)
6 Amount 10 Transaction Amount (No decimal point)
7 Individual Identification Number 15 Leave blank
8 Individual Name 22 Name on account (Checking or Savings)
9 Discretionary Data 2 Leave blank
10 Addenda Record Identification 1 ‘1’ if there is addenda record
11 Trace Number 15 Unique reference number
Batch Footer Record
No. Field Name Field Size Field Content
1 1 ‘8’
2 Service Class Code 3 ‘200’
3 Entry Addenda Count 6 Count of detail and addenda records
4 Entry Hash 10 Leave blank
5 Total Debit Amount 12 Sum of debit amount
6 Total Credit Amount 12 Sum of credit amount
7 Company Identification 10 Merchant ID
8 Message Authentication Code 19 Leave blank
9 Reserved 6 Leave blank
10 Originating DFI Identification 8 Leave blank
11 Batch Number 7 Batch Number
File Footer Record
No. Field Name Field Size Field Content
1 Record Type 1 ‘9’
2 Batch Count 6 Number of batches
3 Block Count 6 Leave blank
4 Entry Addenda Count 8 Count of detail records
5 Entry Hash 10 Leave blank
6 Total Debit Amount in File 12 Sum of debit amount in file
7 Total Credit Amount in File 12 Sum of credit amount in file
8 Reserved 39 Leave blank

Sample NACHA File:

File Naming Convention - The batch file should be saved with a .nac file extension using the following naming convention.

File Name Description
YYMMDDNN.NAC YY = Year, MM = Month, DD = Day & NN = Batch No
Example: 04111401.nac 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 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
Reason Text 100 Reject reason
Addenda Information Text 100 Explanatory Information related to a reject

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: 04111401.rsp Year=2004, Month=11, Day=14 & Batch Number=01

Sample response file
"113000","140.25","12345678","Declined","Voided Transaction"

Return File Format

Parameter Type Length Description
RefID Text 50 Merchant’s unique reference number
TransID Numeric 10 Unique Key assigned by Paysafe
Amount Numeric 8 Amount of sale
Return Code Text 3 R01, R02, C01, etc.
Return Reason Text 100 NSF, Account Close etc.
Account Type Text 2 CK - Checking Account and SA - Savings Account
Trans Type Text 2 27, 22, 37, 32
Corrected Account# Text 17 Corrected checking or savings account number (ifapplicable)
Corrected Trans Route# Text 9 Corrected routing number (if applicable)

File Naming Convention - The return file will have an .rtn file extension using the following naming convention.

File Name Description
YYMMDDNN.RTN YY = Year, MM = Month, DD = Day & NN = Batch No
Example: 04111401.rtn Year=2004, Month=11, Day=14 & Batch Number=01

Sample Return file
"113000","12345678","40.25","R01","NSF","CK","27","122000661","123654789"

Customer Vault

AddCustomer

Description: Use this function to add a new customer record. Below are the parameters for this method.

Resource Url: https://webservice.paymentxp.com/wh/WebHost.aspx

Method: POST

Request

ParameterIs RequiredData TypeMax LengthDescription
AccountName No String 50 Your customer's name on account (First name + Last name)
AccountNumber No String 17 Your customer's Bank Account Number without space orhyphen
Address No String 50 Your customer's address
BankAccountType No String 2 Your customer's Bank Account Type: CK = Checking Account SA = Savings Account
BankName No String 50 Your customer's bank name
CardExpirationDate No Number 4 Your customer's card expiration date
CardNumber No Number 60 Your customer's credit number
City No String 50 Your customer's city
Country No String 50 Your customer's country
CustomerID Yes String