String ProcessRequest(string requestMsg)

(http://url/PaymentService/RequestHandler.svc)

This access method accepts a base64 encoded XML formatted request message and returns a base64 encoded XML formatted response.

string ProcessMessage

(https://url/PaymentService/Default.aspx)

This access method accepts an HTML formatted query string with parameters and returns an HTML formatted response, transformed by a client selected XSLT transform.

string AcquirePurchaseToken(string userName, string password, string certificationId, int transactionAmount, string purchaserInfo, string transactionInfo)

(https://url/PaymentService/ActionService.svc)

This access method accesses specific parameters to pre-authenticate a purchase. When used, the non-sensitive details of a transaction are used to create a one-time purchase token that can be sent with the transaction request. A GUID
defining the purchase token is returned upon a successful request.

Response ProcessCreditCard(string UserName, string TransType, string CardNum, string ExpDate, string MagData, string NameOnCard, string Amount, string InvNum, string PNRef, string ZIP, string Street, string CVNum, string ExtData)

(https://url/PaymentService/TPIRequestHandler.asmx)

This access method provides limited functionality for migrating from the legacy TPI gateway to the new BridgePay gateway. This method must not be used for new integrations, especially for those interested in using EMV.

001

004

005

007

011

012

013

014

019

020

099

Mastercard

5439750001500347

12/29

999

Visa

4005550000000019

12/29

999

Discover

60011111111111117

12/29

999

Diners

36999999999999

12/29

999

AMEX

374255312721002

12/29

9999

R

ClientIdentifier

string

50

BridgeComm requires the Idenitfier value to be set to ‘SOAP’.

Ex: <ClientIdentifier>SOAP</ClientIdentifier>

R

TransactionID

string

60

Unique value to identify the transaction. Generated by the integrating application.

R

RequestType

integer

3

Identifies the type of request message submitted. Valid values are:

• 001 – Multi-Use Card Token Request

• 004 – Authorization/Sale Request

• 005 – BIN Lookup Request

•  007 – Update Password Request

•  011 – Get Merchant Info

•  012 – Void/Refund

•  014 – Manage Gift Card Request

•  019 – Capture

•  020 – Initiate Settlement

•  099 – Ping

R

RequestDateTime

integer

19

The date and time the request was sent. The default format is YYYYMMDDHHMMSS using military time. This format can be overridden using the validationFormat attribute.

R

User

string

150

Provided by BridgePay. Not required when consuming a Purchase Token.

R

Password

string

225

Initially provided by BridgePay. Not required when consuming a Purchase Token.

R

requestMessage

string

n/a

XML-formatted request message string. Required for ProcessRequest only. (See Section 2.2 for details)

R

TransactionID

string

60

BridgeComm echoes back the TransactionID value from the request message.

R

RequestType

integer

3

BridgeComm echoes back the RequestType value from the request message. See 2.1.1 for valid values.

R

ResponseCode

integer

5

The five-digit response code describing the results of the transaction. See Appendix A.1 for valid values.

R

ResponseDescription

string

n/a

The description of the ResponseCode. See Appendix A.1 for details.

R

responseMessage

string

n/a

XML-formatted response message string. Provided by ProcessRequest only. See Section 2.2 for details.

R

MerchantCode

numeric

Provided by MyBridgePay at the time of boarding. The element is optional based on the client's merchant lookup solution (See Section 1.6)

R

MerchantAccountCode

numeric

Provided by MyBridgePay at the time of boarding. The element is optional based on the client's merchant lookup solution (See Section 1.6)

1

PaymentAccountNumber

string

13-19

Credit card number. Required for keyed transactions.

1

ExpirationDate

string

7

Credit card’s expiration date Supported format are: MMYY and MM/YY. Required for keyed transactions.

O

SecureFormat

string

When present, indicates the format to use for decrypting the track data.

O

BDKSlot

integer

When present, indicates the Base Derived Key slot to use as an override for Hardware Decryption.

O

Track1

string

Required for swiped transactions to qualify for best rate. When present, can contain alphanumeric characters and spaces, periods, slashes (/), percent symbols (%), caret symbols (^), question marks (?), semicolons (;), equality symbols (=) or hyphens (-). Can use hardware encryption. Validated against acceptable characters in card swipe, as above. Can use hardware encryption.

O

Track2

string

Required for all swiped transactions. When present, can contain alphanumeric characters and spaces, periods, slashes (/), percent symbols (%), caret symbols (^), question marks (?), semicolons (;), equality symbols (=) or hyphens (-). Can use hardware encryption. Validated against acceptable characters in card swipe, as above. Can use hardware encryption.

O

Track3

string

Optional; used for encryption. When present, can contain alphanumeric characters and spaces, periods, slashes (/), percent symbols (%), caret symbols (^), question marks (?), semicolons (;), equality symbols (=) or hyphens (-). Can use hardware encryption. Validated against acceptable characters in card swipe, as above. Can use hardware encryption.

O

EncryptionID

string

The encryption ID identifying the type of encryption used on the sensitive card holder data. See 2.2.4 Generate Encryption Key Request.

O

DeviceMake

string

40

Manufacturer of terminal used. May contain any of the following characters: a-z, A-Z, 0-9, spaces, periods, dashes, or slashes (\).

O

DeviceModel

string

40

Model number of terminal used. May contain any of the following characters: a-z, A-Z, 0-9, spaces, periods, dashes or slashes (\).

O

DeviceSerial

string

40

Serial number of terminal used. May contain any of the following characters: a-z, A-Z, 0-9, spaces, periods, equal sign, hashtags, dashes or slashes (\).

O

DeviceFirmware

string

50

Firmware version number of terminal used. May contain any of the following characters: a-z, A-Z, 0-9, spaces, periods, equal sign, dashes or slashes (\).

O

RegistrationKey

string

10

Reseller / Partner registration key for PayGuardian. May contain any of the following characters: a-z, A-Z, 0-9, spaces, periods, dashes or slashes (\).

O

AppHostMachineld

string

36

GUID that identifies the HOST machine for the terminal.

O

IntegrationMethod

string

6

Identifies the PayGuardian integration method. Acceptable values are: REST, DLL, FILE, AA, SDK, VT, REST-H, DLL-H, FILE-H

O

OriginatingTechnologySource

string

N/A

Name of software transmitting the transaction.

R

SoftwareVendor

string

N/A

Name of vendor that developed the software used in transmitting the transaction. May only contain the following characters: a-z, A-Z, 0-9, spaces, and dashes.

O

SecurityTechnology

string

N/A

Security packaged used in decrypting the hardware encrypted data.

R

Token

integer

22

The token to be used for authorization. Note that the last four digits of the Token are the last four digits of the card number.

R

Amount

integer

8

The amount requested for authorization. Processed as implied decimal. $1.25 would be represented as 125.

R

TransactionType

string

11

Can contain letters and hyphens. Possible values: sale, sale-auth, credit, credit-auth, increment, sale-info, credit-info, adjustment

R

TransIndustryType

string

2

Must either match a 2-letter industry type for credit cards or a 3-letter SEC code for ACH transactions. All caps.

Credit Card Supported values are: RE (Retail), RS (Restaurant), EC (eCommerce), DM (Direct Marketing), LD (Lodging) and CR (Car Rental). HC is also supported for HealthCare, however internally transactions with industry type HC are converted to Retail (RE) transactions. ACH Supported values are: CCD (Corporate Credit or Debit), PPD (Prearranged Payment and Deposit Entry), POP (Point of Purchase Entry), TEL (Telephone Initiated Entry), WEB (Internet Initiated Entry), C21 (Check 21)

R

AcctType

string

1

Single character, must match pre-defined types: R (Credit Card & Branded Debit Cards), D (Unbranded Debit Cards), S (Bank Account Savings), C (Bank Account Checking), F (EBT Food Stamp), H (EBT Cash Benefit), G (Gift Card), L (Fleet), K (Check), A (Cash)

R

HolderType

string

1

Single character, either P (Personal account) or O (Organization account).

R

SoftwareVendor

string

N/A

Name of vendor that developed the software used in transmitting the transaction. May only contain the following characters: a-z, A-Z, 0-9, spaces, and dashes.

R

MerchantCode

integer

Provided by MyBridgePay at the time of boarding. The element is optional based on the client’s merchant lookup solution (See Section 1.7)

R

MerchantAccountCode

integer

Provided by MyBridgePay at the time of boarding. The element is optional based on the client’s merchant lookup solution (See Section 1.7)

O

StoredCredential

string

30

Identifies the type of card on file action taking place. Valid Values are:

• Storing the Card/Credential for the first time:

  •  InitialUnscheduled - Indicates that a card is being stored for the first time not in association with a recurring or installment plan.

  • InitialInstallment - Indicates that a card is being stored for the first time in association with an installment plan.

  • InitialRecurring - Indicates that a card is being stored for the first time in association with a recurring plan.

• Using the Card On File (a previously stored credential):

  • UnscheduledCustomer - Customer initiated transaction, whether in-person or on-line; that is not part of a recurring or installment plan.

  • UnscheduledMerchant - Merchant initiated transaction that is not part of a recurring or installment plan.

  • Installment - processing a payment on an installment payment plan using a card on file.

  • Recurring - processing a payment on a recurring payment plan using a card on file.

O

NetworkReferenceNumber

string

30

The "NetworkReferenceNumber" is a response field used in Recurring and Installment transactions when the "StoredCredential" element is passed with the Initial or Recurring payment request. The returned "NetworkReferenceNumber" value must also be passed in every subsequent Recurring or Installment transaction in the payment series. The updated (new) value returned from the previous (or last) transaction processed must then be submitted with the next transaction in the payment series, and so forth.  

Note: This is required for all Card Token Sales. 

O

DynamicDescriptorText

string

38

Used to modify Dynamic Descriptor Name or Text where supported with processors

O

DynamicDescriptorAddress

string

38

Used to modify Dynamic Descriptor Address where supported with processors

O

DynamicDescriptorCity

string

21

Used to modify Dynamic Descriptor City where supported with processors

O

DynamicDescriptorCounty

string

21

Used to modify Dynamic Descriptor County where supported with processors

O

DynamicDescriptorRegion

string

21

Used to modify Dynamic Descriptor Region where supported with processors

O

DynamicDescriptorPostalCode

string

15

Used to modify Dynamic Descriptor Postal Code where supported with processors

O

DynamicDescriptorCountryCode

string

3

Used to modify Dynamic Descriptor Country Code where supported with processors

O

DynamicDescriptorEmailAddress

string

60

Used to modify Dynamic Descriptor Email Address where supported with processors

1

PaymentAccountNumber

integer

13-19

When present, must follow general Credit Card, Debit Card, EBT Card, and Gift Card conventions. Required if track or EMV data not present.

O

Token

integer

22

When present, represents the tokenized card number received from a token request. This is used in place of the PaymentAccountNumber. Note that the last four digits of the Token are the last four digits of the card number.

1

ExpirationDate

string

7

Expiration date of the card. If present, the supported format are: MMYY and MM/YY. Required if track data not present.

3

BankAccountNum

integer

Must contain at least one number. The bank account number for ACH and Check transactions.

3

RoutingNum

integer

10

Can contain up to 10 numbers. The routing number for ACH and Check transactions.

O

FeeAmount

integer

8

Processed as implied decimal. $1.25 would be represented as 125. Additional Fee Amount.
NOTE: Only include the FeeAmount if it is a populated value. Do not send if empty.

O

TipAmount

integer

8

Processed as implied decimal. $1.25 would be represented as 125. Additional Tip Amount. Note: Only TransIndustryType RE(Retail) and RS(Restaurant) are supported for tip adjustment. 

O

SettlementDelay

integer

1

Period for which a Sale-Auth transaction settlement is delayed. Any number between 0 – 29, noting an accepted settlement period in either ‘days’
or ‘hours’.

O

WalletPaymentMethodID

GUID

36

This is the ID provided by the Wallet API for the payment method. When using this field, no other payment identifiers are necessary (i.e. PaymentAccountNumber, Track, BankAccountNum, etc).

O

WalletToken

string

A base64 encoded string describing the information the wallet information. Decoding the token will provide the Site ID, User Guid (if present), Wallet ID and Payment Method ID.

O

WalletKey

string

A base64 encoded string representation of the authentication key created to use the wallet token described above.

O

CustomerWalletID

string

36

The ID provided by the merchant for the payment method. When using this field, no other payment identifiers are necessary (i.e. PaymentAccountNumber, Track, BankAccountNum, etc).

O

EncryptionID

string

The encryption ID identifying the type of encryption used on the sensitive card holder data. See 2.2.4 Generate Encryption Key Request.

O

SecureFormat

string

50

When present, indicates the format to use for decrypting the track data. Possible values: Bluefin, MagneSafeV1, MagneSafeV2, SecureMag and SecureMagV2.

O

BDKSlot

integer

2

When present, indicates the Base Derived Key slot to use as an override for Hardware Decryption.

O

Track1

string

Required for swiped transactions to qualify for best rate. When present, can contain alphanumeric characters and spaces, periods, slashes (/), percent symbols (%), caret symbols (^), question marks (?), semicolons (;), equality symbols (=) or hyphens (-). Can use hardware encryption. Validated against acceptable characters in card swipe, as above. Can use hardware encryption.

O

Track2

string

Required for all swiped transactions. When present, can contain alphanumeric characters and spaces, periods, slashes (/), percent symbols (%), caret symbols (^), question marks (?), semicolons (;), equality symbols (=) or hyphens (-). Can use hardware encryption. Validated against acceptable characters in card swipe, as above. Can use hardware encryption.

O

Track3

string

Optional; used for encryption. When present, can contain alphanumeric characters and spaces, periods, slashes (/), percent symbols (%), caret symbols (^), question marks (?), semicolons (;), equality symbols (=) or hyphens (-). Can use hardware encryption. Validated against acceptable characters in card swipe, as above. Can use hardware encryption.

O

TransactionMode

string

1

P = Card Present or N = Card Not Present.

O

DUKPT

string

20

Derived unique key per transaction used in Debit and EBT transaction encryption.

O

PINCode

string

16

Encoded PIN for Debit and EBT transactions.

O

EMVTags

string

255

Combined EMV tags presented in TLV format.

O

EntryMode

string

2

Method of entering the transaction. Possible values: MX = Manual with Signature, SX = Swipe/Scan with Signature, HX = Chip with Signature, CX = Contactless with Signature, SP = Swipe with PIN, HP = Chip with PIN

O

EntryMedium

string

2

The medium type used to initiate the transaction. Possible values: NP = Not Present, MC = Magnetic Card, CC = Chip Card, CH = Check

O

EntryPINMode

string

2

Indicates whether the input source supports PIN entry. Possible values: X = unknown, S = supported, U = Unsupported, N = Inoperative, O = Offline.

O

TerminalCapabilities

string

255

Describes the terminal’s capabilities. Can include any combination of the following tags separated by pipe characters: unknown, unused, unattended, manual, stripe, barcode, qrcode, ocr, icc, contactless, signature, rfid, micr or mobile.

O

TerminalType

string

255

Indicates the type of device/behavior when used in processing a transaction. Upper and Lower case alphanumeric charaters only. Examples: INGENICO, EDYNAMO, CHIPPER2, and WISEPAD2 (more available).

O

DeviceMake

string

40

Manufacturer of terminal used. May contain any of the following characters: a-z, A-Z, 0-9, spaces, periods, dashes, or slashes (\).

O

DeviceModel

string

40

Model number of terminal used. May contain any of the following characters: a-z, A-Z, 0-9, spaces, periods, dashes or slashes (\).

O

DeviceSerial

string

40

Serial number of terminal used. May contain any of the following characters: a-z, A-Z, 0-9, spaces, periods, equal sign, hashtags, dashes or slashes (\).

O

DeviceFirmware

string

50

Firmware version number of terminal used. May contain any of the following characters: a-z, A-Z, 0-9, spaces, periods, equal sign, dashes or slashes (\).

O

SecurityTechnology

string

N/A

Security packaged used in decrypting the hardware encrypted data.

O

PurchaseToken

GUID

36

Provided by the AcquirePurchaseToken method. Used in place of User and Password in the base response.

O

SecurityCode

integer

3-4

When present, must be 3 or 4 digits long CVV / CVV2 of the card.

O

TransCatCode

string

1

All caps. Supported values are: B (BillPayment), R (Recurring), I (Installment), H (Healthcare).

O

VoiceAuthCode

string

15

Authorization Code for Voice Authorizations only. If authorization was achieved outside of the network (by phone or other means) you may send it through this data element to utilize the existing authorization instead of acquiring a new authorization.

O

PartialAuthorization

string

5

Must contain the literal true or the literal false. Setting this field to true indicates that a partial authorization is acceptable for this transaction. The default, if this element is not present, is false.

SwipeResult

future Use

Future use.

PINBlock

future Use

Future use.

PINKey

future Use

Future use.

O

VoucherNumber

string

15

EBT voucher clear transactions only

O

InvoiceNum

string

24

Invoice number. Spaces are not allowed. Alphanumeric and dashes accepted. User supplied data.

O

PONum

string

24

Alphanumeric and dashes accepted. User supplied data.

O

CustomerAccountCode

string

24

Alphanumeric and dashes accepted. User supplied data.

O

PaymentType

string

24

Alphanumeric, dashes and spaces accepted. User supplied data.

O

AccountHolderName

string

150

Any upper or lower case letter, hyphens, and spaces are allowed. Name on the credit card or ACH account. 

Note: This is required for the USAG/Tabapay processor. 

O

CashBackAmount

integer

8

Processed as implied decimal. $20.00 would be represented as 2000. Amount of money returned to a payment card holder. Used for Sale with cash back transactions.

O

TipRecipientCode

string

15

Can contain alphanumerics, hyphens, and periods. Server ID for the customer.

O

CustomFields

collection

n/a

Multiple based on previously configured custom fields. See <Appendix section A14> for information on transacting with custom fields. Please note the custom field elements within the CustomFields collection are case sensitive. They must be presented exactly as they were created.

O

AccountStreet

string

128

Can contain alphanumerics, spaces, hyphens, periods and slashes. Street on the account.

O

AccountZip

string

10

Postal Code on the Payment Method Account. Accepted formats are Canadian, UK and US (5 and 9 digit variation) postal codes. Alphanumeric characters ONLY (no hyphens or dashes). Alpha characters must be all upper-case.

O

AccountPhone

string

10 to 20

Billing phone number. Numerics only. No special characters allowed.

O

ContractId

integer

12

A valid BridgePay Recurring Billing System Contract Id. Provides a way to tie a transaction to a contract defined in BridgePay’s Recurring Billing System.

O

CheckImageFront

string

64000

Base64 text encoded version of the TIFF image of the front of the check being processed.

O

CheckImageBack

string

64000

Base64 text encoded version of the TIFF image of the back of the check being processed.

O

MICR

string

255

MICR data scanned by a check reader.

O

RegistrationKey

string

10

Reseller / Partner registration key for PayGuardian. May contain any of the following characters: a-z, A-Z, 0-9, spaces, periods, dashes or slashes (\).

O

AppHostMachineld

string

36

GUID that identifies the HOST machine for the terminal 

O

IntegrationMethod

string

6

Identifies the PayGuardian integration method. Acceptable values are: REST, DLL, FILE, AA, SDK, VT, REST-H, DLL-H, FILE-H

O

OriginatingTechnologySource

string

N/A

Name of software transmitting the transaction.

O

Memo

string

60

Memo for the transaction. If Memo element and the PaymentType element are provided, the Memo element will take precedence. This field may NOT contain the following characters:
“, *, &, <, >

O

HealthCareAmt

integer

8

Processed as implied decimal. $1.25 would be represented as 125. The portion of the Total Amount spent on healthcare related services or products.

O

TransitAmt

integer

8

Processed as implied decimal. $1.25 would be represented as 125. The portion of the Total Amount spent on healthcare related transportation.

O

PrescriptionAmt

integer

8

Processed as implied decimal. $1.25 would be represented as 125. The portion of the Healthcare Amount spent on prescription drugs or products.

O

VisionAmt

integer

8

Processed as implied decimal. $1.25 would be represented as 125. The portion of the Healthcare Amount spent on vision related medical services.

O

DentalAmt

integer

8

Processed as implied decimal. $1.25 would be represented as 125. The portion of the Healthcare Amount spent on dental related medical services.

O

ClinicAmt

integer

8

Processed as implied decimal. $1.25 would be represented as 125. The portion of the Healthcare Amount spent on hospitalization.

O

IsQualifiedIIAS

string

Indicates whether purchase items are verified against IIAS as qualified for healthcare purchases. Can be lower case ‘t’ or ‘true’, or lower case ‘f’ or ‘false’.

C

TaxRate

integer

5

Processed as implied decimal. 5.5% would be represented as 550. Additional Tax Amount. REQUIRED FOR LEVEL II/III

C

TaxAmount

integer

8

Processed as implied decimal. $1.25 would be represented as 125. REQUIRED FOR LEVEL II.

C

TaxIndicator

string

1

P (Provided), N (Not Provided), or E (Exempt). REQUIRED FOR LEVEL II/III.

C

ShipToName

string

100

Shipping address name. REQUIRED FOR LEVEL II/III.

C

ShipToStreet

string

128

Shipping address name. REQUIRED FOR LEVEL II/III.

C

ShipToCity

string

50

Shipping address name. REQUIRED FOR LEVEL II/III.

C

ShipToState

string

2

Shipping address name. REQUIRED FOR LEVEL II/III.

C

ShipToZip

string

15

Shipping address postal code. Accepted formats are Canadian, UK and US (5 and 9 digit variation) postal codes. Alpha characters must be all upper-case. REQUIRED FOR LEVEL II/III.

C

ShipToCountryCode

string

2

Shipping address country code. REQUIRED FOR LEVEL II/III. ISO 3166-1 alpha-2 codes.

R3

ItemCode

string

12 

Unique identifier assigned to this item in the submitter’s inventory system.

R3

ItemCommodityCode

string

12

Acquirer designated standardized code that classifies this item.

R3

ItemDescription

string

35

Short description of the item.

R3

ItemQuantity

decimal

12

Quantity of item units purchased as part of this transaction. Up to 4 decimal places.

R3

ItemUnitCostAmt

integer

12

Processed as implied decimal. $1.25 would be represented as 125. Cost of a single unit of the item.

R3

ItemUnitMeasure

string

12

Unit of measure used to quantify the items purchased/refunded (e.g. kg, lb., inch).

R3

ItemTaxRate

integer

12

Processed as implied decimal. 5.5% would be represented as 550. Rate of the tax (if any) charged on this item.

R3

ItemTaxAmount

integer

8

Processed as implied decimal. $1.25 would be represented as 125. Amount of tax charged for this item.

R3

ItemTaxIndicator

string

1

P (Provided), N (Not provided), or E (Exempt).

R3

ItemTaxCode

string

4

Acquirer designated value classifying the tax that was charged for this item.

R3

ItemDiscountCode

integer

8

Processed as implied decimal. 5.5% would be represented as 550. Rate of discount (if any) that was applied to this item.

R3

ItemDiscountAmount

integer

8

Processed as implied decimal. $1.25 would be represented as 125. Total amount of discount applied to this item.

R3

ItemTotalAmount

integer

8

Processed as implied decimal. $1.25 would be represented as 125. Total amount paid for the item (including tax and discount).

R3

ItemIsCredit

string

1

True (Item is being returned), False (Default if not passed - Item is being purchased).

Token

string

22

Either the token submitted with the original authorization request or a tokenized version of the submitted payment account number if no token was provided in the request. Note that the last four digits of the Token are the last four digits of the card number.

MerchantAccountCode

integer

Provided by MyBridgePay at the time of boarding. The element is optional based on the client’s merchant lookup solution.

AuthorizationCode

string

50

The transaction authorization code returned from the processor.

ReferenceNumber

string

For future use.

GatewayResult

string

Echo of the ResponseCode.

AuthorizedAmount

integer

8

Implied decimal, amount of the charge that was authorized.

OriginalAmount

integer

8

Implied decimal, amount that was requested for authorization.

ExpirationDate

string

6

Echo back of the expiration date.

AVSResult

string

Unipay AVS Match Result Code.

AVSMessage

string

Unipay AVS Match Result Message.

StreetMatchMessage

string

For future use.

ZipMatchMessage

string

For future use.

CVResult

string

Unipay CVV/CVV2 Match Result Code.

CVMessage

string

Unipay CVV/CVV2 Match Result Message.

IsCommercialCard

Boolean

For future use.

GatewayTransID

integer

Transaction ID from the gateway (used as Reference Number for Voids / Refunds).

GatewayMessage

string

Message from the gateway.

InternalMessage

string

Provides more information from the gateway and processor regarding the results of the transaction request.

Balance

integer

For future use.

CashBackAmount

integer

8

For future use.

TransactionCode

string

Echo back of the TransactionCode.

TransactionDate

string

Echo back of the TransactionDate.

CardClass

string

25

Displays the tender type used to process a transaction. List of values: Credit, Debit, Gift, Prepaid, EBT, Fleet, None

CardType

string

25

Displays the card type (determined by BIN range). List of values: Visa, Mastercard, Discover, Amex, Diners, JCB, CUP (China Union Pay), Bank, None.

CardModifier

string

25

Displays the featured function submitted in addition to the tender type used to process a transaction. List of values: FSA, Commercial, FoodStamp, CashBenefit, Cash, None.

CardHolderName

string

200

Displays the cardholder name as provided in the request message, or from the device.

ProviderResponseCode

string

25

Displays the response code as provided by the Processor.

ProviderResponseMessage

string

255

Displays the response message as provided by the Processor.

RemainingAmount

integer

8

Any amount of the original authorization remaining after this void / refund. This amount is in implied decimal format (i.e. $19.95 = 1995).

IsoCountryCode

string

IsoCurrencyCode

string

IsoTransactionDate

string

IsoRequestDate

string

NetworkReferenceNumber

string

NetworkMerchantId

string

20

NetworkTerminalId

string

20

MaskedPan

string

WalletID

string

WalletPaymentMethodID

string

WalletResponseMessage

string

WalletResponseCode

string

ResponseTypeDescription

string

MerchantCategoryCode

string

Returned tag data for generating the receipt.

*

ReceiptTagData

string

Returned tag data from the issuer.

*

IssuerTagData

string

Returned tag data from the issuer.

R

BIN

integer

11

The 8 to 11-digit BIN number to be looked up. As this is only a BIN number, it need not be encrypted and does not support being encrypted.

R

CardIdentifier

string

The card type for the submitted BIN.

R

NewPassword

string

The new password for the user.

R

ConfirmPassword

string

The re-entered new password for the user, to confirm the new value.

O

Purchase Token

GUID

36

Provided by the AcquirePurchaseToken method. Used in place of User and Password in the base response.

R

MerchantCode

integer

12

The default merchant code assigned to the user.

R

MerchantAccountCode

integer

12

The default merchant account code assigned to the user.

R

MerchantName

string

50

The name assigned to the merchant account.

R

GatewayResults

string

5

Results from the Gateway (5 digit code).

R

GatewayTransID

integer

12

Transaction ID for the request.

R

GatewayMessage

string

255

Message from the Gateway regarding this request.

R

MerchantCode

integer

Provided by MyBridgePay at the time of boarding. The element is necessary unless the client is using a different merchant lookup solution (See Section 1.6)

R

MerchantAccountCode

integer

Provided by MyBridgePay at the time of boarding. The element is necessary unless the client is using a different merchant lookup solution (See Section 1.6)

R

Amount

integer

8

Processed as implied decimal. $1.25 would be represented as 125. The amount requested to be refunded / voided.

R

ReferenceNumber

integer

12

The GatewayTransId returned as a part of the response to request 004.

R

TransactionType

string

6

Can contain letters and hyphens. Must match a one of the defined transaction types in Unipay. Should use “void” or “refund” only for this request type.

R

TransactionCode

string

Must match the TransactionID in the requestHeader

O

PurchaseToken

GUID

36

Provided by the AcquirePurchaseToken method. Must be the same Purchase Token acquired and used for an authorization or sale. Used in place of User and Password in the base response.

O

OriginatingTechnologySource

string

N/A

Name of software transmitting the transaction.

R

SoftwareVendor

string

N/A

Name of vendor that developed the software used in transmitting the transaction. May only contain the following characters: a-z, A-Z, 0-9, spaces, and dashes.

O

SecurityTechnology

string

N/A

Security packaged used in decrypting the hardware encrypted data.

O

CustomerAccountCode

string

24

Alphanumeric and dashes accepted. User supplied data.

O

InvoiceNum

string

24

Invoice number. Spaces are not allowed. Alphanumeric and dashes accepted. User supplied data.

O

DeviceMake

string

40

Manufacturer of terminal used. May contain any of the following characters: a-z, A-Z, 0-9, spaces, periods, dashes, or slashes (\).

O

DeviceModel

string

40

Model number of terminal used. May contain any of the following characters: a-z, A-Z, 0-9, spaces, periods, dashes or slashes (\).

O

DeviceSerial

string

40

Serial number of terminal used. May contain any of the following characters: a-z, A-Z, 0-9, spaces, periods, equal sign, hashtags, dashes or slashes (\).

O

DeviceFirmware

string

50

Firmware version number of terminal used. May contain any of the following characters: a-z, A-Z, 0-9, spaces, periods, equal sign, dashes or slashes (\).

O

RegistrationKey

string

10

Reseller / Partner registration key for PayGuardian. May contain any of the following characters: a-z, A-Z, 0-9, spaces, periods, dashes or slashes (\).

O

AppHostMachineId

string

36

GUID that identifies the HOST machine for the terminal.

O

IntegrationMethod

string

6

Identifies the PayGuardian integration method. Acceptable values are: REST, DLL, FILE, AA, SDK, VT, REST-H, DLL-H, FILE-H

O

EMVTags

string

255

Combined EMV tags presented in TLV format.

O

VoidReasonCode

string

20

Idenitifies the reason a transaction was voided from a device. Acceptable values are: CustomerInitiated, TimeoutReversal, System Malfunction, SuspectedFraud, PrematureCardRemoval, ChipDecline.

O

Memo

string

60

Memo for the transaction. This field may NOT contain the following characters:
“, *, &, <, >.

R

ReferenceNumber

The reference number of the refund or of the original authorization if this was a void.

R

TransactionCode

The TransactionCode that was send with the request.

R

RemainingAmount

Integer

8

Any amount of the original authorization remaining after this void / refund. This amount is in implied decimal format (i.e. $19.95 = 1995).

R

ResponseType

string

Action that was performed: “Void” or “refund”.

R

MerchantAccountCode

The merchant account code used to process the original authorization and the void or refund.

CardType

string

25

Displays the card type (determined by BIN range). List of values: Visa, Mastercard, Discover, Amex, Diners, JCB, CUP (China Union Pay), Bank, None.

CustomFields

string

25

If the Sale that is being refunded had custom fields they will be returned in the response.  See Section A.13 for
more information on custom fields.

R

BankAccountNum

integer

Must contain at least one number. The bank account number for ACH transactions.

O

OriginatingTechnologySource

string

N/A

Name of software transmitting the transaction.

R

SoftwareVendor

string

N/A

Name of vendor that developed the software used in transmitting the transaction. May only contain the following characters: a-z, A-Z, 0-9, spaces, and dashes.

O

SecurityTechnology

string

N/A

Security packaged used in decrypting the hardware encrypted data.

O

DeviceMake

string

40

Manufacturer of terminal used. May contain any of the following characters: a-z, A-Z, 0-9, spaces, periods, dashes, or slashes (\).

O

DeviceModel

string

40

Model number of terminal used. May contain any of the following characters: a-z, A-Z, 0-9, spaces, periods, dashes or slashes (\).

O

DeviceSerial

string

40

Serial number of terminal used. May contain any of the following characters: a-z, A-Z, 0-9, spaces, periods, equal sign, hashtags, dashes or slashes (\).

O

DeviceFirmware

string

50

Firmware version number of terminal used. May contain any of the following characters: a-z, A-Z, 0-9, spaces, periods, equal sign, dashes or slashes (\).

O

RegistrationKey

string

10

Reseller / Partner registration key for PayGuardian. May contain any of the following characters: a-z, A-Z, 0-9, spaces, periods, dashes or slashes (\).

O

AppHostMachineId

string

36

GUID that identifies the HOST machine for the terminal.

O

IntegrationMethod

string

6

Identifies the PayGuardian integration method. Acceptable values are: REST, DLL, FILE, AA, SDK, VT, REST-H, DLL-H, FILE-H

R

Token

integer

22

The 22-digit token to be used for authorization.

R

User

String

150

User name assigned to the merchant account.

R

Password

String

255

Password assigned to the merchant account. 

R

MerchantCode

numeric

The default merchant code assigned to the merchant account.

R

MerchantAccountCode

numeric

The default merchant account code assigned to the merchant account. 

R

RequestDateTime

numeric

19

The date and time the request was sent. The default format is YYYYMMDDHHMMSS using military time.

R

TransactionID

String

60

Unique transaction ID sent in with the request.

R

TransactionType

enum

20

Identifies the action to take. Can be balance-inquiry or account-verification.

NOTE: At this time only balance-inquiry is only supported for gift cards and EBT. 

R

PaymentAccountNumber

integer

13-19

Full credit card number

R

ExpirationDate

string

7

Expiration date of the card. If present, the supported format are: MMYY and MMYY

R

AcctType

string

1

Single character, must be set to R

R

TransIndustryType

string

2

Must match a predetermined 2-letter industry type. All caps. Supported values are: RE (Retail), RS (Restaurant), EC (eCommerce), DM (Direct Marketing), LD (Lodging) and CR (Car Rental). HC is also supported for HealthCare, however internally transactions with industry type HC are converted to Retail (RE) transactions.

O

SecurityCode

numeric

3-4

When present, must be 3 or 4 digits long CVV/CVV2 of the card.

O

AccountStreet

string

128

Street of the billing address. Can contain alphanumerics, spaces, hyphens, periods and slashes. Street on the account

O

AccountZip

string

10

Postal Code of the billing address. Accepted formats are Canadian, UK and US (5 and 9 digit variation) postal codes. Alphanumeric characters ONLY (no hyphens or dashes). Alpha characters must be all upper-case.

O

AccountHolderName

string

Name on the credit card or ACH account. 

TransactionID

String

Unique transaction ID sent in with the request.

TransactionType

enum

10

Identifies the administrative action taken. Can be BalanceInquiry or Account-Verification.

NOTE: In this release, it can only be BalanceInquiry

ResponseCode

numeric

5

The numeric value of the response identified in appendix A.1. 

ResponseDescription 

string

The description of the error response code.

ResponseType

enum

9

Identifies the type of response received. Can be Good, Soft, Hard or Exception.

Token

string

22

A tokenized version of the submitted payment account number. Note that the last four digits of the Token are the last four digits of the card number.

ExpirationDate

string

6

Echo back of the expiration date.

ReferenceNumber

integer

Identifies the BridgePay Gateway ID number of the request.

GatewayResult

string

3

The BridgePay Gateway’s internal code for the result of the request.

GatewayMessage

string

The BridgePay Gateway’s internal message corresponding to the GatewayResult field.

TransactionDate

DateTime

14

Date of the request. Format: yyyyMMddHHmmss

Balance

integer

8

Amount of money remaining on the card. Provided as implied decimal. $1.25 would be represented as 125.

AuthrorizationCode

string

50

The transaction authorization code returned from the processor.

AVSResult

string

2

The BridgePay Gateway AVS Result Code.

AVSMessage

string

255

The message associated with the AVSResult field

CVResult

string

1

The BridgePay Gateway CVV Result Code.

CVMessage

string

255

The message associated with the CVResult field.

ProviderAVSCode

string

5

Original provider’s AVS Response Code

ProviderCVCode

string

1

Original provider’s CVV Response Code

ProviderReferenceNumber

string

50

Reference number of the underlying provider.

OrganizationId

numeric

4

Identifier of the organization. 

NetworkMerchantId

string

20

The Network Merchant Id

NetworkTerminalId

string

20

The Network Terminal Id 

R

MerchantCode

integer

Provided by MyBridgePay at the time of boarding. The element is necessary unless the client is using a different merchant lookup solution (See Section 1.6)

R

MerchantAccountCode

integer

Provided by MyBridgePay at the time of boarding. The element is necessary unless the client is using a different merchant lookup solution (See Section 1.6)

R

Amount

integer

8

Processed as implied decimal. $1.25 would be represented as 125. The amount to be confirmed. For new authorizations, can be 100% or less of the original auth amount. For previously confirmed transactions, can be 100% of the previously confirmed amount. For lodging transactions, can be greater or less than the total authorized for the lodging key.

C

ReferenceNumber

integer

The GatewayTransId returned as part of the auth response (004). Conditionally Required – Not required for Lodging Transactions

R

TransactionType

string

Can contain letters and hyphens. Must match a one of the defined transaction types in Unipay. Should use “capture” only for this request type.

R

TransactionCode

string

Must match the TransactionID in the requestHeader

C

FolioNumber

string

15

Hotel folio number. Required when capturing a lodging transaction.

C

CheckInDate

Date

The date of actual or anticipated check-in. Required when capturing a lodging transaction.

C

Token

integer

22

When present, represents the tokenized card number received from a token request or authorization. Required when capturing a lodging transaction. Note that the last four digits of the Token are the last four digits of the card number.

O

SettlementDelay

integer

1

Designates the number of batch cycles that a Sale-Auth transaction remains open (unsettled). If the Sale-Auth is not captured before completion of the set number of batch cycles passed into the Settlement Delay field of the original transaction, the Sale-Auth transaction will auto-void.

Note: Minimum and Maximum range period to delay the auto-void of a Sale-Auth is between 0 – 30 (0 = current batch period, 30 = 30 batch periods).

O

OriginatingTechnologySource

string

N/A

Name of software transmitting the transaction.

R

SoftwareVendor

string

N/A

Name of vendor that developed the software used in transmitting the transaction. May only contain the following characters: a-z, A-Z, 0-9, spaces, and dashes.

O

SecurityTechnology

string

N/A

Security packaged used in decrypting the hardware encrypted data.

O

DeviceMake

string

40

Manufacturer of terminal used. May contain any of the following characters: a-z, A-Z, 0-9, spaces, periods, dashes, or slashes (\).

O

DeviceModel

string

40

Model number of terminal used. May contain any of the following characters: a-z, A-Z, 0-9, spaces, periods, dashes or slashes (\).

O

DeviceSerial

string

40

Serial number of terminal used. May contain any of the following characters: a-z, A-Z, 0-9, spaces, periods, equal sign, hashtags, dashes or slashes (\).

O

DeviceFirmware

string

50

Firmware version number of terminal used. May contain any of the following characters: a-z, A-Z, 0-9, spaces, periods, equal sign, dashes or slashes (\).

O

RegistrationKey

string

10

Reseller / Partner registration key for PayGuardian. May contain any of the following characters: a-z, A-Z, 0-9, spaces, periods, dashes or slashes (\).

O

AppHostMachineId

string

36

GUID that identifies the HOST machine for the terminal.

O

IntegrationMethod

string

6

Identifies the PayGuardian integration method. Acceptable values are: REST, DLL, FILE, AA, SDK, VT, REST-H, DLL-H, FILE-H

O

Memo

string

60

Memo for the transaction. This field may NOT contain the following characters:
“, *, &, <, >.

R

ReferenceNumber

string

Provider supplied reference number.

R

GatewayResult

string

Echo of ResponseCode.

R

GatewayTransID

string

Echo of TransactionID.

R

GatewayMessage

string

Echo of ResponseDescription.

R

TransactionCode

string

The TransactionCode that was send with the request.

R

ResponseType

string

Action that was performed: “capture”.

R

MerchantAccountCode

string

The merchant account code used to process the original authorization and the void or refund.

R

CycleCode

string

The Batch ID for the submitted transactions.

R

GatewayResult

string

Echo of ResponseCode.

R

GatewayTransID

string

Echo of TransactionID.

R

GatewayMessage

string

Echo of ResponseDescription.

R

TransactionCode

string

The TransactionCode that was send with the request.

R

ResponseType

string

Action that was performed: “closeCycle”.

R

MerchantAccountCode

string

The merchant account code used to process the original transactions.

R

MerchantCode

integer

Provided by MyBridgePay at the time of boarding. The element is necessary unless the client is using a different merchant lookup solution (See Section 1.6). Used to narrow the search query down to a given merchant code.

R

MerchantAccountCode

integer

Provided by MyBridgePay at the time of boarding. The element is necessary unless the client is using a different merchant lookup solution (See Section 1.6). Used to narrow the search query down to a give merchant account code.

O

TransactionCode

string

Used to search on the user-provided transaction code of the transaction.

O

GatewayTransID

integer

Identifies the BridgePay Gateway ID number of the request.

O

PurchaseToken

GUID

36

Used to search for a transaction that was processed using the given Purchase Token.

O

InvoiceNum

string

24

Used to search on the user-provided Invoice Number of the original transaction.

MerchantCode

integer

12

The default merchant code assigned to the user.

MerchantAccountCode

integer

The default merchant account code assigned to the user.

RoutingNumber

integer

The routing number for ACH and Check transactions.

PurchaseToken

GUID

36

Echo back of Purchase Token used in transaction request.

ApprovalCode

string

Transaction authorization code returned from the processor.

CSCResponseCode

string

1

The BridgePay Gateway CVV Result Code.

GatewayTransId

integer

Identifies the BridgePay Gateway ID number of the request.

HolderName

string

200

Displays the cardholder name as provided in the request message, or from the device.

InvoiceNum

string

24

Invoice number used in the transaction request.

TransactionDate

DateTime

14

Date of the request. Format: yyyyMMddHHmmss

TransactionCategory

string

1

Echo back of the transaction category code used in the transaction request.

Amount

integer

8

The implied decimal implementation of the authorized amount.

AVSResponseCode

string

Unipay AVS Match Result Code.

Balance 

integer

8

Amount of money remaining on the card. Provided as implied decimal. $1.25 would be represented as 125.

Email

string

100

Account holder’s e-mail address provided in the transaction request.

ExpirationDate

string

7

Echo back of the expiration date.

Holdertype

string

1

Echo back of the account holder type. Single character, either P (Personal account) or O (Organization account).

AccountType

string

2

Two-character code describing the type of account. See account type definitions later in this document.

City

string

Echo back of the billing address.

Memo

string

The memo field provided on the transaction

OriginalAmount

integer

8

The implied decimal implementation of the original amount.

Phone

string

The phone number provided in the transaction request.

Token

integer

22

The tokenized card number received from a token request or authorization. Note that the last four digits of the Token are the last four digits of the card number.

AccountNumberMasked

integer

Last 4 digits of truncated account number from transaction request.

CountryCode

string

Country code of billing address.

State

string

State of the billing address.

Street

string

Street of the billing address.

TransactionIndustryType

string

2-3

Echos back the industry type code used in the transaction request.

TransactionType

string

11

Echos back the transaction type used in the transaction request.

ZipCode

string

10

Zip code of billing address. 

PersistedData

string

XML representation of data elements with persist attribute. Returns any persisted data included in transaction request. (i.e. User Data, Invoice Number. See section A3.)

ResponseCode

string

5

Echo of the 5 digit ResponseCode returned on the transaction.

ResponseDescription

string

Echo of ResponseMessage returned on the transaction.

OriginalReferenceNumber

integer

If the transaction in question is a refund then the OriginalReferenceNumber value will be populated with the GatewayTransID of the original
sale.

R

TransactionID

The TransactionID value submitted with the original request.

R

RequestType

The RequestType value from the original request that has failed.

R

ResponseCode

integer

5

A five-digit response code describing the results of the transaction. See Appendix A.1 for a list of valid response values.

R

ResponseDescription

string

Description of the error response code (ResponseCode).

00000

Successful request

10001

Missing Reference Number

10002

Invalid Card Number- Blank/Null

10003

Invalid Card Type - Doesn't match accepted card types

10004

Invalid Expiration Date - Blank/Null

10005

Invalid Security Code - Blank/Null

10007

Invalid Card Number - Not Numeric

10008

Invalid Length for card type

10009

Invalid Expiration Date - Card Expired

10010

Invalid Security Code - Not Numeric

10011

Invalid Transaction ID

10012

Invalid Card Number - Failed Mod10

10013

Invalid Expiration Date Value

10014

Invalid Security Code Length

10017

Invalid Expiration Date - Invalid Month

10018

Invalid Expiration Date - Invalid Year

10019

Invalid Expiration Date

10020

Invalid Client Identifier

10021

Invalid Request Element – Missing Element

10022

Invalid Request Type

10023

Password Expired

10024

Invalid Credentials

10025

Invalid Zip – Not Numeric

10026

Invalid Zip – Wrong Length

10027

Invalid Amount – Blank/Null

10028

Invalid Amount – Not Numeric

10029

Invalid Request Date/Time

10030

Invalid Token

10031

Invalid Track

10032

Invalid Track Identifier

10033

Invalid Void Request

10034

Invalid Encryption ID

10035

Invalid Account Number – Blank/Null

10036

Invalid Account Number – Not Numeric

10037

Invalid Payment Type – Blank/Null

10038

Invalid Payment Type – Unrecognized Payment Type

10039

Invalid Account Number – Account Number Does Not Exist

10040

Missing Required Pass-Thru Data Element

10041

Missing / Invalid BIN

10042

Already Voided

10050

Incorrect Trace Number

10051

Incorrect Merchant Setup

10052

Processing Network Error

10053

Credit Card Entry Refused by Receiver

10054

Mandatory Field Error

10055

Invalid Reference Number

20001

Tokenization Service Connection Error

20002

BridgePay Internal Server Error

20003

Client Service Unavailable

20004

Payment Service Sensitive Data Timeout

30004

Invalid Request Message

30005

Invalid Response Message

30006

New Password Doesn't Match Confirmation Password

30007

New Password Too Weak*

30008

Missing Payment Card Data

30009

Internal Payment Card Data Error

30010

Invalid Record Format

30011

Invalid Merchant Number (from Gateway)

30012

Bad Card Number (from Gateway)

30013

Invalid Store Number

30020

Invalid Transaction Industry Type

30021

Missing Transaction Industry Type

30022

Processing Network Unavailable

30023

Invalid Account Number

30024

No Account

30025

Invalid Security Code

30026

Invalid Amount

30027

Refund limit is reached for the day(occurs when merchant has reached the refund limit allowed per day on the account)

30028

Settlement Failed

30029

Transaction Error

30030

Transaction data integrity validation error

30032

Denied by customer’s bank

30033

Insufficient funds

30034

Hold - Pick up card

30035

Incorrect PIN

30036

Duplicate Transaction

30037

Card reported lost

30038

Card reported stolen

30039

Service not allowed

30040

Stop Recurring

30041

Unattempted Batch Decline

30042

Maximum transaction limit is exceeded at the moment. Try processing your transaction tomorrow.

30043

Re-enter Transaction

30044

Unmapped decline

30045

Billing profile configuration error

30046

Pin Try Exceeded

30047

Refund was not processed/received

30048

Chargeback received

30049

Processing Canceled by User

30050

Invalid Transaction Category

30051

Invalid Verification Status

30052

Invalid Terminal Type

30053

Invalid Petroleum Product Type

30060

Invalid IApp User Id

30061

Account insert failed

30062

Merchant insert failed

30070

New Password Previously Used

30071

Missing Clerk Id

30072

Call for Authorization

30073

Card is Restricted

30074

Declined due to fraud rules

30075

Bank Account Blacklisted

30076

Declined due to insufficient information

30077

Rejected by the processor

30078

Account Closed

30079

Invalid Account

30080

Account can not process ACH

30082

Invalid MICR

30083

Customer opt out check Conversion

30084

Transaction exceeds max single transaction threshold

30085

Transaction exceeds max total threshold

30100

Invalid Account Data – Blank/Null

30101

Invalid EMV Tag Data – Blank/Null

30102

Surcharge are not allowed 

30103

Cashback is not available 

30104

Routing Number/Check Digit Error 

30105

Transaction not premitted - card

30106

Transaction not premitted - terminal 

30107

Issuer Unavailable 

40001

Lodging Reauth Failed

40002

Missing Lodging Folio Number

80000

Gateway Services Available

80001

Gateway Services Unavailable

80002

Invalid Purchase Token

80003

More than one result found for search criteria

80004

More than one service fee block received in request message

80005

Cascade Void. Indicates that the transaction was successfully authorized (fully or partially) and then voided due to an auto-void policy setting. Only occurs on principal transactions and only when the accompanying service fee was either declined or voided due to an auto-void policy setting.

80006

Partial Auto Void. Indicates that the transaction was partially authorized and then voided due to an auto-void policy setting.     Can occur on a service fee or principal transaction.

80007

Database query processing error. Can occur on a Find Transaction request if the data requested is unavailable.

80008

Invalid GatewayTransID

80009

Invalid MerchantCode

80010

Invalid MerchantAccountCode

80011

Transaction not found

80012

Invalid Length for PersistData

80013

Invalid ActionType

80014

Invalid Device

80015

Adjustment Failure

90000

Token Store failed to encrypt a token

90001

Token Store failed to decrypt a token

90002

Unauthorized Access

90003

Custom Field Name Does Not Exist

90004

Unreadable XML Request Message

99999

Unknown Error

BridgePay Code

Description

AC

American Express

DC

Discover Credit

DD

Discover Debit

NC

Diner's

MC

MasterCard Credit

MD

MasterCard Debit

VC

Visa Credit

VD

Visa Debit

BS

Bank Savings Account

BC

Bank Checking Account

BD

Bank Card Debit

EF

Food Stamp

EC

Cash Benefit

MP

MasterCard Prepaid

MF

MasterCard Fleet

VP

Visa Prepaid

VS

Visa Fleet

GG

General Gift

FL

Fleet One

GF

Fuel Man Fleet Wide

VF

Voyager

WX

Wright Express

CS

Cash

CK

Check

VE

Visa Debit Checking

VV

Visa Debit Savings

FU

Fuel Lynk

BN

Bank Card Debit Checking

BI

Bank Card Debit Savings

O

RoomNumber

string

25

Hotel room number

C

FolioNumber

string

15

Hotel folio number
Required when LodgingChargeType = 'H'

C

RoomRateAmount

integer

8

Daily room rate. Implied decimal.
Required when LodgingChargeType = 'H'

O

RoomTaxAmount

integer

8

Tax charged on daily rate. Implied decimal.

R

LodgingChargeType

Enum

Type of service for which this transaction is processed.

• H = Hotel

• R = Restaurant

• G = Gift Shop

• S = Health Spa

• B = Beauty Shop

• F = Convention Fee

• T = Tennis

• O = Golf

C

CheckInDate

Date

The date of actual or anticipated check-in.
Required when LodgingChargeType = 'H'

C

CheckOutDate

Date

The date of actual or anticipated check-out
Required when LodgingChargeType = 'H'

O

StayDuration

integer

Indicates the length of anticipated, actual or incremental stay.

C

SpecialProgramType

Enum

Important when the cardholder did not stay at the hotel.

• AD = Advance deposit

• AR = Assured reservation

• DC = Delayed charge

• ES = Express service

• NC = Normal charge

• NS = No show charge

Required when LodgingChargeType = 'H'

O

DepartureAdjAmount

integer

8

Additional amount charged after the cardholder left the hotel.

C

LodgingItemCount

integer

Conditional, required if lodging items present in request. Indicates number of lodging industry items purchased as part of this transaction. See Lodging Item Records for more detail.
Required when LodgingChargeType = 'H'

C

LodgingItems

Collection

Collection of lodging item records.

R

LodgingItemType

Enum

Lodging extra charge type

• G = Gift Shop

• L = Laundry

• B = Mini bar

• R = Restaurant

• T = Telephone

R

LodgingItemAmount

integer

8

Amount for lodging extra charge item. Implied decimal.

R

RentalAgreementNumber

string

25

Car Rental Agreement Number. Required as part of the Rental Key.

O

RentalDailyRateAmount

integer

8

Total rent amount per day. Implied decimal.

R

RentalDuration

integer

4

Car Rental Period.

O

RentalExtraChargesAmount

integer

8

Can rental special services amount. Implied decimal.

O

RentalInsuranceAmount

integer

8

Car insurance amount. Implied decimal.

O

MaxFreeMiles

integer

8

Total mileage for rent period.

O

MileRateAmount

integer

8

Total rent amount per mile. Implied decimal.

R

RentalName

string

20

Name of the person who rented the car.

O

RentalCity

string

25

City where the car rental starts.

O

RentalCountryCode

string

2

Country where the car rental starts.

R

RentalDate

date

10

Date when the car rental starts. (MM/DD/YYYY format)

O

RentalState

string

3

State where the car rental starts.

O

RentalTime

integer

4

Car rental start time in 24-Hour Format. (HHMM)

O

ReturnLocationCode

string

10

Identification code of the place where car was returned.

O

ReturnCity

string

25

City where the car is returned

O

ReturnCountryCode

string

2

Country where the car is returned.

R

ReturnDate

date

10

Date when the car should be returned.

O

ReturnState

string

3

State where the car is returned.

O

ReturnTime

integer

4

Time when the car should be returned in 24-Hour Format. (HHMM)

R

RentalSpecialProgramType

string

2

String based enum representing the special program type for the rental.
Accepted values are AD (Advance Deposit), AR (Assured Reservation),
DC (Delayed Charge), ES (Express Service), NC (Normal Charge),
and NS (No Show Charge).

O

TotalMiles

integer

8

Rented car total mileage (miles on car)

O

RentalExtraChargeItemCount

integer

4

Count of extra charges included in the transaction.

O

RentalExtraChargeItems

Collection

n/a

List of extra charges. See below.

R

RentalExtraChargeItemType

Enum

Car rental extra charge type

• M = Extra Mileage

• S = Gas

• N = Late Return

• W = One-Way Service

• P = Parking Violation

R

RentalExtraChargeTypeAmount

integer

8

Amount for car rental extra charge item. Implied decimal.

R

HealthCareAmt

integer

8

Indicates the portion of the amount field that was spent on healthcare-related services. Implied decimal.

O

TransitAmt

integer

8

Indicates the portion of the amount field that was spent on healthcare-related transportation. Implied decimal.

O

PrescriptionAmt

integer

8

Indicates the portion of the HealthCareAmt field that was spent on prescription drugs. Implied decimal.

O

VisionAmt

integer

8

Indicates the portion of the HealthCareAmt field that was spent on vision-related (optical) medical services. Implied decimal.

O

DentalAmt

integer

8

Indicates the portion of the HealthCareAmt field that was spent on dental medical services. Implied decimal.

O

ClinicAmt

integer

8

Indicates the portion of the HealthCareAmt field that was spent on hospitalization. Implied decimal.

O

IsQualifiedIIAS

Boolean

Indicates whether items purchased were verified against IIAS as qualified for healthcare purchases. Value must be True or False.

string AcquirePurchaseToken(string userName, string password, string certificationId, int transactionAmount, string purchaserInfo, string transactionInfo

R

userName

string

The username assigned for accessing BridgeComm

R

password

string

The password assigned to the user for accessing BridgeComm

O

certificationId

string

Not required. Default to and empty string. Reserved for future use.

R

transactionAmount

Int

8

The implied decimal amount of the transaction being preauthorized. (e.g. 125 for a $1.25 authorization)

O

purchaserInfo

string

Not required. A merchant provided string identifying the customer account the transaction is for. Compared with CustomerAccountCode element in the transaction request.

O

transactionInfo

string

Not required. A merchant provided string identifying the invoice the transaction is for. Compared with the InvoiceNum element in the transaction request.

R

AcctType

string

1

Single character, must be set to G

R

TransactionType

string

11

Can contain letters and hyphens. Possible values are sale and credit.

C

Amount

integer

8

For Activate, amount is the amount to put on the card. (Not required)
For Deactivate, amount is not required.
For Reactivate, amount to add to the current balance on the            card. (Required)
Processed as implied decimal. $1.25 would be represented as 125.

R

TransactionType

string

10

Identifies the administrative action to take. Can be Activate, Deactivate or Reactivate.

R

PaymentAccountNumber

integer

13-19

Must follow general Credit Card conventions. Supports MC, VI, AX, and DI.

R

AcctType

string

1

Single character, must be set to G

R

ExpirationDate

string

7

Expiration date of the card. If present, the supported format are: MMYY and MM/YY.

R

HolderType

string

1

Single character, either P (Personal account) or O (Organization account).

R

TransIndustryType

string

2

Must match a 2-letter pre-determined industry type. All caps.

Supported values are: RE (Retail), RS (Restaurant), EC (eCommerce), DM (Direct Marketing), LD (Lodging) and CR (Car Rental). HC is also supported for HealthCare, however internally transactions with industry type HC are converted to Retail (RE) transactions.

R

TransactionDate

DateTime

14

Date of the request. Format: yyyyMMddHHmmss

R

MerchantCode

integer

12

The default merchant code assigned to the user.

R

MerchantAccountCode

integer

12

The default merchant account code assigned to the user.

TransactionType

enum

10

Identifies the administrative action taken. Can be Activate, Deactivate or Reactivate.

GatewayTransID

integer

Identifies the BridgePay Gateway ID number of the request.