(c) PCI Pal 2020. The content on this page is subject to the Disclaimer Section (found on the Introduction page)
PayFabric Payment Gateway
This page details the inputs, secure inputs and outputs available for the PayFabric Payment Gateway, how to complete each field, and an external link to the PayFabric Payment Gateway integration documentation.
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
deviceId
Yes
NA
Acts as a username for PayFabric to create a security token that is used to authenticate requests
devicePassword
Yes
NA
Acts as a password for PayFabric to create a security token that is used to authenticate requests
setupId
Yes
64 char
Gateway account profile name. This name is configurable and is defined by the client on the PayFabric web portal.
amount
Yes
decimal
Transaction amount, only accept 2 decimals.
customer
No
128 char
Customer ID as specified by the client upon creation of the customer.
currency
Yes
16 char
Currency code, such as USD.
trxUserDefine1
No
256 char
User Defined field 1
trxUserDefine2
No
256 char
User Defined field 2
trxUserDefine3
No
256 char
User Defined field 3
trxUserDefine4
No
256 char
User Defined field 4
payDate
No
MDDYYYY
A future date to process this transaction. In another word, this transaction won't be processed right away by setting this field. It's format should like "3/23/2015".
cardName
No
16 char
Type of credit card: Visa, Mastercard, Discover,JCB,AmericanExpress,DinersClub. Only valid for credit cards.
cardIsDefault
No
bool
Indicates whether this is the primary card of the customer. Default value is False.
cardIsLocked
No
bool
Indicates whether the card is locked. Default value is False.
saveCard
No
bool
Indicates whether to save this card in the customer's wallet. This attribute is only valid and should only be included in the object when using Create and Process a Transaction.
cardIdentifier
No
32 char
A client-defined identifier for this card. Developer can send a flag value to identify this card
cardUserDefine1
No
256 char
User-defined field 1 for the card object. Additional data can be stored in this field.
cardUserDefine2
No
256 char
User-defined field 2 for the card object. Additional data can be stored in this field.
cardUserDefine3
No
256 char
User-defined field 3 for the card object. Additional data can be stored in this field.
cardIssueNumber
No
64 char
Issue number for the card, if applicable. This field is required for UK debit cards
cardStartDate
No
4 char
This field is required for UK debit cards, format is MMYY.
newCustomerNumber
No
128 char
This field is used to submit new customer number for updating this record's customer field.
cardHolderFirstName
Yes
64 char
First name for the card holder
cardHolderMiddleName
No
64 char
Middle name for the card holder
cardHolderLastName
Yes
64 char
Last name for the card holder
billingCountry
Yes (C)*
64 char
Country name
billingState
No
64 char
State name
billingCity
Yes (C)*
64 char
City name
billingLine1
Yes (C)*
128 char
Street line 1
billingLine2
No
128 char
Street line 2
billingLine3
No
128 char
Street line 3
billingEmail
No
128 char
Email address
billingPhone
No
16 char
Phone number
billingZip
Yes (C)*
16 char
Zip code
shippingCountry
Yes (C)*
64 char
Country name
shippingState
No
64 char
State name
shippingCity
Yes (C)*
64 char
City name
shippingLine1
Yes (C)*
128 char
Street line 1
shippingLine2
No
128 char
Street line 2
shippingLine3
No
128 char
Street line 3
shippingEmail
No
128 char
Email address
shippingPhone
No
16 char
Phone number
shippingZip
Yes (C)*
16 char
Zip code
type
Yes
64 char
Transaction type. Valid values are Sale,Book,Ship,Void,Credit, Force.
* (C) Conditional - if the billing or shipping detials are provided at all then all of the fields become mandatory.
Secure Inputs
Input Fields
Required
Character Limits/Required Input
Description
cardNumber
Yes
19 char
Secure Input of the Card Number
cardExpiryDate
Yes
4 char
Secure Input of the Card Expiry - in the format MMYY
cardSecurityCode
Yes
3 or 4 char
Secure Input of the Card CVN, either three or four digits long depending on the card.
Outputs
Output Fields
Description
connectionName
Gateway account profile name.
connector
PayFabric gateway connector name.
connProcessorId
Bank processor ID.
connProcessor
Bank processor name.
connPaymentTypeId
ID relating to the payment type.
connPaymentType
Transaction type. The possible values are Sale,Book,Ship,Void,Credit,Force.
transactionPost
transactionType
Transaction type. Valid values are Sale,Book,Ship,Void,Credit, Force.
transactionStatus
Status of transaction. Generated by the Payment Gateway. Possible values are Approved, Denied, Declined, Failure, AVSFailure, and More Info.
avsAddressResponse
Verification status code of billing address. Generated by the Payment Gateway.
avsZipResponse
Verification status code of zip code. Generated by the Payment Gateway.
authCode
Authorization code. Generated by the Payment Gateway.
cvv2Response
Verification status code of CVC code. Generated by the Payment Gateway.
iAVSAddressResponse
Flag indicating that address verification has been ignored because the address is an international address. Generated by the Payment Gateway.
message
Result message of the transaction. Generated by the Payment Gateway.
originationId
Unique identifier for the transaction. Generated by the Payment Gateway.
payFabricErrorCode
respTrxTag
A tag value which is generated by FirstData, which must be included when submitting a transaction to FirstData. This is only valid if FirstData GGe4 is the Payment Gateway.
resultCode
Result code of the transaction. Generated by the Payment Gateway.
status
Status of transaction. Generated by the Payment Gateway. Possible values are Approved, Denied, Declined, Failure, AVSFailure, and More Info.
trxDate
Date of transaction. It's format should like "3/23/2015 11:16:19 PM".
trxKey
PayFabric transaction key. This is generated by PayFabric upon creation of the transaction.
TAXml
tokenResult
Result code of the transaction. Generated by the Payment Gateway.
errorMessage
Error message returned by PayFabric, if applicable
Further information can be found by viewing the integration documentation:
