Paysafe

This page details the inputs, secure inputs and outputs available for thePaysafe Logic Item, how to complete each field.

PCI Pal must check any payment gateway integrations prior to going live. The documentation disclaimer (which applies throughout this guide) should be read before commencing any configuration of payment gateways.

Inputs

Input Fields	Required	Character Limits/Required Input	Description
accountid	Yes	N/A	Merchant account number.
keyUsername	Yes	20 AN	API username given to the client by the gateway
keyPassword	Yes	n/a	Password that corresponds to the username
transactionType	Yes	n/a	The transaction type: - auth - verify - token
merchantRefNum	Yes	255 Char	This is the merchant reference number created by the merchant and submitted as part of the request
amount	Yes	99999999999 Numeric	Amount of the request, in minor units
customerFirstname	No	80 AN	Customer's last name.
customerLastname	No	80 AN	Customer's last name.
customerEmail	No	255 AN	Customer's email address.
billingStreet	No	50 AN	First line of the street address in the billing address
billingStreet2	No	50 AN	Second line of the street address in the billing address, if required (e.g., apartment number).
billingCity	No	40 AN	City in the billing address.
billingState	No	40 AN	Province Codes or State Codes for Canada or the United States
billingCountry	No	2 Char	2 letter country code
billingZip	No	10 AN	Postal/zip code in the billing address.
billingPhone	No	40 AN	Customer's telephone number.
shippingRecipientName	No	255 AN	Name of the person receiving the goods.
shippingStreet	No	50 AN	Recipient's street address.
shippingCity	No	40 AN	City in which the recipient resides.
shippingState	No	40 AN	Province Codes or State Codes for Canada or the United States.
shippingCountry	No	2 Char	2 Letter Country Code
shippingZip	No	10 AN	Postal/zip code in the recipients address.
dynamicDescriptor	No	20 AN	Merchant descriptor that will be displayed on a customer’s card statement.
merchantPhone	No	40 Numeric	Merchant's telephone number.
description	No	255 AN	Description of the transaction, provided by the merchant.
recipientBirthDay	No	2 Numeric	Recipient's date of birth.
recipientBirthMonth	No	2 Numeric	Month of birth.
recipientBirthYear	No	4 Numeric	Year of birth.
recipientZip	No	10 AN	Recipient's postcode.
recipientLastname	No	255 AN	Recipient's last name.
accountNumber	No	25 Numeric	Recipient's account number, e.g., a loan agreement number or customer ID.
exemptLocalTax	No	true or false	Indicates whether or not local tax is exempted for the request - true - false
localTaxAmount	No	99999999999 Numeric	Local sales tax applied to the purchase.
nationalTaxAmount	No	99999999999 Numeric	National tax included in the transaction amount.
freightAmount	No	99999999999 Numeric	Freight or shipping portion of the total transaction amount.
dutyAmount	No	99999999999 Numeric	Duty associated with the import of the purchased goods.
destinationZip	No	10 AN	The postal/zip code of the address to which the purchased goods will be delivered. This field can be identical to the shipFromZip if the customer is present and takes immediate possession of the goods
destinationCountry	No	2 Char	Country to which the goods are being shipped.
shipFromZip	No	10 AN	Postal/zip code of the address from which the purchased goods are being shipped.
lineItemsDescription	No	50 AN	Description of the item(s) being purchased.
lineItemsProductCode	No	12 Numeric	Merchant-defined description code of the item being purchased.
lineItemsQuantity	No	99999999999 Numeric	Quantity of the item.
lineItemsUnitAmount	No	99999999999 Numeric	Unit price of the item being purchased, in minor units. The currency will be based on the account setting.
lineItemsTaxRate	No	100 Numeric	Tax rate used to calculate the tax amount.
lineItemsTaxAmount	No	99999999999 Numeric	Amount of any value-added taxes that can be associated with the purchased item, in minor units.
lineItemsTotalAmount	No	99999999999 Numeric	Total amount of the line item, typically calculated as price multiplied by quantity, in minor units.
settleWithAuth	No	true or false	Indicates whether the request is an Authorization only (no Settlement), or a Purchase (Authorization and Settlement). Default = false
tokenMerchantCustomerId	No	100 AN	Customer ID that the merchant provides with the request for their own internal customer identification. This value must be unique for each customer belonging to a merchant. In NETBANX this is known as the Ref ID.
tokenLocale	No	6 AN	Indicates the language of the profile. Possible values are: - en_US - fr_CAe - n_GB
tokenFirstname	No	80 AN	Customer’s first name
tokenMiddlename	No	80 AN	Customer’s middle name
tokenLastname	No	80 AN	Customer’s last name
tokenEmail	No	255 Char	Customer's email address
tokenPhone	No	40 Numeric	Customer's phone number
tokenGender	No	1 Char	Customer’s gender. Possible values are: - M (male) - F (female)
tokenNationality	No	30 Char	Customer’s nationality
tokenCellPhone	No	40 Numeric	Customer's cell phone number
tokenNickname	No	50 AN	Alias defined by the customer for the bank account (e.g., "First Bank account")
tokenHolderName	No	22 Char	Name of the customer or company that owns the bank account.

Secure Inputs

Input Fields	Required	Character Limits/ Required Input	Description
cardNumber	Yes	19 chars	Secure input of the card number
cardExpDate	Yes	4 chars	Secure input of the card expiry - in the format MMYY
cardCvd	Yes	3 or 4 chars	Secure input of the card CVV, either three or four digits long depending on the card

Outputs

Output Fields	Description
rspId	Transaction ID
rspMerchantRefNum	Reference number to the transaction unique to the merchant
rspTxnTime	Time to make the transaction
rspStatus	Status of the transaction
rspAmount	Order amount
rspSettleWithAuth	Whether or not the transaction is a settle with auth
rspPreAuth	Whether or not the transaction is an auth
rspAvailableToSettle	Whether the transaction is available to settle
rspCardType	Card type
rspCardLastDigits	Explanation of the error code
rspCardExpiryMonth	Card expiry month
rspCardExpiryYear	Card expiry year
rspAuthCode	This is the authorization code assigned by the issuing bank and returned by Paysafe for the transaction.
rspCustomerFirstname	Customer first name
rspCustomerLastname	Customer last name
rspCustomerEmail	Customer email address
rspBillingStreet	Billing Street
rspBillingStreet2	Billing Street 2
rspBillingCity	Billing City
rspBillingState	Billing State
rspBillingCountry	Billing Country
rspBillingZip	Billing Zip/Postcode
rspBillingPhone	Billing Phone Number
rspShippingName	Shipping Name
rspShippingStreet	Shipping Street Address
rspShippingCity	Shipping City Address
rspShippingState	Shipping State Address
rspShippingCountry	Shipping Country
rspShippingZip	Shipping Zip/Postcode
rspMerchantDynamicDescriptor	Merchant Description
rspMerchantPhone	Merchant Phone Number
rspl2l3ExemptLocalTax	Whether the transaction is exempt from tax or not
rspl2l3LocalTaxAmount	Local Tax Amount
rspl2l3NationalTaxAmount	National Tax Amount
rspl2l3FreightAmount	Freight Amount
rspl2l3DutyAmount	Duty Amount
rspl2l3ShipFromZip	The postal/zip code of the address from which the purchased goods are being shipped
rspl2l3DestinationZip	The postal/zip code of the address to which the purchased goods will be delivered. This field can be identical to the shipFromZip if the customer is present and takes immediate possession of the goods
rspl2l3DestinationCountry	Country to which the goods are being shipped
rspDescription	Description of the item(s) being purchased
rspCurrencyCode	Currency Code for the transaction
rspAvsResponse	AVS Response Code
rspCvvVerification	CVV Verification Response Code
rspSettlementId	Settlement ID
rspSettlementMerchantRefNum	Settlement Merchant Reference Number
rspSettlementTxnTime	Settlement Transaction Time
rspSettlementStatus	Settlement Status
rspSettlementAmount	Settlement Amount
rspSettlementAvailableToRefund	Whether or not the settlement is available to refund
rspRecipientDateOfBirthDay	Recipient Date of Birth Day
rspRecipientDateOfBirthMonth	Recipient Date of Birth Month
rspRecipientDateOfBirthYear	Recipient Date of Birth Year
rspRecipientZip	Receipient Zip code
rspRecipientLastname	Recipient Last Name
rspRecipientAccountNumber	Recipient Account Number
rspErrorCode	Error Code for the payment from Paysafe
rspErrorMessage	Error Message for the payment from Paysafe
rspToken	Token back from a tokenisation request
rspTokenMerchantCustomerId	Merchant Customer ID from a token request
rspTokenLocale	Token request locale/region from the token request
rspTokenFirstname	Token request first name
rspTokenMiddlename	Token request middle name
rspTokenLastname	Token request surname
rspTokenEmail	Token request email address
rspTokenPhone	Token request phone number
rspTokenGender	Token request gender
rspTokenNationality	Token request nationality
rspTokenCellPhone	Token request mobile number
errorMessage	PCI Pal Specific Error Message. If anything goes wrong in the sending of a request, our internal error handling will respond with a message on the output of the flow

Paysafe Logic Item

The Paysafe Logic Item contains the following properties:

Acvcount ID

Account ID given to the client by Paysafe

Top

Key Username

API User name given to the client by Paysafe

Top

Key Password

Password given to the client by Paysafe

Top

Success Status Code

Each gateway has its own unique selection of status codes on a request back from the gateway - for Paysafe, this is: COMPLETED,ACTIVE

Top

Select Endpoint

For added security the Paysafe endpoints have been hardcoded into the integration. Test or Live needs to be selected from the Select Endpoint drop down list, depending on the transaction being conducted

Top

For more details, please contact support@pcipal.com, and ask for a copy of the integration documentation for Paysafe.