{"info":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"19035881","collectionId":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","publishedId":"2s93JnT6Vg","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"336699"},"publishDate":"2023-05-26T14:57:05.000Z"},"item":[{"name":"Overview","item":[{"name":"Introduction","item":[],"id":"7b4529d4-f972-431b-9bdd-0bda715e4bfd","description":"

The BridgePay TransactionAPI is a RESTful API for interfacing with the BridgePay Gateway. The API includes familiar transaction types from the BridgeComm API in a user friendly JSON interface.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"41c88517-2d22-458d-9131-74a751ee492d"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"8a48c60c-0a12-4333-b8f6-c89be97cd740"}}],"_postman_id":"7b4529d4-f972-431b-9bdd-0bda715e4bfd"},{"name":"Connection Strings","item":[],"id":"7aa002c0-ef61-403f-aa79-3da122fabf28","description":"

To connect to the Transaction API, use the following URLs:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Endpoint Description	Test URL	Production URL
Transaction	https://www.bridgepaynetsecuretest.com/Transaction.API/api/Transaction	https://www.bridgepaynetsecuretx.com/Transaction.API/api/Transaction
Tokenization	https://www.bridgepaynetsecuretest.com/Transaction.API/api/PaymentMethodToken	https://www.bridgepaynetsecuretx.com/Transaction.API/api/PaymentMethodToken
Settlement	https://www.bridgepaynetsecuretest.com/Transaction.API/api/batch/close	https://www.bridgepaynetsecuretx.com/Transaction.API/api/batch/close
BIN Lookup	https://www.bridgepaynetsecuretest.com/Transaction.API/api/BinLookup/{BIN}	https://www.bridgepaynetsecuretx.com/Transaction.API/api/BinLookup/{BIN}
Gift Card Activate	https://www.bridgepaynetsecuretest.com/Transaction.API/api/GiftCard/activate	https://www.bridgepaynetsecuretx.com/Transaction.API/api/GiftCard/activate
Gift Card Deactivate	https://www.bridgepaynetsecuretest.com/Transaction.API/api/GiftCard/deactivate	https://www.bridgepaynetsecuretx.com/Transaction.API/api/GiftCard/deactivate
Merchant Info	https://www.bridgepaynetsecuretest.com/Transaction.API/api/MerchantInfo	https://www.bridgepaynetsecuretx.com/Transaction.API/api/MerchantInfo
Account Verification	https://www.bridgepaynetsecuretest.com/Transaction.API/api/PaymentMethod/verify	https://www.bridgepaynetsecuretx.com/Transaction.API/api/PaymentMethod/verify
Balance Inquiry	https://www.bridgepaynetsecuretest.com/Transaction.API/api/PaymentMethod/balance	https://www.bridgepaynetsecuretx.com/Transaction.API/api/PaymentMethod/balance
Find Transaction	https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction/{gatewayTransID}?merchantAccountCode={merchantAccountCode}	https://www.bridgepaynetsecuretx.com/Transaction.API/api/transaction/{gatewayTransID}?merchantAccountCode={merchantAccountCode}
Capture	https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction/capture	https://www.bridgepaynetsecuretx.com/Transaction.API/api/transaction/capture
API Version	https://www.bridgepaynetsecuretest.com/Transaction.API/api/Version	https://www.bridgepaynetsecuretx.com/Transaction.API/api/Version

","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"a368dfda-bb7f-46ba-be17-50249226defc"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"93987473-bc16-4d5a-8315-59936eeb22e2"}}],"_postman_id":"7aa002c0-ef61-403f-aa79-3da122fabf28"},{"name":"Key Elements","item":[],"id":"5b4f362a-7faa-40b7-a9e6-5182e4a066d8","description":"

The Transaction API request and response structure is made up of a core set of data elements plus specific objects and their sub-elements. Each object handles a subsection of API data elements like payment data, Level II/III information, or Lodging elements. The core data elements are within the main request body and will include basic information like accountType, holderType, and transactionType.

A list of all required and optional data elements can be found in the Request & Response Information section.

In the live environment, transactions must be initiated over an SSL-protected connection using a minimum of 128-bit encryption to protect sensitive data. Initial testing can be performed over an unencrypted connection; however, testing must be performed over an SSL-encrypted channel before a client can be certified to production. Only test card/ACH account data may be transmitted. No live payment information should ever be transmitted to the test system.

Timeouts

The Transaction API has an internal timeout of 100 seconds. Integrating applications can expect all transactions to take less than 100 seconds, and if 100 seconds are exceeded without a response from the Transaction API, you may close your connection. If a transaction as attempted leveraging an invoiceNumber, you may use a Find Transaction request using your unique invoiceNumber to confirm the outcome of the transaction.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"9f536255-1e84-42ac-bff3-b6b6bc8ee274"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"8ebbe740-f160-4b14-a528-c91e6223cbc1"}}],"_postman_id":"5b4f362a-7faa-40b7-a9e6-5182e4a066d8"},{"name":"Process Flow","item":[],"id":"d117e6fa-fb13-47e8-8021-d71c210c16bc","description":"

The Transaction API uses a simple request and response process via HTTP POST and GET. The order of operations is to configure and send your HTTP POST or GET request and consume the response as desired.

Common response consumption practices are to retain the gatewayTransID, token, and expirationDate for follow on transactions.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"e80d3432-f88c-4171-80c0-d55bf5b3f778"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"7403257c-d40e-4999-b763-6610bdafbde2"}}],"_postman_id":"d117e6fa-fb13-47e8-8021-d71c210c16bc"},{"name":"Authentication Information","item":[],"id":"003d2970-34c6-4e97-bd95-8ffc644603d2","description":"

Each call to the Transaction API requires credentials; however, these credentials are not submitted in the request body. The username and password are values created in MyBridgePay, and they will be submitted in the request headers as Basic HTTP authentication.

The Credentials object is used as a property of other objects in the API. The Credentials Object contains two properties: username and password.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"eccd7cc8-fecf-4f8a-9f38-c419a3b5f5f0"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"c259940a-9ed9-4b38-af40-e77bd9a47676"}}],"_postman_id":"003d2970-34c6-4e97-bd95-8ffc644603d2"},{"name":"Sample Request & Response","item":[],"id":"2eae460a-a0c0-4fd6-9db7-bb569ef41b25","description":"

Request Format:

{\n  \"payment\": {\n    \"paymentAccountNumber\": \"string\",\n    \"expirationDate\": \"string\",\n    \"securityCode\": \"string\",\n    \"track1\": \"string\",\n    \"track2\": \"string\",\n    \"track3\": \"string\",\n    \"token\": \"string\",\n    \"bankAccountNumber\": \"string\",\n    \"routingNumber\": \"string\",\n    \"customerWalletId\": \"string\"\n  },\n  \"accountHolder\": {\n    \"name\": \"string\",\n    \"street\": \"string\",\n    \"city\": \"string\",\n    \"state\": \"string\",\n    \"zip\": \"string\",\n    \"countryCode\": \"string\",\n    \"phone\": \"string\",\n    \"email\": \"string\"\n  },\n  \"healthcare\": {\n    \"healthCareAmount\": 0,\n    \"transitAmount\": 0,\n    \"prescriptionAmount\": 0,\n    \"visionAmount\": 0,\n    \"dentalAmount\": 0,\n    \"clinicAmount\": 0,\n    \"isQualifiedIIAS\": true,\n    \"copayAmount\": 0\n  },\n  \"tip\": {\n    \"tipAmount\": 0,\n    \"tipRecipientCode\": \"string\"\n  },\n  \"level2\": {\n    \"taxRate\": 0,\n    \"taxAmount\": 0,\n    \"taxIndicator\": \"string\",\n    \"shipToName\": \"string\",\n    \"shipToStreet\": \"string\",\n    \"shipToCity\": \"string\",\n    \"shipToState\": \"string\",\n    \"shipToZip\": \"string\",\n    \"shipToCountryCode\": \"string\"\n  },\n  \"level3\": {\n    \"shippingOriginZip\": \"string\",\n    \"discountAmount\": 0,\n    \"shippingAmount\": 0,\n    \"dutyAmount\": 0,\n    \"taxInvoiceCode\": \"string\",\n    \"localTaxAmount\": 0,\n    \"localTaxIndicator\": \"string\",\n    \"nationalTaxAmount\": 0,\n    \"nationalTaxIndicator\": \"string\",\n    \"orderCode\": \"string\",\n    \"orderDate\": \"string\",\n    \"commodityCode\": \"string\",\n    \"customerAccountTaxId\": \"string\",\n    \"items\": [\n      {\n        \"code\": \"string\",\n        \"commodityCode\": \"string\",\n        \"description\": \"string\",\n        \"quantity\": 0,\n        \"unitCostAmount\": 0,\n        \"unitMeasure\": \"string\",\n        \"taxAmount\": 0,\n        \"taxRate\": 0,\n        \"taxIndicator\": \"string\",\n        \"taxCode\": \"string\",\n        \"discountRate\": 0,\n        \"discountAmount\": 0,\n        \"totalAmount\": 0,\n        \"isCredit\": true\n      }\n    ]\n  },\n  \"lodging\": {\n    \"roomNumber\": \"string\",\n    \"folioNumber\": \"string\",\n    \"roomRateAmount\": 0,\n    \"roomTaxAmount\": 0,\n    \"lodgingChargeType\": \"string\",\n    \"checkInDate\": \"2022-11-08T18:17:45.024Z\",\n    \"checkOutDate\": \"2022-11-08T18:17:45.024Z\",\n    \"duration\": 0,\n    \"specialProgramType\": \"string\",\n    \"departureAdjustmentAmount\": 0,\n    \"lodgingItems\": [\n      {\n        \"type\": \"string\",\n        \"amount\": 0\n      }\n    ]\n  },\n  \"carRental\": {\n    \"maxFreeMiles\": 0,\n    \"mileRateAmount\": 0,\n    \"agreementNumber\": \"string\",\n    \"city\": \"string\",\n    \"class\": \"string\",\n    \"countryCode\": \"string\",\n    \"date\": \"2022-11-08T18:17:45.024Z\",\n    \"duration\": 0,\n    \"dailyRateAmount\": 0,\n    \"extraChargesAmount\": 0,\n    \"insuranceAmount\": 0,\n    \"name\": \"string\",\n    \"state\": \"string\",\n    \"time\": \"string\",\n    \"returnLocationCode\": \"string\",\n    \"returnDate\": \"2022-11-08T18:17:45.024Z\",\n    \"returnState\": \"string\",\n    \"returnTime\": \"string\",\n    \"returnCity\": \"string\",\n    \"returnCountryCode\": \"string\",\n    \"specialProgramType\": \"string\",\n    \"totalMiles\": 0,\n    \"extraChargeItems\": [\n      {\n        \"type\": \"string\",\n        \"amount\": 0\n      }\n    ]\n  },\n  \"serviceFees\": [\n    {\n      \"serviceFeeId\": \"string\",\n      \"resellerCode\": \"string\",\n      \"merchantAccountCode\": \"string\",\n      \"amount\": 0,\n      \"serviceUser\": \"string\",\n      \"servicePassword\": \"string\",\n      \"wallet\": \"string\",\n      \"walletPaymentMethodID\": \"string\"\n    }\n  ],\n  \"dynamicDescriptors\": {\n    \"address\": \"string\",\n    \"city\": \"string\",\n    \"countryCode\": \"string\",\n    \"county\": \"string\",\n    \"emailAddress\": \"string\",\n    \"postalCode\": \"string\",\n    \"region\": \"string\",\n    \"text\": \"string\"\n  },\n  \"transactionID\": \"string\",\n  \"merchantAccountCode\": \"string\",\n  \"accountType\": \"string\",\n  \"holderType\": \"string\",\n  \"amount\": 0,\n  \"feeAmount\": 0,\n  \"feeIsSurcharge\": true,\n  \"partialAuthorization\": true,\n  \"transIndustryType\": \"string\",\n  \"referenceNumber\": \"string\",\n  \"transactionType\": \"string\",\n  \"transCatCode\": \"string\",\n  \"descriptor\": \"string\",\n  \"transactionMode\": \"string\",\n  \"cashBackAmount\": 0,\n  \"settlementDelay\": \"string\",\n  \"voiceAuthCode\": \"string\",\n  \"voucherNumber\": \"string\",\n  \"walletPaymentMethodId\": \"string\",\n  \"invoiceNumber\": \"string\",\n  \"purchaseOrderNumber\": \"string\",\n  \"customerAccountCode\": \"string\",\n  \"laneCode\": \"string\",\n  \"estimatedAmountIndicator\": true,\n  \"cardHolderPresent\": true,\n  \"originatingTechnologySource\": \"string\",\n  \"originatingSoftwareVendor\": \"string\",\n  \"accountDescription\": \"string\",\n  \"contractID\": 0,\n  \"webLinkWalletToken\": \"string\",\n  \"webLinkWalletKey\": \"string\",\n  \"storedCredential\": \"string\",\n  \"networkReferenceNumber\": \"string\",\n  \"memo\": \"string\",\n  \"customFields\": [\n    {\n      \"name\": \"string\",\n      \"value\": \"string\"\n    }\n  ]\n}\n\n

Response Format:

{\n  \"transactionID\": \"string\",\n  \"requestType\": \"string\",\n  \"responseCode\": \"string\",\n  \"responseDescription\": \"string\",\n  \"cardType\": \"string\",\n  \"token\": \"string\",\n  \"authorizationCode\": \"string\",\n  \"referenceNumber\": \"string\",\n  \"gatewayResult\": \"string\",\n  \"authorizedAmount\": 0,\n  \"originalAmount\": 0,\n  \"expirationDate\": \"string\",\n  \"avsResult\": \"string\",\n  \"avsMessage\": \"string\",\n  \"streetMatchMessage\": \"string\",\n  \"zipMatchMessage\": \"string\",\n  \"cvResult\": \"string\",\n  \"cvMessage\": \"string\",\n  \"isCommercialCard\": \"string\",\n  \"gatewayTransID\": \"string\",\n  \"gatewayMessage\": \"string\",\n  \"internalMessage\": \"string\",\n  \"balance\": 0,\n  \"cashBackAmount\": 0,\n  \"currencyCode\": \"string\",\n  \"transactionCode\": \"string\",\n  \"transactionDate\": \"string\",\n  \"remainingAmount\": 0,\n  \"isoCountryCode\": \"string\",\n  \"isoCurrencyCode\": \"string\",\n  \"isoTransactionDate\": \"2022-11-08T18:17:45.038Z\",\n  \"isoRequestDate\": \"2022-11-08T18:17:45.038Z\",\n  \"networkReferenceNumber\": \"string\",\n  \"merchantCategoryCode\": \"string\",\n  \"networkMerchantId\": \"string\",\n  \"networkTerminalId\": \"string\",\n  \"maskedPAN\": \"string\",\n  \"responseTypeDescription\": \"string\",\n  \"walletID\": \"string\",\n  \"walletPaymentMethodID\": \"string\",\n  \"walletResponseMessage\": \"string\",\n  \"walletResponseCode\": \"string\",\n  \"cardClass\": \"string\",\n  \"cardModifier\": \"string\",\n  \"cardHolderName\": \"string\",\n  \"providerResponseCode\": \"string\",\n  \"providerResponseMessage\": \"string\",\n  \"organizationId\": \"string\",\n  \"merchantAccountCode\": \"string\",\n  \"serviceFeeResults\": [\n    {\n      \"serviceFeeID\": \"string\",\n      \"authorizationCode\": \"string\",\n      \"referenceNumber\": \"string\",\n      \"gatewayResult\": \"string\",\n      \"authorizedAmount\": 0,\n      \"originalAmount\": 0,\n      \"gatewayTransID\": \"string\",\n      \"gatewayMessage\": \"string\",\n      \"internalMessage\": \"string\",\n      \"providerResponseCode\": \"string\",\n      \"providerResponseMessage\": \"string\"\n    }\n  ],\n  \"customFields\": [\n    {\n      \"name\": \"string\",\n      \"value\": \"string\"\n    }\n  ],\n  \"routingNumber\": \"string\"\n}\n\n

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"8c828e74-d5a2-4934-a93d-d53d76b4954f"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"1f0fef65-81a8-4fb1-8c18-6984b0627ce7"}}],"_postman_id":"2eae460a-a0c0-4fd6-9db7-bb569ef41b25"}],"id":"213d639d-4f51-4212-a7cc-3a31a1c2b649","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"457c0de3-d5aa-43a3-a571-a22bbfc902e7"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"bc97c66b-de82-4568-a6b3-cf96424259cd"}}],"_postman_id":"213d639d-4f51-4212-a7cc-3a31a1c2b649","description":""},{"name":"Integration Support","item":[],"id":"63520fae-1a37-49f8-bb37-84c4386565fe","description":"

A test or live merchant account with BridgePay is necessary to successfully process transactions. To acquire a test account, complete the test account request form located on the BridgePay Integrator Support Portal.

To review additional documentation, please visit the Developer Center. For Integrations Assistance, please Enter a Case.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"023eaa49-7383-4a39-b41f-1b53a5dfa2f0"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"319c52ec-e7bf-416e-b208-ce201334fe53"}}],"_postman_id":"63520fae-1a37-49f8-bb37-84c4386565fe"},{"name":"Request & Response Information","item":[],"id":"4185ed3f-6200-4a1c-a48d-7700262189db","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Legend
R = Required
O = Optional
C = Conditional
1 = Required if not sending Track Data
3 = ACH/Checks

Request Information

The following data elements are available for use in the base TransactionRequest:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
R	transactionID	string	60	A unique value, generated by the integrating application, used to identify the transaction.
R	merchantAccountCode	string		The Merchant Account Code assigned to the merchant gateway at time of boarding in MyBridgePay.
O	organizationId	string		The organization id for the merchant account processing the transaction. This is the value used in the Boarding, Wallet, and Recurring APIs. When provided do not provide a merchantAccountCode.
R	accountType	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). For Level III transactions, holderType must be set to O.
R	amount	integer	8	The amount requested for authorization. This value is the total that will be charged. This value should include any fee amount or tip amount. Processed as implied decimal. $1.25 would be represented as 125.
R	transIndustryType	string	2-3	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)
O	feeAmount	integer	8	The fee dollar amount for the transaction. This value is not added to the amount value of the transaction, so the amount/Amount should reflect the base amount plus the fee amount. Processed as implied decimal. $1.25 would be represented as 125. NOTE: Only include the feeAmount element if it is a populated value. Do not send if empty.
O	feeIsSurcharge	boolean		Indicates whether the feeAmount provided is for a Surcharge transaction. If true, and feeAmount is provided, the fee will be processed as a surcharge. If false or not provided and feeAmount is provided, the fee will be processed as a convenience fee. Read as \"Fee Is Surcharge\".
O	partialAuthorization	boolean	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.
O	referenceNumber	string	12	The GatewayTransId returned as a part of the response to a sale request. Used to process follow on transactions by referencing a prior transaction.
R	transactionType	string	11	Can contain letters and hyphens. Possible values: sale, sale-auth, credit, credit-auth, increment, sale-info, credit-info, adjustment, push-payment
O	transCatCode	string	1	All capital letters. Supported values are: B (BillPayment), R (Recurring), I (Installment), H (Healthcare).
O	descriptor	string	30	The message descriptor. Cannot contain the following characters: \"(\"
R	transactionMode	string	1	P = Card Present or N = Card Not Present
O	cashBackAmount	integer	8	Amount of money returned to a payment card holder. Used for Sale with cash back transactions. Processed as implied decimal. $20.00 would be represented as 2000.
O	settlementDelay	string	2	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. This setting applies to API transactions only and overrides the \"Default Action Delay\" setting in MyBridgePay. If sending Lodging data, this value will overwrite the duration data element which normally sets the settlementDelay. This feature is not available on First Data Omaha. Do not use. 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	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	voucherNumber	string	15	For use in EBT voucher clear transactions only.
O	walletPaymentMethodId	string	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	invoiceNumber	string	24	Invoice number. Spaces are not allowed. Alphanumeric and dashes accepted. User supplied data. (Required if sending Level II/III data)
O	purchaseOrderNumber	string	24	Alphanumeric and dashes accepted. User supplied data.
O	customerAccountCode	string	24	Alphanumeric and dashes accepted. User supplied data.
O	laneCode	string		User supplied data.
O	estimatedAmountIndicator	boolean	5
O	cardHolderPresent	boolean	5
R	originatingSoftwareVendor	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.
	accountDescription	string		User supplied data.
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	webLinkWalletToken	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	webLinkWalletKey	string		A base64 encoded string representation of the authentication key created to use the wallet token described above.
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. The networkReferenceNumber for a VISA transaction will be 15 digits while one for a MasterCard transaction will be 13 characters with two spaces appended to the end. The spaces should be omitted when sent on subsequent transactions.
O	voidReasonCode	string	20	denitifies 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. If Memo element and the PaymentType element are provided, the Memo element will take precedence. This field may NOT contain the following characters: “, *, &, <, >

The following schema are accepted for specific industry types or added functionality:

Payment Data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
1	paymentAccountNumber	string	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.
1	expirationDate	string	22	Expiration date of the card. If present, the supported format are: MMYY and MM/YY. Required if track data not present.
O	securityCode	string	3-4	When present, must be 3 or 4 digits long CVV / CVV2 of the card.
C	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.
C	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.
C	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	token	string	16-20	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. This may be between 16 and 20 digits depending on the age of the token.
3	bankAccountNumber	string		The bank account number for ACH and Check transactions. Must contain at least one number.
3	routingNumber	string	10	The routing number for ACH and Check transactions. Can contain up to 10 numbers.
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).

Device

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
O	appHostMachineID	string	10-36	The unique identifier of PC. Valid input are characters a-f, A-F, 0-9, and - (dashes).
O	EncryptionID	string		The encryption ID identifying the type of encryption used on the sensitive card holder data.
O	BDKSlot	integer	2	When present, indicates the Base Derived Key slot to use as an override for Hardware Decryption.
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	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	MSRKSN	string	20	The terminal's P2PE KSN value obtained from the device.

AccountHolder

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
O	name	string	150	Name on the credit card or ACH account. Any upper or lower case letter, hyphens, and spaces are allowed.
O	street	string	128	Street associated with the account. Can contain alphanumerics, spaces, hyphens, periods and slashes.
O	city	string	50	City associated with the account. Can contain alphanumerics, spaces, hyphens, periods and slashes.
O	state	string	2	State associated with the account. Can contain alphanumerics, spaces, hyphens, periods and slashes.
O	zip	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. Canadian Format: A1A 1A1 UK Format: PO16 7GZ US Format (5 Digits): 12345 US Format (5 Digits): 123451234
O	countryCode	string	2	Country code associated with the account. Can contain alphanumerics, spaces, hyphens, periods and slashes.
O	phone	string	10-11	Billing phone number. Numerics only. No special characters allowed.
O	email	string	60	Email address associated with the account. Can contain alphanumerics, spaces, hyphens, periods and slashes.

CarRental

Required	Data Element	Data Type	Length	Description
O	maxFreeMiles	integer	8	Total mileage for rent period.
O	mileRateAmount	integer	8	Total rent amount per mile. Implied decimal.
C	agreementNumber	string	25	Car Rental Agreement Number. Required as part of the Rental Key.
O	city	string	25	City where the car rental starts.
O	class	string		The class of car.
O	countryCode	string	2	Country where the car rental starts.
C	date	date	10	Date when the car rental starts. (MM/DD/YYYY format)
C	duration	integer	4	Car Rental Period in days.
O	dailyRateAmount	integer	8	Total rent amount per mile. Implied decimal.
O	extraChargesAmount	integer	8	Total dollar amount of extraChargeItems. Implied decimal.
O	insturanceAmount	integer	8	Car insurance amount. Implied decimal.
C	name	string	20	Name of the person who rented the car.
O	state	string	3	State where the car rental starts.
O	time	integer	4	Car rental start time in 24-Hour Format. (HHMM)
O	returnLocationCode	string	10	Identification code of the place where car was returned.
C	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)
O	returnCity	strgin	25	City where the car is returned
O	returnCountryCode	string	2	Country where the car is returned.
C	specialProgramType	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	extraChargeItems	object	n/a	List of extra charges. See below.

CarRentalExtraChargeItem

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
C	rentalExtraChargeItemType	string	1	Car rental extra charge type: M = Extra Mileage S = Gas N = Late Return W = One-Way Service P = Parking Violation
C	rentalExtraChargeTypeAmount	integer	8	Amount for car rental extra charge item. Implied decimal.

CustomField

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
C	name	string		The name defined for the custom field.
C	value	string		The value for the custom field.

DynamicDescriptors

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
C	address	string	38	Used to modify Dynamic Descriptor Address where supported with processors
C	city	string	38	Used to modify Dynamic Descriptor City where supported with processors
C	countryCode	string	21	Used to modify Dynamic Descriptor Country Code where supported with processors
C	county	string	21	Used to modify Dynamic Descriptor County where supported with processors
C	emailAddress	string	21	Used to modify Dynamic Descriptor Email Address where supported with processors
C	postalCode	string	15	Used to modify Dynamic Descriptor Postal Code where supported with processors
C	region	string	3	Used to modify Dynamic Descriptor Region where supported with processors
C	text	string	60	Used to modify Dynamic Descriptor Name or Text where supported with processors

Healthcare

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
C	healthCareAmount	integer	8	The portion of the Total Amount spent on healthcare related services or products. Processed as implied decimal. $1.25 would be represented as 125.
C	transitAmount	integer	8	The portion of the Total Amount spent on healthcare related transportation. Processed as implied decimal. $1.25 would be represented as 125.
C	prescriptionAmount	integer	8	The portion of the Healthcare Amount spent on prescription drugs or products. Processed as implied decimal. $1.25 would be represented as 125.
C	visionAmount	integer	8	The portion of the Healthcare Amount spent on vision related medical services. Processed as implied decimal. $1.25 would be represented as 125.
C	dentalAmount	integer	8	The portion of the Healthcare Amount spent on dental related medical services. Processed as implied decimal. $1.25 would be represented as 125.
C	clinicAmount	integer	8	The portion of the Healthcare Amount spent on hospitalization. Processed as implied decimal. $1.25 would be represented as 125.
C	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	copayAmount	integer	8	The copay amount of the transaction. Processed as implied decimal. $1.25 would be represented as 125.

Level2

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
C	taxRate	integer	5	Additional Tax Amount. REQUIRED FOR LEVEL II/III. Processed as implied decimal. 5.5% would be represented as 550.
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	ISO 3166-1 alpha-2 codes.Shipping address country code. REQUIRED FOR LEVEL II/III.

Level3

Required	Data Element	Data Type	Length	Description
C	shippingOriginZip	string	10	Postal code of the origin of the shipment. 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. REQUIRED FOR LEVEL III.
C	discountAmount	integer	8	Processed as implied decimal. $1.25 would be represented as 125. Additional discount amount. REQUIRED FOR LEVEL III.
C	shippingAmount	integer	8	Processed as implied decimal. $1.25 would be represented as 125. Additional discount amount. REQUIRED FOR LEVEL III.
C	dutyAmount	integer	8	Processed as implied decimal. $1.25 would be represented as 125. Additional discount amount. REQUIRED FOR LEVEL III.
C	taxInvoiceCode	string	15	Must be at least 1 and up to 15 characters. When separate VAT invoice is produced within the context of the order, unique identifier of this invoice. REQUIRED FOR LEVEL III.
C	localTaxAmount	integer	8	Processed as implied decimal. $1.25 would be represented as 125. Additional Local Tax Amount. REQUIRED FOR LEVEL III.
C	localTaxIndicator	string	1	P (Provided), N (Not Provided), or E (Exempt). REQUIRED FOR LEVEL III.
C	nationalTaxAmount	integer	8	Processed as implied decimal. $1.25 would be represented as 125. Additional National Tax Amount. REQUIRED FOR LEVEL III.
C	nationalTaxIndicator	string	1	P (Provided), N (Not Provided), or E (Exempt). REQUIRED FOR LEVEL III.
C	orderCode	string	17	Unique identifier assigned to the order associated with this transaction in submitter's/merchant's front-end/ inventory system. REQUIRED FOR LEVEL III.
C	orderDate	string	8	Date in format YYYYMMDD. Date when the order associated with the transaction was placed. REQUIRED FOR LEVEL III.
C	commodityCode	string	4	Acquirer designated standardized code that classifies the group of items associated with this order/transaction. REQUIRED FOR LEVEL III.
C	customerAccountTaxId	string	13	VAT registration number of the customer responsible for this transaction. REQUIRED FOR LEVEL III
C	items	object		The Level3Item object outlined in the following table. REQUIRED FOR LEVEL III.

Level3Item

Data Element	Data Type	Length	Description
code	string	12	Unique identifier assigned to this item in the submitter’s inventory system.
commodityCode	string	12	Acquirer designated standardized code that classifies this item.
description	string	35	Short description of the item.
quantity	integer	12	Quantity of item units purchased as part of this transaction. Up to 4 decimal places.
unitCostAmount	integer	12	Cost of a single unit of the item. Processed as implied decimal. $1.25 would be represented as 125.
unitMeasure	string	12	Unit of measure used to quantify the items purchased/refunded (e.g. kg, lb., inch).
taxAmount	integer	8	Processed as implied decimal. $1.25 would be represented as 125. Amount of tax charged for this item.
taxRate	integer	12	Rate of the tax (if any) charged on this item. Processed as implied decimal. 5.5% would be represented as 550.
taxIndicator	string	1	P (Provided), N (Not provided), or E (Exempt).
taxCode	string	4	Acquirer designated value classifying the tax that was charged for this item.
discountRate	integer	8	Rate of discount (if any) that was applied to this item. Processed as implied decimal. 5.5% would be represented as 550.
discountAmount	integer	8	Total amount of discount applied to this item. Processed as implied decimal. $1.25 would be represented as 125.
totalAmount	integer	8	Total amount paid for the item (including tax and discount). Processed as implied decimal. $1.25 would be represented as 125.
isCredit	boolean	1	True (Item is being returned), False (Default if not passed - Item is being purchased).

Lodging

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
C	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'
C	roomTaxAmount	integer	8	Tax charged on daily rate. Implied decimal. This amount shall not exceed RoomRateAmount
C	lodgingChargeType	string	1	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	string		The date of actual or anticipated check-in. Required when LodgingChargeType = 'H'
C	checkOutDate	string		The date of actual or anticipated check-out Required when LodgingChargeType = 'H'
C	duration	integer		Indicates the length of anticipated, actual or incremental stay.
C	specialProgramType	string	2	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'
C	departureAdjustmentAmount	integer	8	Additional amount charged after the cardholder left the hotel.
C	lodgingItems	object		The lodgingItems object.

LodgingItem

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
C	type	string	1	Lodging extra charge type : G = Gift Shop L = Laundry B = Mini bar R = Restaurant T = Telephone
C	amount	integer	8	Amount for lodging extra charge item. Implied decimal.

Payment

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
1	paymentAccountNumber	string	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.
1	expirationDate	string	22	Expiration date of the card. If present, the supported format are: MMYY and MM/YY. Required if track data not present.
O	securityCode	string	3-4	When present, must be 3 or 4 digits long CVV / CVV2 of the card.
C	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.
C	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.
C	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	token	string		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.
3	bankAccountNumber	string		The bank account number for ACH and Check transactions. Must contain at least one number.
3	routingNumber	string	10	The routing number for ACH and Check transactions. Can contain up to 10 numbers.
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).

ServiceFee

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
C	serviceFeeId	string		A user-defined identifier that will be returned in the response
O	resellerCode	string		The code of the reseller that owns the service merchant account. Use if not providing service credentials.
C	merchantAccountCode	string		The code of the service merchant account. Use if not providing service credentials.
C	amount	integer		The implied decimal implementation of the service fee amount.
C	serviceUser	string		The username associated with the merchant service fee account. Use if not providing ResellerCode, MerchantCode and MerchantAccountCode.
C	servicePassword	string		The password associated with the merchant service fee account. Use if not providing ResellerCode, MerchantCode and MerchantAccountCode.
O	wallet	string	3	The ability to create a wallet within processing a request by setting to \"new.\"
O	walletPaymentMethodID	string	36	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)

Tip

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
C	tipAmount	integer	8	Additional Tip Amount. This value is not added to the amount value of the transaction, so the amount should reflect the base amount plus the tip amount. Processed as implied decimal. $1.25 would be represented as 125. Note: Only transIndustryType RE(Retail) and RS(Restaurant) are supported for tip adjustment.
C	tipRecipientCode	string	15	CServer ID for the customer. an contain alphanumerics, hyphens, and periods.

Response Information

TransactionResponse

Data Element	Data Type	Length	Description
transactionID	string		Echo back of the TransactionID.
requestType	string		Echo back of the requestType
responseCode	string	8	Any amount of the original authorization remaining after this void / refund. This amount is in implied decimal format (i.e. $19.95 = 1995).
responseDescription	string	255	Displays the response message as provided by the Processor.
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.
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.
authorizationCode	string	50	The transaction authorization code returned from the processor.
referenceNumber	string		Returns the networkReferenceNumber returned by the processor for the transaction. For use with Card On File transactions.
gatewayResult	string		ResponseCode for the transaction. Indicates success or error.
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.
routingNum	string		Echo back of the routing number.
avsResult	string		Unipay AVS Match Result Code.
avsMessage	string		Unipay AVS Match Result Message.
streetMatchMessage	string		Message indicating the match status of the street.
zipMatchMessage	string		Message indicating the match status of the ZIP.
cvResult	string		CVV/CVV2 Match Result Code.
cvMessage	string		CVV/CVV2 Match Result Message.
isCommercialCard	string		Indicator showing whether the card is a Commercial Card.
gatewayTransID	string		Transaction ID from the gateway (used as Reference Number for Voids / Refunds).
gatewayMessage	string		Response message from the gateway.
internalMessage	string		Provides more information from the gateway and processor regarding the results of the transaction request.
balance	integer		The current balance of the card processed.
cashBackAmount	integer		The cash back amount for the transaction.
currencyCode	string		Echo of the currency code provided in the transaction.
transactionCode	string		Echo of the transactionID provided in the transaction.
transactionDate	string		Echo back of the transactionDate.
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		Echo of the isoCountryCode for the transaction.
isoCurrencyCode	string		Echo of the isoCurrencyCode for the transaction.
isoTransactionDate	string		Echo of the isoTransactionDate for the transaction.
isoRequestDate	string		Echo of the isoRequestDate for the transaction.
networkReferenceNumber	string		Returns the networkReferenceNumber returned by the processor for the transaction. For use with Card On File transactions.
merchantCategoryCode	string		The merchantCategoryCode Returned tag data for generating the receipt.
networkMerchantId	string	20
networkTerminalId	string	20
maskedPAN	string		The masked card number from the transaction
responseTypeDescription	string		The description for the response.
walletID	string		The WalletID associated with the transaction.
walletPaymentMethodID	string		The walletPaymentMethodID associated with the transaction.
walletResponseMessage	string		The wallet response message for the transaction.
walletResponseCode	string		The wallet response code for the transaction.
cardBIN	string	6-8	Displays up to the first 8 digits of the card.
cardClass	string	25	Displays the tender type used to process a transaction. List of values: Credit, Debit, Gift, Prepaid, EBT, Fleet, None
cardIdentifier	string		Displays whether the card is a debit or credit card.
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.
cardType	string		The card brand of the card (Visa, Mastercard, Discover, Amex)
providerResponseCode	string	25	Displays the response code as provided by the Processor.
providerResponseMessage	string	255	Displays the response message as provided by the Processor.
organizationId	string		The organizationID associated with the transaction.
merchantAccountCode	string		The merchantAccountCode on which the transaction was processed.
routingNumber	string		The routing number used in the transaction.

serviceFeeResults

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Data Element	Data Type	Length	Description
serviceFeeID	string		The user-defined identifier associated with the service fee request
authorizationCode	string	50	The transaction authorization code returned from the processor.
referenceNumber	string		The network reference number for the service fee transaction.
gatewayResult	string		5 digit response code for the result of the service fee request
authorizedAmount	integer		Implied decimal representation of the amount that was authorized/charged/refunded.
originalAmount	integer		Implied decimal representation of the amount that was requested to be authorized/charged/refunded.
gatewayTransID	string		Transaction ID from the gateway (used as Reference Number for Voids / Refunds).
gatewayMessage	string		Response message from the gateway for the transaction.
internalMessage	string		Provides more information from the gateway and processor regarding the results of the transaction request.
providerResponseCode	string		Displays the response code as provided by the Processor for the Service Fee transaction.
providerResponseMessage	string		Displays the response message as provided by the Processor for the Service Fee transaction.

customFields

The customFields object returns the information pertaining to the custom fields provided in the request.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Data Element	Data Type	Length	Description
name	string		The returned name of the customField provided in the request.
value	string		The returned value of the customFiled provided in the request.

","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"617f771b-c424-46bf-b75f-887ae56604d1"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"f8d85f98-d3d4-4c7a-9de3-41667ea0c1cc"}}],"_postman_id":"4185ed3f-6200-4a1c-a48d-7700262189db"},{"name":"Specific Request Layouts","item":[{"name":"Card Present (CP)","item":[{"name":"Authorization/Sale (CP)","item":[{"name":"EMV Authorization (CP)","id":"d20fb927-4cb0-4d50-bf34-2c66a3865be8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"emvTags\": \"4F07A0000000031010500A5669736120446562697457104450649200973734D19092260003680F82023C008407A0000000031010950508000000009A03150439B02E8009C01005F2A0208405F3401019F02060000000005009F0607A00000000310109F0902008C9F100706010A03A020009F120A5669736120446562697491A0208409F1E0838303234373636319F21032109149F2608FA940EE08082F8A59F2701809F3303E0B8C89F34031E03009F3501229F360200109F37043F2BE809F3901059F4005F000F0A0019F4104000003819F5301529990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\",\r\n \"securityCode\": \"123\",\r\n \"track1\": \"9990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\"\r\n },\r\n \"device\": {\r\n \"appHostMachineID\": \"7C0595DE6CD1D30633\",\r\n \"deviceFirmware\": \"0504\",\r\n \"deviceMake\": \"Ingenico\",\r\n \"deviceModel\": \"Lane7000_MSR\",\r\n \"deviceSerial\": \"12312312\",\r\n \"entryMedium\": \"CC\",\r\n \"entryMode\": \"HP\",\r\n \"entryPINMode\": \"S\",\r\n \"kernelVersion\": \"090100\",\r\n \"MSRKSN\": \"FFFF987987000020004D\",\r\n \"terminalCapabilities\": \"manual|stripe|icc|signature|rfid|contactless\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test Name\",\r\n \"zip\": \"22222\"\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale-auth\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"RE\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"P\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following example shows how to process a credit card authorization using EMV card data.

The following example shows how to process a credit card authorization using swipe card data.

The following example shows how to process a credit card sale using EMV card data.

The following example shows how to process a credit card sale using swipe card data.

The following section outlines how to process an Authorization or Sale transaction type using the Transaction API.

Card Present

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
1	paymentAccountNumber	string	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.
1	expirationDate	string	22	Expiration date of the card. If present, the supported format are: MMYY and MM/YY. Required if track data not present.
O	securityCode	string	3-4	When present, must be 3 or 4 digits long CVV / CVV2 of the card.
C	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.
C	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.
C	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	token	string		When present, represents the tokenized card number received from a token request. This is used in place of the paymentAccountNumber.
3	bankAccountNumber	string		The bank account number for ACH and Check transactions. Must contain at least one number.
3	routingNumber	string	10	The routing number for ACH and Check transactions. Can contain up to 10 numbers.
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).

","event":[{"listen":"prerequest","script":{"id":"31822c26-c8f1-44e4-9a9d-789002481318","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"eef1524b-e9f6-408b-af06-47e8aadb9fe1","type":"text/javascript","exec":[""]}}],"_postman_id":"ec3465b4-44a0-4474-ac9f-7ef084a93249","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Debit (CP)","item":[{"name":"Debit Sale (CP)","id":"fd7ea53b-e1ad-4631-8d24-107fab11f8c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"emvTags\": \"4F07A0000000031010500A5669736120446562697457104450649200973734D19092260003680F82023C008407A0000000031010950508000000009A03150439B02E8009C01005F2A0208405F3401019F02060000000005009F0607A00000000310109F0902008C9F100706010A03A020009F120A5669736120446562697491A0208409F1E0838303234373636319F21032109149F2608FA940EE08082F8A59F2701809F3303E0B8C89F34031E03009F3501229F360200109F37043F2BE809F3901059F4005F000F0A0019F4104000003819F5301529990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\",\r\n \"securityCode\": \"123\",\r\n \"track1\": \"9990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\",\r\n \"dukpt\": \"000000008F000021\",\r\n \"pinCode\": \"623F36B53CC18393\"\r\n },\r\n \"device\": {\r\n \"appHostMachineID\": \"7C0595DE6CD1D30633\",\r\n \"deviceFirmware\": \"0504\",\r\n \"deviceMake\": \"Ingenico\",\r\n \"deviceModel\": \"Lane7000_MSR\",\r\n \"deviceSerial\": \"12312312\",\r\n \"entryMedium\": \"CC\",\r\n \"entryMode\": \"HP\",\r\n \"entryPINMode\": \"S\",\r\n \"kernelVersion\": \"090100\",\r\n \"MSRKSN\": \"FFFF987987000020004D\",\r\n \"terminalCapabilities\": \"manual|stripe|icc|signature|rfid|contactless\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test Name\",\r\n \"zip\": \"22222\"\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"RE\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"P\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following example shows how to process a debit card sale using data read from a card.

The following section outlines how to process Debit transaction type using the Transaction API.

payment

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
1	paymentAccountNumber	string	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.
1	expirationDate	string	22	Expiration date of the card. If present, the supported format are: MMYY and MM/YY. Required if track data not present.
O	securityCode	string	3-4	When present, must be 3 or 4 digits long CVV / CVV2 of the card.
C	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.
C	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.
C	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	token	string		When present, represents the tokenized card number received from a token request. This is used in place of the paymentAccountNumber.
3	bankAccountNumber	string		The bank account number for ACH and Check transactions. Must contain at least one number.
3	routingNumber	string	10	The routing number for ACH and Check transactions. Can contain up to 10 numbers.
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).

","event":[{"listen":"prerequest","script":{"id":"31822c26-c8f1-44e4-9a9d-789002481318","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"eef1524b-e9f6-408b-af06-47e8aadb9fe1","type":"text/javascript","exec":[""]}}],"_postman_id":"be716621-a1a5-4c1b-b3be-f648d4631df1","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Bar Tab (CP)","item":[{"name":"EMV Authorization (CP)","id":"c09b9a20-28b4-4e04-9b8f-87f1caa0265e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"emvTags\": \"4F07A0000000031010500A5669736120446562697457104450649200973734D19092260003680F82023C008407A0000000031010950508000000009A03150439B02E8009C01005F2A0208405F3401019F02060000000005009F0607A00000000310109F0902008C9F100706010A03A020009F120A5669736120446562697491A0208409F1E0838303234373636319F21032109149F2608FA940EE08082F8A59F2701809F3303E0B8C89F34031E03009F3501229F360200109F37043F2BE809F3901059F4005F000F0A0019F4104000003819F5301529990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\",\r\n \"securityCode\": \"123\",\r\n \"track1\": \"9990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\"\r\n },\r\n \"device\": {\r\n \"appHostMachineID\": \"7C0595DE6CD1D30633\",\r\n \"deviceFirmware\": \"0504\",\r\n \"deviceMake\": \"Ingenico\",\r\n \"deviceModel\": \"Lane7000_MSR\",\r\n \"deviceSerial\": \"12312312\",\r\n \"entryMedium\": \"CC\",\r\n \"entryMode\": \"HP\",\r\n \"entryPINMode\": \"S\",\r\n \"kernelVersion\": \"090100\",\r\n \"MSRKSN\": \"FFFF987987000020004D\",\r\n \"terminalCapabilities\": \"manual|stripe|icc|signature|rfid|contactless\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test\",\r\n \"street\": \"8320 street St SE\",\r\n \"city\": \"city\",\r\n \"state\": \"FL\",\r\n \"zip\": \"22222\",\r\n \"countryCode\": \"US\",\r\n \"phone\": \"1231231234\",\r\n \"email\": \"a@a.aa\"\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale-auth\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"RS\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"P\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following example shows how to process a credit card authorization using EMV card data.

The following example shows how to process a credit card authorization using swipe card data.

The following example outlines how to process an increment transaction.

The following request shows how to process a Capture transaction using the Transaction API. This transaction type is used to capture a pre-existing authorization. Once captured, the authorization will be placed in the batch for settlement.

The following example outlines how to adjust a tip on a transaction.

The following sections outlines how to process Bar Tab transactions in a card present environment.

\n","_postman_id":"8c61046f-559f-45ec-98bc-9c01bc257c56","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Car Rental (CP)","item":[{"name":"EMV Authorization (CP) (Car Rental)","id":"7e54ca19-d3af-41d5-a603-1701b9d77dd5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"emvTags\": \"4F07A0000000031010500A5669736120446562697457104450649200973734D19092260003680F82023C008407A0000000031010950508000000009A03150439B02E8009C01005F2A0208405F3401019F02060000000005009F0607A00000000310109F0902008C9F100706010A03A020009F120A5669736120446562697491A0208409F1E0838303234373636319F21032109149F2608FA940EE08082F8A59F2701809F3303E0B8C89F34031E03009F3501229F360200109F37043F2BE809F3901059F4005F000F0A0019F4104000003819F5301529990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\",\r\n \"securityCode\": \"123\",\r\n \"track1\": \"9990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\"\r\n },\r\n \"device\": {\r\n \"appHostMachineID\": \"7C0595DE6CD1D30633\",\r\n \"deviceFirmware\": \"0504\",\r\n \"deviceMake\": \"Ingenico\",\r\n \"deviceModel\": \"Lane7000_MSR\",\r\n \"deviceSerial\": \"12312312\",\r\n \"entryMedium\": \"CC\",\r\n \"entryMode\": \"HP\",\r\n \"entryPINMode\": \"S\",\r\n \"kernelVersion\": \"090100\",\r\n \"MSRKSN\": \"FFFF987987000020004D\",\r\n \"terminalCapabilities\": \"manual|stripe|icc|signature|rfid|contactless\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test Name\",\r\n \"zip\": \"22222\"\r\n },\r\n \"carRental\": {\r\n \"maxFreeMiles\": 100,\r\n \"mileRateAmount\": 50,\r\n \"agreementNumber\": \"123\",\r\n \"city\": \"Lake Mary\",\r\n \"class\": \"Luxury\",\r\n \"countryCode\": \"US\",\r\n \"date\": \"2025-09-05\",\r\n \"duration\": 3,\r\n \"dailyRateAmount\": 5000,\r\n \"extraChargesAmount\": 1000,\r\n \"insuranceAmount\": 10000,\r\n \"name\": \"Car Rental Test\",\r\n \"state\": \"FL\",\r\n \"time\": \"0932\",\r\n \"returnLocationCode\": \"FL\",\r\n \"returnDate\": \"2025-09-08\",\r\n \"returnState\": \"FL\",\r\n \"returnTime\": \"1148\",\r\n \"returnCity\": \"Maitland\",\r\n \"returnCountryCode\": \"US\",\r\n \"specialProgramType\": \"NC\",\r\n \"totalMiles\": 1000,\r\n \"extraChargeItems\": [\r\n {\r\n \"type\": \"S\",\r\n \"amount\": 1000\r\n }\r\n ]\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale-auth\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"CR\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"P\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following example shows how to process a credit card authorization using EMV card data.

The following section outlines how to process an increment transaction.

The following section outlines how to process a Car Rental transaction using the Transaction API.

Clients processing car rental industry transactions and desiring to itemize the charges for additional service can include car rental items sub-records as a part of the request message.

CarRental

Required	Data Element	Data Type	Length	Description
O	maxFreeMiles	integer	8	Total mileage for rent period.
O	mileRateAmount	integer	8	Total rent amount per mile. Implied decimal.
C	agreementNumber	string	25	Car Rental Agreement Number. Required as part of the Rental Key.
O	city	string	25	City where the car rental starts.
O	class
O	countryCode	string	2	Country where the car rental starts.
C	date	date	10	Date when the car rental starts. (MM/DD/YYYY format)
C	duration	integer	4	Car Rental Period in days.
O	dailyRateAmount	integer	8	Total rent amount per mile. Implied decimal.
O	extraChargesAmount	integer	8	Total dollar amount of extraChargeItems. Implied decimal.
O	insturanceAmount	integer	8	Car insurance amount. Implied decimal.
C	name	string	20	Name of the person who rented the car.
O	state	string	3	State where the car rental starts.
O	time	integer	4	Car rental start time in 24-Hour Format. (HHMM)
O	returnLocationCode	string	10	Identification code of the place where car was returned.
C	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)
O	returnCity	string	25	City where the car is returned
O	returnCountryCode	string	2	Country where the car is returned.
C	specialProgramType	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	extraChargeItems	object	n/a	List of extra charges. See below.

CarRentalExtraChargeItem

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
C	type	string	1	Car rental extra charge type: M = Extra Mileage S = Gas N = Late Return W = One-Way Service P = Parking Violation
C	amount	integer	8	Amount for car rental extra charge item. Implied decimal.

","event":[{"listen":"prerequest","script":{"id":"2e62ebb0-ff13-43d0-b387-42a8bdc2fa0a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bc644580-126e-4663-a3b9-de36ec613ace","type":"text/javascript","exec":[""]}}],"_postman_id":"b981a371-7b76-4986-bfe3-d3550e94f39a","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Card on File (CP)","item":[{"name":"EMV Sale InitialUnscheduled (CP)","id":"694c8f83-05ec-438e-91a3-82fd20d53d52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"emvTags\": \"4F07A0000000031010500A5669736120446562697457104450649200973734D19092260003680F82023C008407A0000000031010950508000000009A03150439B02E8009C01005F2A0208405F3401019F02060000000005009F0607A00000000310109F0902008C9F100706010A03A020009F120A5669736120446562697491A0208409F1E0838303234373636319F21032109149F2608FA940EE08082F8A59F2701809F3303E0B8C89F34031E03009F3501229F360200109F37043F2BE809F3901059F4005F000F0A0019F4104000003819F5301529990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\",\r\n \"securityCode\": \"123\",\r\n \"track1\": \"9990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\"\r\n },\r\n \"device\": {\r\n \"appHostMachineID\": \"7C0595DE6CD1D30633\",\r\n \"deviceFirmware\": \"0504\",\r\n \"deviceMake\": \"Ingenico\",\r\n \"deviceModel\": \"Lane7000_MSR\",\r\n \"deviceSerial\": \"12312312\",\r\n \"entryMedium\": \"CC\",\r\n \"entryMode\": \"HP\",\r\n \"entryPINMode\": \"S\",\r\n \"kernelVersion\": \"090100\",\r\n \"MSRKSN\": \"FFFF987987000020004D\",\r\n \"terminalCapabilities\": \"manual|stripe|icc|signature|rfid|contactless\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test Name\",\r\n \"zip\": \"22222\"\r\n },\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"RE\",\r\n \"storedCredential\": \"InitialUnscheduled\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"P\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following request shows how to process a Sale transaction with the Card on File type of InitialUnscheduled.

The following request shows how to process a Sale transaction with the Card on File type of InitialInstallment.

The following request shows how to process a Sale transaction with the Card on File type of InitialRecurring.

The following section outlines how to process a Card on File transaction using the Transaction API. These guidelines are applicable to situations where a merchant intends to store the payment information of the cardholder in order to process future transactions. Storage of payment information can be defined as storing the credit card number/debit card number/ACH account number or equivalent gateway token or wallet.

Card on File revolves around two fundamental concepts:

Scheduled Payment versus Unscheduled Payment
\n
Customer Initiated Transaction versus Merchant Initiated Transaction
\n

Scheduled Payment versus Unscheduled Payment

Scheduled Payment means the merchant knows when the cardholder’s payment information will be used to process a payment on their behalf. In order for this to take place the merchant is required to get permission from the cardholder to store the payment information for later use before processing a scheduled payment. The two types of scheduled payments are Recurring and Installment.

An Unscheduled Payment is any payment that is not part of a recurring or installment plan.

Customer Initiated Transaction versus Merchant Initiated Transaction

A Customer Initiated Transaction is one whereby the cardholder is directly interacting with a checkout process, whether that is in-person or on-line. Within a customer initiated transaction a merchant can ask for permission to store the payment information for later use.

A Merchant Initiated Transaction is one whereby the cardholder is not an active participant in the payment and the merchant is running a payment using stored information previously approved by the cardholder.

Prior to a Merchant Initiated Transaction a Customer Initiated Transaction must have been performed.

Customer Initiated Transactions can be classified as Initial Unscheduled, Initial Installment or Initial Recurring or Unscheduled Customer.

Storing the Card On File

In order to store the card on file, the cardholder must give permission to have their payment information stored for later use. Once permission is granted the merchant needs to perform a transaction to the gateway setting the storedCredential field to the appropriate value in order to initiate the card on file event with the card issuer. This can be done via processing a sale or sale-auth and setting the storedCredential field to one of the following values:

initialUnscheduled – customer initiated transaction where the cardholder’s payment information will be stored for later use not in association with an installment or recurring plan.

initialInstallment – customer initiated transaction where the cardholder’s payment information will be stored for later use in association with an installment payment plan.

initialRecurring – customer initiated transaction where the cardholder’s payment information will be stored for later use in association with a recurring payment plan.

In response the merchant’s system will receive the networkReferenceNumber in the Transaction API response. Future installment or recurring payments for this card on file must include the networkReferenceNumber value from the initial transaction.

Please note, this process does not allow for an Account Verification transaction as the initial transaction.

Processing Payments with the Card On File

In order to process payments using the card on file, the merchant will send a sale or sale-auth transactions using the following storedCredential values as appropriate. If the payment is for Installment or Recurring then the networkReferenceNumber received on the Initial card on file creation event must also be supplied.

unscheduledMerchant - Merchant initiated transaction for any scenario where the cardholder has given consent for a payment to be processed using their card on file that is not associated with an installment or recurring payment plan.

installment – Merchant initiated transaction related to an installment plan which consists of an agreement between the merchant and cardholder to process one or more payment(s) over a duration of time for a single good or service.

recurring – Merchant initiated transaction related to a recurring payment plan which consists of an agreement between the merchant and cardholder to process a recurring payment over a duration of time at a regular interval for a good or a service.

\n","event":[{"listen":"prerequest","script":{"id":"9aef64ff-e23a-4721-803b-cf9b20e2fef8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"76250e2b-83d9-4a86-88c3-8ae4de056a66","type":"text/javascript","exec":[""]}}],"_postman_id":"b4ce6091-b2dd-4693-b879-f1c83d63c521","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Convenience Fee (CP)","item":[{"name":"EMV Convenience Fee (CP)","id":"cce52733-5e7d-43f6-921f-000e378340be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"emvTags\": \"4F07A0000000031010500A5669736120446562697457104450649200973734D19092260003680F82023C008407A0000000031010950508000000009A03150439B02E8009C01005F2A0208405F3401019F02060000000005009F0607A00000000310109F0902008C9F100706010A03A020009F120A5669736120446562697491A0208409F1E0838303234373636319F21032109149F2608FA940EE08082F8A59F2701809F3303E0B8C89F34031E03009F3501229F360200109F37043F2BE809F3901059F4005F000F0A0019F4104000003819F5301529990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\",\r\n \"securityCode\": \"123\",\r\n \"track1\": \"9990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\"\r\n },\r\n \"device\": {\r\n \"appHostMachineID\": \"7C0595DE6CD1D30633\",\r\n \"deviceFirmware\": \"0504\",\r\n \"deviceMake\": \"Ingenico\",\r\n \"deviceModel\": \"Lane7000_MSR\",\r\n \"deviceSerial\": \"12312312\",\r\n \"entryMedium\": \"CC\",\r\n \"entryMode\": \"HP\",\r\n \"entryPINMode\": \"S\",\r\n \"kernelVersion\": \"090100\",\r\n \"MSRKSN\": \"FFFF987987000020004D\",\r\n \"terminalCapabilities\": \"manual|stripe|icc|signature|rfid|contactless\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test Name\",\r\n \"zip\": \"22222\"\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"RE\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"P\",\r\n \"amount\": 1234,\r\n \"feeAmount\": 200,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following example shows how to process a credit card sale with a convenience fee using EMV card data.

The following example shows how to process a credit card sale with a convenience fee using swipe card data.

The following section outlines how to process a transaction with a convenience fee through the Transaction API.

\n","event":[{"listen":"prerequest","script":{"id":"ba8bcfde-acaf-4211-a3a2-502e758307d7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2e003342-2c41-489a-9a28-2d4759a2113f","type":"text/javascript","exec":[""]}}],"_postman_id":"e9f7b148-b57a-4cd7-b9c0-8940f0e95de6","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Surcharge (CP)","item":[{"name":"EMV Surcharge (CP)","id":"6521a95a-23c4-4bff-aaf9-192deee9212e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"emvTags\": \"4F07A0000000031010500A5669736120446562697457104450649200973734D19092260003680F82023C008407A0000000031010950508000000009A03150439B02E8009C01005F2A0208405F3401019F02060000000005009F0607A00000000310109F0902008C9F100706010A03A020009F120A5669736120446562697491A0208409F1E0838303234373636319F21032109149F2608FA940EE08082F8A59F2701809F3303E0B8C89F34031E03009F3501229F360200109F37043F2BE809F3901059F4005F000F0A0019F4104000003819F5301529990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\",\r\n \"securityCode\": \"123\",\r\n \"track1\": \"9990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\"\r\n },\r\n \"device\": {\r\n \"appHostMachineID\": \"7C0595DE6CD1D30633\",\r\n \"deviceFirmware\": \"0504\",\r\n \"deviceMake\": \"Ingenico\",\r\n \"deviceModel\": \"Lane7000_MSR\",\r\n \"deviceSerial\": \"12312312\",\r\n \"entryMedium\": \"CC\",\r\n \"entryMode\": \"HP\",\r\n \"entryPINMode\": \"S\",\r\n \"kernelVersion\": \"090100\",\r\n \"MSRKSN\": \"FFFF987987000020004D\",\r\n \"terminalCapabilities\": \"manual|stripe|icc|signature|rfid|contactless\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test Name\",\r\n \"zip\": \"22222\"\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"RE\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"P\",\r\n \"amount\": 1234,\r\n \"feeAmount\": 200,\r\n \"feeIsSurcharge\": true,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following example shows how to process a credit card sale with a convenience fee using EMV card data.

The following example shows how to process a credit card sale with a convenience fee using swipe card data.

The following section outlines how to process a transaction with a surcharge through the Transaction API.

\n","event":[{"listen":"prerequest","script":{"id":"ba8bcfde-acaf-4211-a3a2-502e758307d7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2e003342-2c41-489a-9a28-2d4759a2113f","type":"text/javascript","exec":[""]}}],"_postman_id":"2933b469-b4a8-40f7-94da-48e005c66aed","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Dynamic Descriptor (CP)","item":[{"name":"EMV Dynamic Descriptor (CP)","id":"138fc139-be1d-4c2f-bef9-a890b95cd15e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"emvTags\": \"4F07A0000000031010500A5669736120446562697457104450649200973734D19092260003680F82023C008407A0000000031010950508000000009A03150439B02E8009C01005F2A0208405F3401019F02060000000005009F0607A00000000310109F0902008C9F100706010A03A020009F120A5669736120446562697491A0208409F1E0838303234373636319F21032109149F2608FA940EE08082F8A59F2701809F3303E0B8C89F34031E03009F3501229F360200109F37043F2BE809F3901059F4005F000F0A0019F4104000003819F5301529990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\",\r\n \"securityCode\": \"123\",\r\n \"track1\": \"9990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\"\r\n },\r\n \"device\": {\r\n \"appHostMachineID\": \"7C0595DE6CD1D30633\",\r\n \"deviceFirmware\": \"0504\",\r\n \"deviceMake\": \"Ingenico\",\r\n \"deviceModel\": \"Lane7000_MSR\",\r\n \"deviceSerial\": \"12312312\",\r\n \"entryMedium\": \"CC\",\r\n \"entryMode\": \"HP\",\r\n \"entryPINMode\": \"S\",\r\n \"kernelVersion\": \"090100\",\r\n \"MSRKSN\": \"FFFF987987000020004D\",\r\n \"terminalCapabilities\": \"manual|stripe|icc|signature|rfid|contactless\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test Name\",\r\n \"zip\": \"22222\"\r\n },\r\n \"dynamicDescriptors\": {\r\n \"address\": \"dynamic Descriptor address\",\r\n \"city\": \"dynamicDescriptors\",\r\n \"countryCode\": \"US\",\r\n \"county\": \"dynamicDescriptors\",\r\n \"emailAddress\": \"a@a.aa\",\r\n \"postalCode\": \"12345\",\r\n \"region\": \"\",\r\n \"text\": \"dynamicDescriptors\"\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"RE\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"P\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following request shows how to process a Sale Transaction with a Dynamic Descriptor using the Transaction API.

The following section outlines how to process a transaction with a Dynamic Descriptor using the Transaction API.

Note that Dynamic Descriptors are not supported on all processors. View the BridgePay processor matrix to confirm:

BridgePay Gateway API - Processor Matrix (site.com)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
C	address	string	38	Used to modify Dynamic Descriptor Address where supported with processors
C	city	string	38	Used to modify Dynamic Descriptor City where supported with processors
C	countryCode	string	21	Used to modify Dynamic Descriptor Country Code where supported with processors
C	county	string	21	Used to modify Dynamic Descriptor County where supported with processors
C	emailAddress	string	21	Used to modify Dynamic Descriptor Email Address where supported with processors
C	postalCode	string	15	Used to modify Dynamic Descriptor Postal Code where supported with processors
C	region	string	3	Used to modify Dynamic Descriptor Region where supported with processors
C	text	string	60	Used to modify Dynamic Descriptor Name or Text where supported with processors

","event":[{"listen":"prerequest","script":{"id":"b9f40ad0-cf9c-4169-b8fc-f20232853dc6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9813bdb9-e6fe-4b69-8b7a-11c3c141fe80","type":"text/javascript","exec":[""]}}],"_postman_id":"5cb89ca6-ceee-45b6-bed0-a20b1dca9135","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"EBT (CP)","item":[{"name":"Swipe Sale (CP) (EBT Food Stamp)","id":"f449f92f-0526-45a0-b65e-e4ae2d639895","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"securityCode\": \"031\",\r\n \"track1\": \"9990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\",\r\n \"dukpt\": \"000000008F000021\",\r\n \"pinCode\": \"623F36B53CC18393\"\r\n },\r\n \"device\": {\r\n \"appHostMachineID\": \"7C0595DE6CD1D30633\",\r\n \"deviceFirmware\": \"0504\",\r\n \"deviceMake\": \"Ingenico\",\r\n \"deviceModel\": \"Lane7000_MSR\",\r\n \"deviceSerial\": \"07911689\",\r\n \"entryMedium\": \"CC\",\r\n \"entryMode\": \"HP\",\r\n \"entryPINMode\": \"S\",\r\n \"kernelVersion\": \"090100\",\r\n \"MSRKSN\": \"FFFF987987000020004D\",\r\n \"terminalCapabilities\": \"manual|stripe|icc|signature|rfid|contactless\",\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test Name\",\r\n \"zip\": \"22222\"\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"RE\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"F\",\r\n \"transactionMode\": \"P\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following example shows how to process an EBT card authorization using card data read from the card.

The following example shows how to process an EBT card authorization using card data read from a card.

The following section outlines how to process EBT transactions in a Card Present environment.

\n","_postman_id":"bce2671b-9265-47ac-87a3-c775f93e24b1","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Healthcare (CP)","item":[{"name":"EMV Healthcare (CP)","id":"7d22416f-7a54-4b22-bf68-f325ce70dc31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"emvTags\": \"4F07A0000000031010500A5669736120446562697457104450649200973734D19092260003680F82023C008407A0000000031010950508000000009A03150439B02E8009C01005F2A0208405F3401019F02060000000005009F0607A00000000310109F0902008C9F100706010A03A020009F120A5669736120446562697491A0208409F1E0838303234373636319F21032109149F2608FA940EE08082F8A59F2701809F3303E0B8C89F34031E03009F3501229F360200109F37043F2BE809F3901059F4005F000F0A0019F4104000003819F5301529990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\",\r\n \"securityCode\": \"123\",\r\n \"track1\": \"9990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\"\r\n },\r\n \"device\": {\r\n \"appHostMachineID\": \"7C0595DE6CD1D30633\",\r\n \"deviceFirmware\": \"0504\",\r\n \"deviceMake\": \"Ingenico\",\r\n \"deviceModel\": \"Lane7000_MSR\",\r\n \"deviceSerial\": \"12312312\",\r\n \"entryMedium\": \"CC\",\r\n \"entryMode\": \"HP\",\r\n \"entryPINMode\": \"S\",\r\n \"kernelVersion\": \"090100\",\r\n \"MSRKSN\": \"FFFF987987000020004D\",\r\n \"terminalCapabilities\": \"manual|stripe|icc|signature|rfid|contactless\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test Name\",\r\n \"zip\": \"22222\"\r\n },\r\n \"healthcare\": {\r\n \"healthCareamount\": 100,\r\n \"transitamount\": 0,\r\n \"prescriptionamount\": 0,\r\n \"visionamount\": 0,\r\n \"dentalamount\": 0,\r\n \"clinicamount\": 0,\r\n \"isQualifiedIIAS\": true,\r\n \"copayamount\": 0\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"HC\",\r\n \"transCatCode\": \"H\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"P\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}},"urlObject":{"path":["Transaction.API","api","transaction"],"host":["https://www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"7e3f9b66-44fd-4347-85dd-6c122019873f","name":"EMV Healthcare (CP)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"emvTags\": \"4F07A0000000031010500A5669736120446562697457104450649200973734D19092260003680F82023C008407A0000000031010950508000000009A03150439B02E8009C01005F2A0208405F3401019F02060000000005009F0607A00000000310109F0902008C9F100706010A03A020009F120A5669736120446562697491A0208409F1E0838303234373636319F21032109149F2608FA940EE08082F8A59F2701809F3303E0B8C89F34031E03009F3501229F360200109F37043F2BE809F3901059F4005F000F0A0019F4104000003819F5301529990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\",\r\n \"securityCode\": \"123\",\r\n \"track1\": \"9990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\"\r\n },\r\n \"device\": {\r\n \"appHostMachineID\": \"7C0595DE6CD1D30633\",\r\n \"deviceFirmware\": \"0504\",\r\n \"deviceMake\": \"Ingenico\",\r\n \"deviceModel\": \"Lane7000_MSR\",\r\n \"deviceSerial\": \"12312312\",\r\n \"entryMedium\": \"CC\",\r\n \"entryMode\": \"HP\",\r\n \"entryPINMode\": \"S\",\r\n \"kernelVersion\": \"090100\",\r\n \"MSRKSN\": \"FFFF987987000020004D\",\r\n \"terminalCapabilities\": \"manual|stripe|icc|signature|rfid|contactless\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test Name\",\r\n \"zip\": \"22222\"\r\n },\r\n \"healthcare\": {\r\n \"healthCareamount\": 100,\r\n \"transitamount\": 0,\r\n \"prescriptionamount\": 0,\r\n \"visionamount\": 0,\r\n \"dentalamount\": 0,\r\n \"clinicamount\": 0,\r\n \"isQualifiedIIAS\": true,\r\n \"copayamount\": 0\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"HC\",\r\n \"transCatCode\": \"H\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"P\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"cardType\": \"Visa\",\n \"token\": \"20000000000024543420\",\n \"authorizationCode\": \"419033\",\n \"referenceNumber\": \"296710286\",\n \"gatewayResult\": \"00000\",\n \"authorizedAmount\": 1234,\n \"originalAmount\": 1234,\n \"expirationDate\": \"0624\",\n \"isCommercialCard\": \"False\",\n \"gatewayTransID\": \"69991804\",\n \"gatewayMessage\": \"A01 - Approved\",\n \"internalMessage\": \"Approved: 419033 (approval code)\",\n \"transactionDate\": \"20230526\",\n \"remainingAmount\": 0,\n \"isoCountryCode\": \"840\",\n \"isoCurrencyCode\": \"USD\",\n \"isoTransactionDate\": \"2023-05-26T15:07:33.557\",\n \"isoRequestDate\": \"2023-05-26T15:07:33.557\",\n \"networkReferenceNumber\": \"296710286\",\n \"merchantCategoryCode\": \"5999\",\n \"networkMerchantId\": \"1939001\",\n \"networkTerminalId\": \"10001\",\n \"maskedPAN\": \"************3420\",\n \"responseTypeDescription\": \"sale\",\n \"cardBIN\": \"41111111\",\n \"cardClass\": \"Visa\",\n \"cardIdentifier\": \"Credit\",\n \"cardModifier\": \"None\",\n \"cardHolderName\": \"Name Test\",\n \"providerResponseMessage\": \"Approved\",\n \"organizationId\": \"13808\",\n \"merchantAccountCode\": \"1939001\",\n \"transactionID\": \"transactionID123\",\n \"requestType\": \"004\",\n \"responseCode\": \"00000\",\n \"responseDescription\": \"Successful Request\"\n}"}],"_postman_id":"7d22416f-7a54-4b22-bf68-f325ce70dc31"},{"name":"Swipe Healthcare (CP)","id":"59a70053-2076-4178-bd62-0dd6f08bd411","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"securityCode\": \"123\",\r\n \"track1\": \"9990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\"\r\n },\r\n \"device\": {\r\n \"appHostMachineID\": \"7C0595DE6CD1D30633\",\r\n \"deviceFirmware\": \"0504\",\r\n \"deviceMake\": \"Ingenico\",\r\n \"deviceModel\": \"Lane7000_MSR\",\r\n \"deviceSerial\": \"12312312\",\r\n \"entryMedium\": \"CC\",\r\n \"entryMode\": \"HP\",\r\n \"entryPINMode\": \"S\",\r\n \"kernelVersion\": \"090100\",\r\n \"MSRKSN\": \"FFFF987987000020004D\",\r\n \"terminalCapabilities\": \"manual|stripe|icc|signature|rfid|contactless\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test Name\",\r\n \"zip\": \"22222\"\r\n },\r\n \"healthcare\": {\r\n \"healthCareamount\": 100,\r\n \"transitamount\": 0,\r\n \"prescriptionamount\": 0,\r\n \"visionamount\": 0,\r\n \"dentalamount\": 0,\r\n \"clinicamount\": 0,\r\n \"isQualifiedIIAS\": true,\r\n \"copayamount\": 0\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"HC\",\r\n \"transCatCode\": \"H\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"P\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}},"urlObject":{"path":["Transaction.API","api","transaction"],"host":["https://www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"83ed715c-6a6d-4f53-8199-51efb77e3c4d","name":"Swipe Healthcare (CP)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"securityCode\": \"123\",\r\n \"track1\": \"9990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\"\r\n },\r\n \"device\": {\r\n \"appHostMachineID\": \"7C0595DE6CD1D30633\",\r\n \"deviceFirmware\": \"0504\",\r\n \"deviceMake\": \"Ingenico\",\r\n \"deviceModel\": \"Lane7000_MSR\",\r\n \"deviceSerial\": \"12312312\",\r\n \"entryMedium\": \"CC\",\r\n \"entryMode\": \"HP\",\r\n \"entryPINMode\": \"S\",\r\n \"kernelVersion\": \"090100\",\r\n \"MSRKSN\": \"FFFF987987000020004D\",\r\n \"terminalCapabilities\": \"manual|stripe|icc|signature|rfid|contactless\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test Name\",\r\n \"zip\": \"22222\"\r\n },\r\n \"healthcare\": {\r\n \"healthCareamount\": 100,\r\n \"transitamount\": 0,\r\n \"prescriptionamount\": 0,\r\n \"visionamount\": 0,\r\n \"dentalamount\": 0,\r\n \"clinicamount\": 0,\r\n \"isQualifiedIIAS\": true,\r\n \"copayamount\": 0\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"HC\",\r\n \"transCatCode\": \"H\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"P\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"cardType\": \"Visa\",\n \"token\": \"20000000000024543420\",\n \"authorizationCode\": \"419033\",\n \"referenceNumber\": \"296710286\",\n \"gatewayResult\": \"00000\",\n \"authorizedAmount\": 1234,\n \"originalAmount\": 1234,\n \"expirationDate\": \"0624\",\n \"isCommercialCard\": \"False\",\n \"gatewayTransID\": \"69991804\",\n \"gatewayMessage\": \"A01 - Approved\",\n \"internalMessage\": \"Approved: 419033 (approval code)\",\n \"transactionDate\": \"20230526\",\n \"remainingAmount\": 0,\n \"isoCountryCode\": \"840\",\n \"isoCurrencyCode\": \"USD\",\n \"isoTransactionDate\": \"2023-05-26T15:07:33.557\",\n \"isoRequestDate\": \"2023-05-26T15:07:33.557\",\n \"networkReferenceNumber\": \"296710286\",\n \"merchantCategoryCode\": \"5999\",\n \"networkMerchantId\": \"1939001\",\n \"networkTerminalId\": \"10001\",\n \"maskedPAN\": \"************3420\",\n \"responseTypeDescription\": \"sale\",\n \"cardBIN\": \"41111111\",\n \"cardClass\": \"Visa\",\n \"cardIdentifier\": \"Credit\",\n \"cardModifier\": \"None\",\n \"cardHolderName\": \"Name Test\",\n \"providerResponseMessage\": \"Approved\",\n \"organizationId\": \"13808\",\n \"merchantAccountCode\": \"1939001\",\n \"transactionID\": \"transactionID123\",\n \"requestType\": \"004\",\n \"responseCode\": \"00000\",\n \"responseDescription\": \"Successful Request\"\n}"}],"_postman_id":"59a70053-2076-4178-bd62-0dd6f08bd411"}],"id":"72d21046-3a66-4c6c-ba4e-f4c8b82463a8","description":"

The following section outlines how to process a HealthCare transaction using the Transaction API.

When processing a healthcare industry transaction (using an FSA or HSA account) additional amount fields need to be specified. The only amount that is required is healthCareAmount, while other amounts are optional. If medical transportation was involved, then transitAmount should be added.

Depending on the type of service rendered, additional amounts can be specified to healthCareAmount to indicate how much was spent on prescription, vision/optical, dental and clinic/hospitalization services. The total of prescription, vision, dental and clinic amounts can be less than or equal to healthCareAmount.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
C	healthCareAmount	integer	8	The portion of the Total Amount spent on healthcare related services or products. Processed as implied decimal. $1.25 would be represented as 125.
C	transitAmount	integer	8	The portion of the Total Amount spent on healthcare related transportation. Processed as implied decimal. $1.25 would be represented as 125.
C	prescriptionAmount	integer	8	The portion of the Healthcare Amount spent on prescription drugs or products. Processed as implied decimal. $1.25 would be represented as 125.
C	visionAmount	integer	8	The portion of the Healthcare Amount spent on vision related medical services. Processed as implied decimal. $1.25 would be represented as 125.
C	dentalAmount	integer	8	The portion of the Healthcare Amount spent on dental related medical services. Processed as implied decimal. $1.25 would be represented as 125.
C	clinicAmount	integer	8	The portion of the Healthcare Amount spent on hospitalization. Processed as implied decimal. $1.25 would be represented as 125.
C	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	copayAmount	integer	8	The copay amount of the transaction. Processed as implied decimal. $1.25 would be represented as 125.

","event":[{"listen":"prerequest","script":{"id":"0a762d8e-2a89-4ab6-bdfd-8018c7cd5683","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e514fb1b-24f4-4078-a4dd-7f7ea967612a","type":"text/javascript","exec":[""]}}],"_postman_id":"72d21046-3a66-4c6c-ba4e-f4c8b82463a8","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Level II & III (CP)","item":[{"name":"EMV Level II & III (CP)","id":"f29e6421-4a50-4a67-87c8-cdcc219690ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"emvTags\": \"4F07A0000000031010500A5669736120446562697457104450649200973734D19092260003680F82023C008407A0000000031010950508000000009A03150439B02E8009C01005F2A0208405F3401019F02060000000005009F0607A00000000310109F0902008C9F100706010A03A020009F120A5669736120446562697491A0208409F1E0838303234373636319F21032109149F2608FA940EE08082F8A59F2701809F3303E0B8C89F34031E03009F3501229F360200109F37043F2BE809F3901059F4005F000F0A0019F4104000003819F5301529990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\",\r\n \"securityCode\": \"123\",\r\n \"track1\": \"9990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\"\r\n },\r\n \"device\": {\r\n \"appHostMachineID\": \"7C0595DE6CD1D30633\",\r\n \"deviceFirmware\": \"0504\",\r\n \"deviceMake\": \"Ingenico\",\r\n \"deviceModel\": \"Lane7000_MSR\",\r\n \"deviceSerial\": \"12312312\",\r\n \"entryMedium\": \"CC\",\r\n \"entryMode\": \"HP\",\r\n \"entryPINMode\": \"S\",\r\n \"kernelVersion\": \"090100\",\r\n \"MSRKSN\": \"FFFF987987000020004D\",\r\n \"terminalCapabilities\": \"manual|stripe|icc|signature|rfid|contactless\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test Name\",\r\n \"zip\": \"22222\"\r\n },\r\n \"level2\": {\r\n \"taxRate\": 550,\r\n \"taxamount\": 125,\r\n \"taxIndicator\": \"P\",\r\n \"shipToName\": \"shipToNameTEST\",\r\n \"shipToStreet\": \"shipToStreetTEST\",\r\n \"shipToCity\": \"shipToCityngTEST\",\r\n \"shipToState\": \"shipToStateTEST\",\r\n \"shipToZip\": \"12345\",\r\n \"shipToCountryCode\": \"US\"\r\n },\r\n \"level3\": {\r\n \"shippingOriginZip\": \"12345\",\r\n \"discountamount\": 125,\r\n \"shippingamount\": 125,\r\n \"dutyamount\": 125,\r\n \"taxInvoiceCode\": \"taxInvoiceCode\",\r\n \"localTaxamount\": 125,\r\n \"localTaxIndicator\": \"P\",\r\n \"nationalTaxamount\": 125,\r\n \"nationalTaxIndicator\": \"P\",\r\n \"orderCode\": \"orderCode113322\",\r\n \"orderDate\": \"20220216\",\r\n \"commodityCode\": \"5999\",\r\n \"customerAccountTaxId\": \"123456789\",\r\n \"items\": [\r\n {\r\n \"code\": \"5999\",\r\n \"commodityCode\": \"5999\",\r\n \"description\": \"An Item\",\r\n \"quantity\": 1,\r\n \"unitCostamount\": 223,\r\n \"unitMeasure\": \"ea\",\r\n \"taxamount\": 0,\r\n \"taxRate\": 0,\r\n \"taxIndicator\": \"N\",\r\n \"taxCode\": \"0\",\r\n \"discountRate\": 0,\r\n \"discountamount\": 0,\r\n \"totalamount\": 100,\r\n \"isCredit\": true\r\n }\r\n ]\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transIndustryType\": \"RE\",\r\n \"transactionType\": \"sale\",\r\n \"TransCatCode\": \"R\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"amount\": 1256,\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"P\",\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following example shows how to process a Level III transaction. To process a Level II transaction, this example would stay the same; however, the Level III object would be removed.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}},"urlObject":{"path":["Transaction.API","api","transaction"],"host":["https://www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"969711f1-023d-4324-a6b0-cc7b5644c5e5","name":"EMV Level II & III (CP)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"emvTags\": \"4F07A0000000031010500A5669736120446562697457104450649200973734D19092260003680F82023C008407A0000000031010950508000000009A03150439B02E8009C01005F2A0208405F3401019F02060000000005009F0607A00000000310109F0902008C9F100706010A03A020009F120A5669736120446562697491A0208409F1E0838303234373636319F21032109149F2608FA940EE08082F8A59F2701809F3303E0B8C89F34031E03009F3501229F360200109F37043F2BE809F3901059F4005F000F0A0019F4104000003819F5301529990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\",\r\n \"securityCode\": \"123\",\r\n \"track1\": \"9990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\"\r\n },\r\n \"device\": {\r\n \"appHostMachineID\": \"7C0595DE6CD1D30633\",\r\n \"deviceFirmware\": \"0504\",\r\n \"deviceMake\": \"Ingenico\",\r\n \"deviceModel\": \"Lane7000_MSR\",\r\n \"deviceSerial\": \"12312312\",\r\n \"entryMedium\": \"CC\",\r\n \"entryMode\": \"HP\",\r\n \"entryPINMode\": \"S\",\r\n \"kernelVersion\": \"090100\",\r\n \"MSRKSN\": \"FFFF987987000020004D\",\r\n \"terminalCapabilities\": \"manual|stripe|icc|signature|rfid|contactless\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test Name\",\r\n \"zip\": \"22222\"\r\n },\r\n \"level2\": {\r\n \"taxRate\": 550,\r\n \"taxamount\": 125,\r\n \"taxIndicator\": \"P\",\r\n \"shipToName\": \"shipToNameTEST\",\r\n \"shipToStreet\": \"shipToStreetTEST\",\r\n \"shipToCity\": \"shipToCityngTEST\",\r\n \"shipToState\": \"shipToStateTEST\",\r\n \"shipToZip\": \"12345\",\r\n \"shipToCountryCode\": \"US\"\r\n },\r\n \"level3\": {\r\n \"shippingOriginZip\": \"12345\",\r\n \"discountamount\": 125,\r\n \"shippingamount\": 125,\r\n \"dutyamount\": 125,\r\n \"taxInvoiceCode\": \"taxInvoiceCode\",\r\n \"localTaxamount\": 125,\r\n \"localTaxIndicator\": \"P\",\r\n \"nationalTaxamount\": 125,\r\n \"nationalTaxIndicator\": \"P\",\r\n \"orderCode\": \"orderCode113322\",\r\n \"orderDate\": \"20220216\",\r\n \"commodityCode\": \"5999\",\r\n \"customerAccountTaxId\": \"123456789\",\r\n \"items\": [\r\n {\r\n \"code\": \"5999\",\r\n \"commodityCode\": \"5999\",\r\n \"description\": \"An Item\",\r\n \"quantity\": 1,\r\n \"unitCostamount\": 223,\r\n \"unitMeasure\": \"ea\",\r\n \"taxamount\": 0,\r\n \"taxRate\": 0,\r\n \"taxIndicator\": \"N\",\r\n \"taxCode\": \"0\",\r\n \"discountRate\": 0,\r\n \"discountamount\": 0,\r\n \"totalamount\": 100,\r\n \"isCredit\": true\r\n }\r\n ]\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transIndustryType\": \"RE\",\r\n \"transactionType\": \"sale\",\r\n \"TransCatCode\": \"R\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"amount\": 1256,\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"P\",\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"cardType\": \"Visa\",\n \"token\": \"20000000000024543420\",\n \"authorizationCode\": \"922383\",\n \"referenceNumber\": \"937337183\",\n \"gatewayResult\": \"00000\",\n \"authorizedAmount\": 1234,\n \"originalAmount\": 1234,\n \"expirationDate\": \"0624\",\n \"isCommercialCard\": \"False\",\n \"gatewayTransID\": \"69991904\",\n \"gatewayMessage\": \"A01 - Approved\",\n \"internalMessage\": \"Approved: 922383 (approval code)\",\n \"transactionDate\": \"20230526\",\n \"remainingAmount\": 0,\n \"isoCountryCode\": \"840\",\n \"isoCurrencyCode\": \"USD\",\n \"isoTransactionDate\": \"2023-05-26T15:14:44.403\",\n \"isoRequestDate\": \"2023-05-26T15:14:44.403\",\n \"networkReferenceNumber\": \"937337183\",\n \"merchantCategoryCode\": \"5999\",\n \"networkMerchantId\": \"1939001\",\n \"networkTerminalId\": \"10001\",\n \"maskedPAN\": \"************3420\",\n \"responseTypeDescription\": \"sale\",\n \"cardBIN\": \"41111111\",\n \"cardClass\": \"Visa\",\n \"cardIdentifier\": \"Credit\",\n \"cardModifier\": \"None\",\n \"cardHolderName\": \"Name Test\",\n \"providerResponseMessage\": \"Approved\",\n \"organizationId\": \"13808\",\n \"merchantAccountCode\": \"1939001\",\n \"transactionID\": \"transactionID123\",\n \"requestType\": \"004\",\n \"responseCode\": \"00000\",\n \"responseDescription\": \"Successful Request\"\n}"}],"_postman_id":"f29e6421-4a50-4a67-87c8-cdcc219690ac"},{"name":"Swipe Level II & III (CP)","id":"f771e635-d8f9-4f4c-b45e-c8f0cf000c95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"securityCode\": \"123\",\r\n \"track1\": \"9990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\"\r\n },\r\n \"device\": {\r\n \"appHostMachineID\": \"7C0595DE6CD1D30633\",\r\n \"deviceFirmware\": \"0504\",\r\n \"deviceMake\": \"Ingenico\",\r\n \"deviceModel\": \"Lane7000_MSR\",\r\n \"deviceSerial\": \"12312312\",\r\n \"entryMedium\": \"CC\",\r\n \"entryMode\": \"HP\",\r\n \"entryPINMode\": \"S\",\r\n \"kernelVersion\": \"090100\",\r\n \"MSRKSN\": \"FFFF987987000020004D\",\r\n \"terminalCapabilities\": \"manual|stripe|icc|signature|rfid|contactless\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test Name\",\r\n \"zip\": \"22222\"\r\n },\r\n \"level2\": {\r\n \"taxRate\": 550,\r\n \"taxamount\": 125,\r\n \"taxIndicator\": \"P\",\r\n \"shipToName\": \"shipToNameTEST\",\r\n \"shipToStreet\": \"shipToStreetTEST\",\r\n \"shipToCity\": \"shipToCityngTEST\",\r\n \"shipToState\": \"shipToStateTEST\",\r\n \"shipToZip\": \"12345\",\r\n \"shipToCountryCode\": \"US\"\r\n },\r\n \"level3\": {\r\n \"shippingOriginZip\": \"12345\",\r\n \"discountamount\": 125,\r\n \"shippingamount\": 125,\r\n \"dutyamount\": 125,\r\n \"taxInvoiceCode\": \"taxInvoiceCode\",\r\n \"localTaxamount\": 125,\r\n \"localTaxIndicator\": \"P\",\r\n \"nationalTaxamount\": 125,\r\n \"nationalTaxIndicator\": \"P\",\r\n \"orderCode\": \"orderCode113322\",\r\n \"orderDate\": \"20220216\",\r\n \"commodityCode\": \"5999\",\r\n \"customerAccountTaxId\": \"123456789\",\r\n \"items\": [\r\n {\r\n \"code\": \"5999\",\r\n \"commodityCode\": \"5999\",\r\n \"description\": \"An Item\",\r\n \"quantity\": 1,\r\n \"unitCostamount\": 223,\r\n \"unitMeasure\": \"ea\",\r\n \"taxamount\": 0,\r\n \"taxRate\": 0,\r\n \"taxIndicator\": \"N\",\r\n \"taxCode\": \"0\",\r\n \"discountRate\": 0,\r\n \"discountamount\": 0,\r\n \"totalamount\": 100,\r\n \"isCredit\": true\r\n }\r\n ]\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transIndustryType\": \"RE\",\r\n \"transactionType\": \"sale\",\r\n \"TransCatCode\": \"R\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"amount\": 1256,\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"P\",\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following example shows how to process a Level III transaction. To process a Level II transaction, this example would stay the same; however, the Level III object would be removed.

The following section outlines how to process a Level II or III transaction through the Transaction API.

Level II and III data is used for Business-to-Business (B2B) and Business-to-Government (B2G) transactions to lower credit card processing fees in exchange for more transaction data provided at time of processing. Level III requires all Level II data plus the Level III data fields.

Level2

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
C	taxRate	integer	5	Additional Tax Amount. REQUIRED FOR LEVEL II/III. Processed as implied decimal. 5.5% would be represented as 550.
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	ISO 3166-1 alpha-2 codes.Shipping address country code. REQUIRED FOR LEVEL II/III.

Level3

Required	Data Element	Data Type	Length	Description
C	shippingOriginZip	string	10	Postal code of the origin of the shipment. 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. REQUIRED FOR LEVEL III.
C	discountAmount	integer	8	Processed as implied decimal. $1.25 would be represented as 125. Additional discount amount. REQUIRED FOR LEVEL III.
C	shippingAmount	integer	8	Processed as implied decimal. $1.25 would be represented as 125. Additional discount amount. REQUIRED FOR LEVEL III.
C	dutyAmount	integer	8	Processed as implied decimal. $1.25 would be represented as 125. Additional discount amount. REQUIRED FOR LEVEL III.
C	taxInvoiceCode	string	15	Must be at least 1 and up to 15 characters. When separate VAT invoice is produced within the context of the order, unique identifier of this invoice. REQUIRED FOR LEVEL III.
C	localTaxAmount	integer	8	Processed as implied decimal. $1.25 would be represented as 125. Additional Local Tax Amount. REQUIRED FOR LEVEL III.
C	localTaxIndicator	string	1	P (Provided), N (Not Provided), or E (Exempt). REQUIRED FOR LEVEL III.
C	nationalTaxAmount	integer	8	Processed as implied decimal. $1.25 would be represented as 125. Additional National Tax Amount. REQUIRED FOR LEVEL III.
C	nationalTaxIndicator	string	1	P (Provided), N (Not Provided), or E (Exempt). REQUIRED FOR LEVEL III.
C	orderCode	string	17	Unique identifier assigned to the order associated with this transaction in submitter's/merchant's front-end/ inventory system. REQUIRED FOR LEVEL III.
C	orderDate	string	8	Date in format YYYYMMDD. Date when the order associated with the transaction was placed. REQUIRED FOR LEVEL III.
C	commodityCode	string	4	Acquirer designated standardized code that classifies the group of items associated with this order/transaction. REQUIRED FOR LEVEL III.
C	customerAccountTaxId	string	13	VAT registration number of the customer responsible for this transaction. REQUIRED FOR LEVEL III
C	items	object		The Level3Item object outlined in the following table.

Level3Item

Data Element	Data Type	Length	Description
code	string	12	Unique identifier assigned to this item in the submitter’s inventory system.
commodityCode	string	12	Acquirer designated standardized code that classifies this item.
description	string	35	Short description of the item.
quantity	integer	12	Quantity of item units purchased as part of this transaction. Up to 4 decimal places.
unitCostAmount	integer	12	Cost of a single unit of the item. Processed as implied decimal. $1.25 would be represented as 125.
unitMeasure	string	12	Unit of measure used to quantify the items purchased/refunded (e.g. kg, lb., inch).
taxAmount	integer	8	Processed as implied decimal. $1.25 would be represented as 125. Amount of tax charged for this item.
taxRate	integer	12	Rate of the tax (if any) charged on this item. Processed as implied decimal. 5.5% would be represented as 550.
taxIndicator	string	1	P (Provided), N (Not provided), or E (Exempt).
taxCode	string	4	Acquirer designated value classifying the tax that was charged for this item.
discountRate	integer	8	Rate of discount (if any) that was applied to this item. Processed as implied decimal. 5.5% would be represented as 550.
discountAmount	integer	8	Total amount of discount applied to this item. Processed as implied decimal. $1.25 would be represented as 125.
totalAmount	integer	8	Total amount paid for the item (including tax and discount). Processed as implied decimal. $1.25 would be represented as 125.
isCredit	boolean	1	True (Item is being returned), False (Default if not passed - Item is being purchased).

","event":[{"listen":"prerequest","script":{"id":"837663bd-78e3-4691-a6b9-323e50254933","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b5d76fa8-e208-4a74-bd71-f8aa3113fd4d","type":"text/javascript","exec":[""]}}],"_postman_id":"a2ed8750-9525-44ed-9ca5-aeba03dad89f","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Lodging (CP)","item":[{"name":"EMV Authorization (CP) (Lodging)","id":"d51fcbc0-9f9b-46f0-9fed-cea957118750","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"emvTags\": \"4F07A0000000031010500A5669736120446562697457104450649200973734D19092260003680F82023C008407A0000000031010950508000000009A03150439B02E8009C01005F2A0208405F3401019F02060000000005009F0607A00000000310109F0902008C9F100706010A03A020009F120A5669736120446562697491A0208409F1E0838303234373636319F21032109149F2608FA940EE08082F8A59F2701809F3303E0B8C89F34031E03009F3501229F360200109F37043F2BE809F3901059F4005F000F0A0019F4104000003819F5301529990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\",\r\n \"securityCode\": \"123\",\r\n \"track1\": \"9990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\"\r\n },\r\n \"device\": {\r\n \"appHostMachineID\": \"7C0595DE6CD1D30633\",\r\n \"deviceFirmware\": \"0504\",\r\n \"deviceMake\": \"Ingenico\",\r\n \"deviceModel\": \"Lane7000_MSR\",\r\n \"deviceSerial\": \"12312312\",\r\n \"entryMedium\": \"CC\",\r\n \"entryMode\": \"HP\",\r\n \"entryPINMode\": \"S\",\r\n \"kernelVersion\": \"090100\",\r\n \"MSRKSN\": \"FFFF987987000020004D\",\r\n \"terminalCapabilities\": \"manual|stripe|icc|signature|rfid|contactless\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test Name\",\r\n \"zip\": \"22222\"\r\n },\r\n \"Lodging\": {\r\n \"RoomNumber\": \"12A\",\r\n \"FolioNumber\": \"123456\",\r\n \"RoomRateamount\": 10000,\r\n \"RoomTaxamount\": 700,\r\n \"LodgingChargeType\": \"H\",\r\n \"CheckInDate\": \"2023-08-25T09:14:17.612755+04:00\",\r\n \"CheckOutDate\": \"2023-09-01T14:39:23.513481+04:00\",\r\n \"Duration\": 8,\r\n \"SpecialProgramType\": \"AR\",\r\n \"DepartureAdjustmentamount\": 100,\r\n \"LodgingItems\": [\r\n {\r\n \"amount\": 200,\r\n \"Type\": \"B\"\r\n },\r\n {\r\n \"amount\": 300,\r\n \"Type\": \"T\"\r\n }\r\n ]\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale-auth\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"LD\",\r\n \"settlementDelay\": \"7\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"P\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following example shows how to process a credit card authorization using EMV card data.

The following example shows out to process an increment transaction.

The following section outlines how to process a Lodging transaction using the Transaction API. Note that Partial Authorizations are not permitted for Lodging Transactions.

Clients processing lodging industry transactions and desiring to itemize the charges for additional service can include lodging items sub-records as a part of the request message.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
C	roomNumber	string	25	Hotel room number
C	folioNumber	string	15	Hotel folio number Required for all lodging transactions.
C	roomRateAmount	integer	8	Daily room rate. Implied decimal. Required when LodgingChargeType = 'H'
C	roomTaxAmount	integer	8	Tax charged on daily rate. Implied decimal.
C	lodgingChargeType	string	1	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	string		The date of actual or anticipated check-in. Required when LodgingChargeType = 'H'
C	checkOutDate	string		The date of actual or anticipated check-out Required when LodgingChargeType = 'H'
C	duration	integer		Indicates the length of anticipated, actual or incremental stay.
C	specialProgramType	string	2	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'
C	departureAdjustmentAmount	integer	8	Additional amount charged after the cardholder left the hotel.
C	lodgingItems	object		The lodgingItems object.

LodgingItem

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
C	type	string	1	Lodging extra charge type : G = Gift Shop L = Laundry B = Mini bar R = Restaurant T = Telephone
C	amount	integer	8	Amount for lodging extra charge item. Implied decimal.

","event":[{"listen":"prerequest","script":{"id":"398e2fbf-fee3-4c7e-bb16-6ee1579dcaa9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fc7da470-6280-4d63-8bc0-ee13a1c44ec2","type":"text/javascript","exec":[""]}}],"_postman_id":"2da47edf-6e93-4d6e-8cf3-8a42bdf1733d","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Service Fee (CP)","item":[{"name":"EMV Service Fee (CP)","id":"6e6b7e94-637c-4ffb-86b0-2854e198943e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"emvTags\": \"4F07A0000000031010500A5669736120446562697457104450649200973734D19092260003680F82023C008407A0000000031010950508000000009A03150439B02E8009C01005F2A0208405F3401019F02060000000005009F0607A00000000310109F0902008C9F100706010A03A020009F120A5669736120446562697491A0208409F1E0838303234373636319F21032109149F2608FA940EE08082F8A59F2701809F3303E0B8C89F34031E03009F3501229F360200109F37043F2BE809F3901059F4005F000F0A0019F4104000003819F5301529990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\",\r\n \"securityCode\": \"123\",\r\n \"track1\": \"9990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\"\r\n },\r\n \"device\": {\r\n \"appHostMachineID\": \"7C0595DE6CD1D30633\",\r\n \"deviceFirmware\": \"0504\",\r\n \"deviceMake\": \"Ingenico\",\r\n \"deviceModel\": \"Lane7000_MSR\",\r\n \"deviceSerial\": \"12312312\",\r\n \"entryMedium\": \"CC\",\r\n \"entryMode\": \"HP\",\r\n \"entryPINMode\": \"S\",\r\n \"kernelVersion\": \"090100\",\r\n \"MSRKSN\": \"FFFF987987000020004D\",\r\n \"terminalCapabilities\": \"manual|stripe|icc|signature|rfid|contactless\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test Name\",\r\n \"zip\": \"22222\"\r\n },\r\n \"ServiceFees\": [\r\n {\r\n \"ServiceFeeId\": \"SrvFee12345\",\r\n \"amount\": 500,\r\n \"merchantAccountCode\": \"#####\",\r\n \"ServiceUser\": \"#####\",\r\n \"ServicePassword\": \"#####\"\r\n }\r\n ],\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"RE\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"P\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following example shows how to process a credit card Sale with a Service Fee using EMV card data.

The following example shows how to process a credit card Sale with a Service Fee using siwpe card data.

The following section outlines how to process a Sale transaction with a Service Fee using the Transaction API.

The Transaction API can process a separate service fee transaction for a given principal transaction by providing data about the service fee in the request message.

serviceFee Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Description
C	serviceFeeId	string	A user-defined identifier that will be returned in the response
O	resellerCode	string	The code of the reseller that owns the service merchant account. Use if not providing service credentials.
C	merchantAccountCode	string	The code of the service merchant account. Use if not providing service credentials.
C	amount	integer	The implied decimal implementation of the service fee amount.
C	serviceUser	string	The username associated with the merchant service fee account. Use if not providing ResellerCode, MerchantCode and MerchantAccountCode.
C	servicePassword	string	The password associated with the merchant service fee account. Use if not providing ResellerCode, MerchantCode and MerchantAccountCode.
C	wallet	string
C	walletPaymentMethodID	string

serviceFeeResults

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Data Element	Data Type	Length	Description
serviceFeeID	string		The user-defined identifier associated with the service fee request
authorizationCode	string	50	The transaction authorization code returned from the processor.
referenceNumber	string		The network reference number for the service fee transaction.
gatewayResult	string		5 digit response code for the result of the service fee request
authorizedAmount	integer		Implied decimal representation of the amount that was authorized/charged/refunded.
originalAmount	integer		Implied decimal representation of the amount that was requested to be authorized/charged/refunded.
gatewayTransID	string		Transaction ID from the gateway (used as Reference Number for Voids / Refunds).
gatewayMessage	string		Response message from the gateway for the transaction.
internalMessage	string		Provides more information from the gateway and processor regarding the results of the transaction request.
providerResponseCode	string		Displays the response code as provided by the Processor for the Service Fee transaction.
providerResponseMessage	string		Displays the response message as provided by the Processor for the Service Fee transaction.

","event":[{"listen":"prerequest","script":{"id":"8c062464-09aa-491b-8401-d1c53001032b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a413827a-fd42-4453-a594-855c57a34c72","type":"text/javascript","exec":[""]}}],"_postman_id":"9a8095ca-f149-45e5-8e84-1098afd3ef1f","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Tips (CP) (Retail)","item":[{"name":"EMV Authorization w/Tip (CP) (Retail)","id":"3057f42c-edca-4022-aa6f-5ddaff8228a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"emvTags\": \"4F07A0000000031010500A5669736120446562697457104450649200973734D19092260003680F82023C008407A0000000031010950508000000009A03150439B02E8009C01005F2A0208405F3401019F02060000000005009F0607A00000000310109F0902008C9F100706010A03A020009F120A5669736120446562697491A0208409F1E0838303234373636319F21032109149F2608FA940EE08082F8A59F2701809F3303E0B8C89F34031E03009F3501229F360200109F37043F2BE809F3901059F4005F000F0A0019F4104000003819F5301529990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\",\r\n \"securityCode\": \"123\",\r\n \"track1\": \"9990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\"\r\n },\r\n \"device\": {\r\n \"appHostMachineID\": \"7C0595DE6CD1D30633\",\r\n \"deviceFirmware\": \"0504\",\r\n \"deviceMake\": \"Ingenico\",\r\n \"deviceModel\": \"Lane7000_MSR\",\r\n \"deviceSerial\": \"12312312\",\r\n \"entryMedium\": \"CC\",\r\n \"entryMode\": \"HP\",\r\n \"entryPINMode\": \"S\",\r\n \"kernelVersion\": \"090100\",\r\n \"MSRKSN\": \"FFFF987987000020004D\",\r\n \"terminalCapabilities\": \"manual|stripe|icc|signature|rfid|contactless\"\r\n },\r\n \"tip\": {\r\n \"tipAmount\": 200\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test Name\",\r\n \"zip\": \"22222\"\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale-auth\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"RE\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"P\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following example shows how to process a credit card authorization using EMV card data.

The following example shows how to process a credit card authorization with tip using swipe card data.

The following example shows how to process a credit card authorization with tip using EMV card data.

The following example shows how to process a credit card authorization with tip using swipe card data.

The following section outlines how to process an Authorization or Sale transaction type with a Tip using the Transaction API.

payment

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
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	tipRecipientCode	string	15	Can contain alphanumerics, hyphens, and periods. Server ID for the customer.

","event":[{"listen":"prerequest","script":{"id":"31822c26-c8f1-44e4-9a9d-789002481318","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"eef1524b-e9f6-408b-af06-47e8aadb9fe1","type":"text/javascript","exec":[""]}}],"_postman_id":"d27fff06-ca4c-4e89-b57a-d4a22610d219","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Tips (CP) (Restaurant)","item":[{"name":"EMV Authorization w/Tip (CP) (Restaurant)","id":"af01fbd4-b9ea-46ba-820e-59a7e15444f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"emvTags\": \"4F07A0000000031010500A5669736120446562697457104450649200973734D19092260003680F82023C008407A0000000031010950508000000009A03150439B02E8009C01005F2A0208405F3401019F02060000000005009F0607A00000000310109F0902008C9F100706010A03A020009F120A5669736120446562697491A0208409F1E0838303234373636319F21032109149F2608FA940EE08082F8A59F2701809F3303E0B8C89F34031E03009F3501229F360200109F37043F2BE809F3901059F4005F000F0A0019F4104000003819F5301529990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\",\r\n \"securityCode\": \"123\",\r\n \"track1\": \"9990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\"\r\n },\r\n \"device\": {\r\n \"appHostMachineID\": \"7C0595DE6CD1D30633\",\r\n \"deviceFirmware\": \"0504\",\r\n \"deviceMake\": \"Ingenico\",\r\n \"deviceModel\": \"Lane7000_MSR\",\r\n \"deviceSerial\": \"12312312\",\r\n \"entryMedium\": \"CC\",\r\n \"entryMode\": \"HP\",\r\n \"entryPINMode\": \"S\",\r\n \"kernelVersion\": \"090100\",\r\n \"MSRKSN\": \"FFFF987987000020004D\",\r\n \"terminalCapabilities\": \"manual|stripe|icc|signature|rfid|contactless\"\r\n },\r\n \"tip\": {\r\n \"tipAmount\": 200\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test Name\",\r\n \"zip\": \"22222\"\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale-auth\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"RS\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"P\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following example shows how to process a credit card authorization with tip using EMV card data.

The following example shows how to process a credit card authorization with tip using swipe card data.

The following example shows how to process a credit card authorization with tip using EMV card data.

The following example shows how to process a credit card authorization with tip using swipe card data.

The following section outlines how to process an Authorization or Sale transaction type with a Tip using the Transaction API.

payment

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
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	tipRecipientCode	string	15	Can contain alphanumerics, hyphens, and periods. Server ID for the customer.

","event":[{"listen":"prerequest","script":{"id":"31822c26-c8f1-44e4-9a9d-789002481318","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"eef1524b-e9f6-408b-af06-47e8aadb9fe1","type":"text/javascript","exec":[""]}}],"_postman_id":"5c36f9b4-647e-4524-897c-25846b9cefdd","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Void/Refund (CP)","item":[{"name":"EMV Void (CP)","id":"a06ed99a-a0f7-4c3f-b725-f8b6eebdb6d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"emvTags\": \"4F07A0000000031010500A5669736120446562697457104450649200973734D19092260003680F82023C008407A0000000031010950508000000009A03150439B02E8009C01005F2A0208405F3401019F02060000000005009F0607A00000000310109F0902008C9F100706010A03A020009F120A5669736120446562697491A0208409F1E0838303234373636319F21032109149F2608FA940EE08082F8A59F2701809F3303E0B8C89F34031E03009F3501229F360200109F37043F2BE809F3901059F4005F000F0A0019F4104000003819F5301529990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\",\r\n \"securityCode\": \"123\",\r\n \"track1\": \"9990A46CC78D0CDACA4CB5A3F9A73A4CEF1127B642BD11A4CF89E290EB96CFF1C745CC6AB9D64E53\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test\"\r\n },\r\n \"device\": {\r\n \"appHostMachineID\": \"7C0595DE6CD1D30633\",\r\n \"deviceFirmware\": \"0504\",\r\n \"deviceMake\": \"Ingenico\",\r\n \"deviceModel\": \"Lane7000_MSR\",\r\n \"deviceSerial\": \"12312312\",\r\n \"entryMedium\": \"CC\",\r\n \"entryMode\": \"HP\",\r\n \"entryPINMode\": \"S\",\r\n \"kernelVersion\": \"090100\",\r\n \"MSRKSN\": \"FFFF987987000020004D\",\r\n \"terminalCapabilities\": \"manual|stripe|icc|signature|rfid|contactless\"\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"referenceNumber\": \"gatewayTransID from original transaction\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"void\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"RE\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"P\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction/voidrefund","description":"

The following request shows how to process a Void transaction type using the Transaction API. Note that a void may only be used on a transaction that has not been settled.

The following request shows how to process a Refund transaction type referencing a prior Sale using the Transaction API. Note that a refund may only be used on a transaction that has been settled.

The following request shows how to process a Refund transaction type without an offsetting Sale using the Transaction API. Note that a refund may only be used on a transaction that has been settled. Also note that unreferenced refunds are disabled by default.

The following section outlines how to process a Void or Refund using the Transaction API. Note that the Proxy processor in UAT only allows for one partial void/reversal. This does not apply to production processors where you can perform more than one partial void/reversal. Multiple partial refunds on settled transactions are allowed via the Proxy Processor.

voidRefundRequest

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
R	merchantAccountCode	string		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	The amount requested to be refunded / voided. Processed as implied decimal. $1.25 would be represented as 125.
R	referenceNumber	string	12	The gatewayTransID returned as a part of the response to a payment request.
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.
O	token	string	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	folioNumber	string	15	Hotel folio number Required when LodgingChargeType = 'H'
O	checkInDate	string		The date of actual or anticipated check-in. Required when LodgingChargeType = 'H'
R	originatingTechnologySource	string	N/A	Name of software transmitting the transaction.
R	originatingSoftwareVendor	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	customerAccountCode	string	24	Alphanumeric and dashes accepted. User supplied data.
O	invoiceNumber	string	24	Invoice number. Spaces are not allowed. Alphanumeric and dashes accepted. User supplied data.
O	memo	string

voidRefundResponse

Data Element	Data Type	Description
transactionID	string	The transactionID that was send with the request.
requestType	string
responseCode	string
responseDescription	string
merchantAccountCode	string	The merchant account code used to process the original authorization and the void or refund.
responseType	string
referenceNumber	string
gatewayResult	string
gatewayTransID	string
gatewayMessage	string
transactionCode	string
remainingAmount	integer
responseTypeDescription	string
cardType	string
cardClass	string
cardModifier	string
cardHolderName	string
providerResponseCode	string
providerResponseMessage	string
organizationId	string

","event":[{"listen":"prerequest","script":{"id":"0cdbe809-eb71-4b76-b61e-bf7ac8eaba2e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ab78efcc-7407-4e62-b74e-759d17ddc188","type":"text/javascript","exec":[""]}}],"_postman_id":"be677819-b3b6-40f7-ad34-adf0f0c41039","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}}],"id":"14cb5f8b-efb5-4395-9521-cee629346022","description":"

The following section contains examples of Card Present transactions through the Transaction API. A card present transaction is defined as a transaction in which the card data was directly read off of a credit or debit card. This includes EMV and Track data transactions.

As a prerequisite to use the Transaction API for card present transactions, an integrator must perform a direct integration to their intended card reader in order to read and obtain the card data and format it into a Transaction API request. A direct integration may be performed to devices BridgePay has certified with our processors. Please view the certified devices list for clarity.

If an integrator intends to perform a direct to device integration, please discuss with the BridgePay Integration team to discuss best practices and for guidance connecting with device providers.

Please note that at this time, the Transaction API only supports card present integrations with Ingenico devices. Other devices are coming soon.

Important Data Elements

MSR

entryMode
\n
- Set to either “SX” (Swipe w/Signature) or “SP” (Swipe w/Pin)
\n
entryMedium
\n
- Always set to “MC” (Magnetic Card)
\n
expirationDate
\n
- Must be sent
\n

EMV

entryMode
\n
- Set to either “HX” (Chip w/Signature) or “HP” (Chip w/Pin)
\n
entryMedium
\n
- Always set to “CC” (Chip Card)
\n
EMVTags
\n
- Combined EMV tags in TLV format (unencrypted TLV)
  \n
- Can be sent with track1 data or alone
  \n
  - Do not send with track2 data
  \n
\n

Manual

entryMode
\n
- Always set to “MX” (Manual w/Signature)
\n
entryMedium
\n
- Always set to “MC” (Magnetic Card)
\n
paymentAccountNumber
\n
- Must be sent when data is unencrypted
\n
expirationDate
\n
- Must be sent
\n

Terminal Identification

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element Name	Definition	Example
softwareVendor	Identification of Integrator	BridgePay Integrator
deviceMake	Terminal manufacturer	Ingenico
deviceModel	Terminal model	iSC250
deviceFirmware	Firmware version number	46.12
deviceSerial	Serial number	70032516
kernelVersion	EMV kernel version number	9.26.1
appHostMachineID	Unique identifier of PC	0B6C49DCBBCAD84112

P2PE Encryption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element Name	Definition
MSRKSN	Terminal P2PE KSN
secureFormat	Always set to \"SecureMag\"
track1	Encrypted track or EMV data
securityTechnology	Always set to \"HSM\"

PIN (Debit/EBT)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element Name	Definition
PINCode	Encrypted PIN Block
dukpt	Debit KSN

Pin fields are not decrypted by the gateway and are forwarded onto the debit processor.

EMV tags specific for TSYS Sierra

For processing with TSYS Sierra, both 9F1E and DF79 tags must be sent in addition to the standard EMV tags. All tag information must be submitted to the processor in hex format. Prior to being sent to the processor, data from the 9F1E tag is substituted in the DF78 tag. DF78 and DF79 tags from the TSYS Sierra specification are as follows:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Tag Name	Definition	Example
DF79	Kernel Version Number	DF7905312E322E33
DF78	Device Serial Number	DF780480690422

EMV Dip Enforcement and MSR fallback

EMV dip enforcement is achieved by checking the service code from an MSR swipe. If the service code starts with “2” or “6”, then the card is an EMV card and must be dipped. If dip fails 3 times, then the card may be ran as MSR. It is important to note, that in the event of an MSR fallback (sometimes referred to as failback), the following fields would need to be set in the request body to reflect that the transaction that was originally EMV is now MSR:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Data Element	Value
entryMode	SX
entryMedium	CC
entryPINMode	S
voidReasonCode	FallbackTechnical

EntryPINMode possible values are: X = unknown, S = supported, U = Unsupported, N = Inoperative, O = Offline.
\n
VoidReasonCode field is used, in a fallback condition, to identify the reason for the fallback. Possible values are:
\n
- FallbackTechnical - To ensure the terminal will fallback to a magstripe transaction when a chip cannot be read (BT test case AXP QC 007)
  \n
- FallbackCandidate - To ensure the terminal is able to process a Magstripe Fallback when presented with a card that results in an Empty Candidate List. (BT test case AXP QC 017).
  \n
\n

Terminal Capabilities

The TerminalCapabilities element is required to describe the range of capabilities available on a specific credit card terminal. This is a static value per terminal type. This value will not change based upon the entry mode or entry medium for a specific transaction. This information is forwarded to the host for influencing processing and settlement. Please note that the examples in this document may not reflect the capabilities of your terminal.

Contactless MSR EMV Tags

Contactless MSR transactions, MC Paypass Mobile for example, may require that one or more EMV tags be sent with the MSR data. Currently, the only identified tag is 9F6E via a Mastercard requirement. In these scenarios, the EMV tag information should be passed in the element in standard TLV format.

How the information and TLV data is derived varies based on terminal type. Example EMV transactions where this is a requirement are MP4A Test 01 Scenario 01, MP4A Test 02 Scenario 01, UM91 Test 03 Scenario 01.

\"MSRTags\": \"9F6E0700560102303400\"\n\n

\n","_postman_id":"14cb5f8b-efb5-4395-9521-cee629346022","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Card Not Present","item":[{"name":"ACH","item":[{"name":"ACH (Checking)","id":"c64e521c-37ef-4ee4-a678-ca01afd31977","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"bankAccountNumber\": \"40999992\",\r\n \"routingNumber\": \"021000021\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test\",\r\n \"street\": \"8320 street St SE\",\r\n \"city\": \"city\",\r\n \"state\": \"FL\",\r\n \"zip\": \"22222\",\r\n \"countryCode\": \"US\",\r\n \"phone\": \"1231231234\",\r\n \"email\": \"a@a.aa\"\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"WEB\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"C\",\r\n \"AccountPhone\": \"1231231234\",\r\n \"amount\": 1321,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following request shows how to process a Sale using an ACH Checking account.

The following request shows how to process a Sale using an ACH Savings account.

The following section outlines how to process ACH transactions using the Transaction API.

The BridgePay Gateway supports ACH processing through the Transaction API much like credit card transactions; however, certain fields change. For example, instead of the paymentAccountNumber number and expirationDate, you must provide a bankAccountNum and routingNum. The accountType will indicate whether the account was a Checking account or Savings.

transIndustryType must also be specified for the type of ACH transaction being processed. 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).

\n","event":[{"listen":"prerequest","script":{"id":"c0d47381-3b23-46c4-b399-c001e838fb69","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"975ec6da-b820-4e67-98e4-52d8bd24ef51","type":"text/javascript","exec":[""]}}],"_postman_id":"1fddd0d3-eb9f-49a6-92d3-d22f0c070021","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Authorization/Sale","item":[{"name":"Credit Card Authorization","id":"14fc5b7f-1c9c-4727-81fb-1163a55c3fe9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"paymentAccountNumber\": \"4111111111111111\",\r\n \"expirationDate\": \"1235\",\r\n \"securityCode\": \"111\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test\",\r\n \"street\": \"8320 street St SE\",\r\n \"city\": \"city\",\r\n \"state\": \"FL\",\r\n \"zip\": \"22222\",\r\n \"countryCode\": \"US\",\r\n \"phone\": \"1231231234\",\r\n \"email\": \"a@a.aa\"\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale-auth\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"RE\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"N\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following example shows how to process a credit card authorization using raw card data.

The following example shows how to process a credit card sale using raw card data.

The following example shows how to process a credit card sale using tokenized card data.

The following example shows how to process a credit card sale using wallet card data.

The following section outlines how to process an Authorization or Sale transaction type using the Transaction API.

payment

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
1	paymentAccountNumber	string	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.
1	expirationDate	string	22	Expiration date of the card. If present, the supported format are: MMYY and MM/YY. Required if track data not present.
O	securityCode	string	3-4	When present, must be 3 or 4 digits long CVV / CVV2 of the card.
C	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.
C	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.
C	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	token	string		When present, represents the tokenized card number received from a token request. This is used in place of the paymentAccountNumber.
3	bankAccountNumber	string		The bank account number for ACH and Check transactions. Must contain at least one number.
3	routingNumber	string	10	The routing number for ACH and Check transactions. Can contain up to 10 numbers.
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).

The following example shows how to process a credit card authorization using raw card data.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}},"urlObject":{"path":["Transaction.API","api","transaction","capture"],"host":["https://www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"36848f3c-fb16-44b4-870e-315b930d2d79","name":"Capture Authorization","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionID\": \"transactionID123\",\r\n \"amount\": 1600,\r\n \"merchantAccountCode\": \"#####\",\r\n \"referenceNumber\": \"gatewayTransID from original authorization\",\r\n \"Memo\": \"Capture Auth\",\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction/capture"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"responseType\": \"capture\",\n \"gatewayResult\": \"00000\",\n \"gatewayTransID\": \"69397404\",\n \"gatewayMessage\": \"A01 - Approved\",\n \"organizationId\": \"13808\",\n \"transactionID\": \"transactionID123\",\n \"requestType\": \"019\",\n \"responseCode\": \"00000\",\n \"responseDescription\": \"Successful Request\"\n}"}],"_postman_id":"4b79397d-3b69-4e6b-83e8-1848b5a886fb"},{"name":"Tip Adjustment","id":"e64164d8-d848-4a88-a445-2c7650555cf8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"adjustment\",\r\n \"referenceNumber\": \"gatewayTransID from original authorization\",\r\n \"transIndustryType\": \"RS\",\r\n \"accountType\": \"R\",\r\n \"holderType\": \"P\",\r\n \"transactionMode\": \"N\",\r\n \"amount\": 1600,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\",\r\n \"tip\": {\r\n \"tipAmount\": 600,\r\n \"tipRecipientCode\": \"Code\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}},"urlObject":{"path":["Transaction.API","api","transaction"],"host":["https://www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"b508f311-1401-4b94-8930-33f54a96eac6","name":"Tip Adjustment","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"adjustment\",\r\n \"referenceNumber\": \"gatewayTransID from original authorization\",\r\n \"transIndustryType\": \"RS\",\r\n \"accountType\": \"R\",\r\n \"holderType\": \"P\",\r\n \"transactionMode\": \"N\",\r\n \"amount\": 1600,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\",\r\n \"tip\": {\r\n \"tipAmount\": 600,\r\n \"tipRecipientCode\": \"Code\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"cardType\": \"None\",\n \"gatewayResult\": \"00000\",\n \"authorizedAmount\": 1600,\n \"originalAmount\": 1234,\n \"isCommercialCard\": \"False\",\n \"gatewayTransID\": \"4388205404\",\n \"gatewayMessage\": \"A12 - Tip Adjustment Posted\",\n \"internalMessage\": \"Tip Adjustment Posted\",\n \"remainingAmount\": 0,\n \"cardClass\": \"None\",\n \"cardModifier\": \"None\",\n \"organizationId\": \"15950\",\n \"merchantAccountCode\": \"13816001\",\n \"transactionID\": \"transactionID123\",\n \"requestType\": \"004\",\n \"responseCode\": \"00000\",\n \"responseDescription\": \"Successful Request\"\n}"}],"_postman_id":"e64164d8-d848-4a88-a445-2c7650555cf8"}],"id":"58d9cf4b-da34-4588-8911-198947695af8","_postman_id":"58d9cf4b-da34-4588-8911-198947695af8","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Car Rental","item":[{"name":"Credit Card Authorization (Car Rental)","id":"152717a9-455b-42b4-aa11-6adbf987ec44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"paymentAccountNumber\": \"4111111111111111\",\r\n \"expirationDate\": \"1235\",\r\n \"securityCode\": \"111\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test\",\r\n \"street\": \"8320 street St SE\",\r\n \"city\": \"city\",\r\n \"state\": \"FL\",\r\n \"zip\": \"22222\",\r\n \"countryCode\": \"US\",\r\n \"phone\": \"1231231234\",\r\n \"email\": \"a@a.aa\"\r\n },\r\n \"carRental\": {\r\n \"maxFreeMiles\": 100,\r\n \"mileRateAmount\": 50,\r\n \"agreementNumber\": \"123\",\r\n \"city\": \"Lake Mary\",\r\n \"class\": \"Luxury\",\r\n \"countryCode\": \"US\",\r\n \"date\": \"2025-09-05\",\r\n \"duration\": 3,\r\n \"dailyRateAmount\": 5000,\r\n \"extraChargesAmount\": 1000,\r\n \"insuranceAmount\": 10000,\r\n \"name\": \"Car Rental Test\",\r\n \"state\": \"FL\",\r\n \"time\": \"0932\",\r\n \"returnLocationCode\": \"FL\",\r\n \"returnDate\": \"2025-09-08\",\r\n \"returnState\": \"FL\",\r\n \"returnTime\": \"1148\",\r\n \"returnCity\": \"Maitland\",\r\n \"returnCountryCode\": \"US\",\r\n \"specialProgramType\": \"NC\",\r\n \"totalMiles\": 1000,\r\n \"extraChargeItems\": [\r\n {\r\n \"type\": \"S\",\r\n \"amount\": 1000\r\n }\r\n ]\r\n }, \r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale-auth\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"CR\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"N\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following example shows how to process a credit card authorization using raw card data.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}},"urlObject":{"path":["Transaction.API","api","transaction"],"host":["https://www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"53208a21-9706-436c-9d44-facad04d717d","name":"Credit Card Authorization (Car Rental)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"paymentAccountNumber\": \"4111111111111111\",\r\n \"expirationDate\": \"1235\",\r\n \"securityCode\": \"111\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test\",\r\n \"street\": \"8320 street St SE\",\r\n \"city\": \"city\",\r\n \"state\": \"FL\",\r\n \"zip\": \"22222\",\r\n \"countryCode\": \"US\",\r\n \"phone\": \"1231231234\",\r\n \"email\": \"a@a.aa\"\r\n },\r\n \"carRental\": {\r\n \"maxFreeMiles\": 100,\r\n \"mileRateAmount\": 50,\r\n \"agreementNumber\": \"123\",\r\n \"city\": \"Lake Mary\",\r\n \"class\": \"Luxury\",\r\n \"countryCode\": \"US\",\r\n \"date\": \"2025-09-05\",\r\n \"duration\": 3,\r\n \"dailyRateAmount\": 5000,\r\n \"extraChargesAmount\": 1000,\r\n \"insuranceAmount\": 10000,\r\n \"name\": \"Car Rental Test\",\r\n \"state\": \"FL\",\r\n \"time\": \"0932\",\r\n \"returnLocationCode\": \"FL\",\r\n \"returnDate\": \"2025-09-08\",\r\n \"returnState\": \"FL\",\r\n \"returnTime\": \"1148\",\r\n \"returnCity\": \"Maitland\",\r\n \"returnCountryCode\": \"US\",\r\n \"specialProgramType\": \"NC\",\r\n \"totalMiles\": 1000,\r\n \"extraChargeItems\": [\r\n {\r\n \"type\": \"S\",\r\n \"amount\": 1000\r\n }\r\n ]\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale-auth\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"CR\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"N\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"cardType\": \"Visa\",\n \"token\": \"1000000010261111\",\n \"authorizationCode\": \"567809\",\n \"referenceNumber\": \"976385289\",\n \"gatewayResult\": \"00000\",\n \"authorizedAmount\": 1234,\n \"originalAmount\": 1234,\n \"expirationDate\": \"1230\",\n \"avsResult\": \"4E\",\n \"avsMessage\": \"Street address and 5-digit ZIP match\",\n \"cvResult\": \"N\",\n \"cvMessage\": \"Not matches\",\n \"isCommercialCard\": \"False\",\n \"gatewayTransID\": \"69396504\",\n \"gatewayMessage\": \"A01 - Approved\",\n \"internalMessage\": \"Approved: 567809 (approval code)\",\n \"transactionDate\": \"20221104\",\n \"remainingAmount\": 0,\n \"isoCountryCode\": \"840\",\n \"isoCurrencyCode\": \"USD\",\n \"isoTransactionDate\": \"2022-11-04T11:38:54.287\",\n \"isoRequestDate\": \"2022-11-04T11:38:54.287\",\n \"networkReferenceNumber\": \"976385289\",\n \"merchantCategoryCode\": \"5999\",\n \"networkMerchantId\": \"1939001\",\n \"networkTerminalId\": \"10001\",\n \"maskedPAN\": \"************1111\",\n \"responseTypeDescription\": \"auth\",\n \"cardBIN\": \"41111111\",\n \"cardClass\": \"Visa\",\n \"cardIdentifier\": \"Credit\",\n \"cardModifier\": \"None\",\n \"cardHolderName\": \"Test\",\n \"providerResponseMessage\": \"Approved\",\n \"organizationId\": \"13808\",\n \"merchantAccountCode\": \"1939001\",\n \"transactionID\": \"transactionID123\",\n \"requestType\": \"004\",\n \"responseCode\": \"00000\",\n \"responseDescription\": \"Successful Request\"\n}"}],"_postman_id":"152717a9-455b-42b4-aa11-6adbf987ec44"},{"name":"Increment (Car Rental)","id":"fe286533-59c4-4fa6-88c9-556dc7f66751","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"increment\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"referenceNumber\": \"gatewayTransID from original transaction\",\r\n \"amount\": 1265,\r\n \"carRental\": {\r\n \"maxFreeMiles\": 100,\r\n \"mileRateAmount\": 50,\r\n \"agreementNumber\": \"123\",\r\n \"city\": \"Lake Mary\",\r\n \"class\": \"Luxury\",\r\n \"countryCode\": \"US\",\r\n \"date\": \"2025-09-05\",\r\n \"duration\": 3,\r\n \"dailyRateAmount\": 5000,\r\n \"extraChargesAmount\": 1000,\r\n \"insuranceAmount\": 10000,\r\n \"name\": \"Car Rental Test\",\r\n \"state\": \"FL\",\r\n \"time\": \"0932\",\r\n \"returnLocationCode\": \"FL\",\r\n \"returnDate\": \"2025-09-08\",\r\n \"returnState\": \"FL\",\r\n \"returnTime\": \"1148\",\r\n \"returnCity\": \"Maitland\",\r\n \"returnCountryCode\": \"US\",\r\n \"specialProgramType\": \"NC\",\r\n \"totalMiles\": 1000,\r\n \"extraChargeItems\": [\r\n {\r\n \"type\": \"S\",\r\n \"amount\": 1000\r\n }\r\n ]\r\n },\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}},"urlObject":{"path":["Transaction.API","api","transaction"],"host":["https://www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"70fef329-8885-4e6a-a5ba-02b9370e44da","name":"Increment (Car Rental)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"increment\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"referenceNumber\": \"gatewayTransID from original transaction\",\r\n \"amount\": 1256,\r\n \"carRental\": {\r\n \"maxFreeMiles\": 100,\r\n \"mileRateAmount\": 50,\r\n \"agreementNumber\": \"123\",\r\n \"city\": \"Lake Mary\",\r\n \"class\": \"Luxury\",\r\n \"countryCode\": \"US\",\r\n \"date\": \"2025-09-05\",\r\n \"duration\": 3,\r\n \"dailyRateAmount\": 5000,\r\n \"extraChargesAmount\": 1000,\r\n \"insuranceAmount\": 10000,\r\n \"name\": \"Car Rental Test\",\r\n \"state\": \"FL\",\r\n \"time\": \"0932\",\r\n \"returnLocationCode\": \"FL\",\r\n \"returnDate\": \"2025-09-08\",\r\n \"returnState\": \"FL\",\r\n \"returnTime\": \"1148\",\r\n \"returnCity\": \"Maitland\",\r\n \"returnCountryCode\": \"US\",\r\n \"specialProgramType\": \"NC\",\r\n \"totalMiles\": 1000,\r\n \"extraChargeItems\": [\r\n {\r\n \"type\": \"S\",\r\n \"amount\": 1000\r\n }\r\n ]\r\n },\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"cardType\": \"None\",\n \"authorizationCode\": \"624267\",\n \"gatewayResult\": \"00000\",\n \"authorizedAmount\": 2834,\n \"isCommercialCard\": \"False\",\n \"gatewayTransID\": \"4389150804\",\n \"gatewayMessage\": \"A09 - Incremental Auth Posted\",\n \"internalMessage\": \"Incremental Auth Posted\",\n \"remainingAmount\": 0,\n \"cardClass\": \"None\",\n \"cardModifier\": \"None\",\n \"organizationId\": \"15950\",\n \"merchantAccountCode\": \"13816001\",\n \"transactionID\": \"transactionID123\",\n \"requestType\": \"004\",\n \"responseCode\": \"00000\",\n \"responseDescription\": \"Successful Request\"\n}"}],"_postman_id":"fe286533-59c4-4fa6-88c9-556dc7f66751"},{"name":"Capture Authorization (Lodging)","id":"a6b017df-e63c-4cd2-b700-5d65d56e47c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"accountHolder\": {\r\n \"name\": \"Test\"\r\n },\r\n \"carRental\": {\r\n \"maxFreeMiles\": 100,\r\n \"mileRateAmount\": 50,\r\n \"agreementNumber\": \"123\",\r\n \"city\": \"Lake Mary\",\r\n \"class\": \"Luxury\",\r\n \"countryCode\": \"US\",\r\n \"date\": \"2025-09-05\",\r\n \"duration\": 3,\r\n \"dailyRateAmount\": 5000,\r\n \"extraChargesAmount\": 1000,\r\n \"insuranceAmount\": 10000,\r\n \"name\": \"Car Rental Test\",\r\n \"state\": \"FL\",\r\n \"time\": \"0932\",\r\n \"returnLocationCode\": \"FL\",\r\n \"returnDate\": \"2025-09-08\",\r\n \"returnState\": \"FL\",\r\n \"returnTime\": \"1148\",\r\n \"returnCity\": \"Maitland\",\r\n \"returnCountryCode\": \"US\",\r\n \"specialProgramType\": \"NC\",\r\n \"totalMiles\": 1000,\r\n \"extraChargeItems\": [\r\n {\r\n \"type\": \"S\",\r\n \"amount\": 1000\r\n }\r\n ]\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transIndustryType\": \"CR\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"referenceNumber\": \"gatewayTransID from original authorization\",\r\n \"amount\": 1256,\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"N\",\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction/capture","description":"

The following section outlines how to process a Car Rental transaction using the Transaction API.

Clients processing car rental industry transactions and desiring to itemize the charges for additional service can include car rental items sub-records as a part of the request message.

CarRental

Required	Data Element	Data Type	Length	Description
O	maxFreeMiles	integer	8	Total mileage for rent period.
O	mileRateAmount	integer	8	Total rent amount per mile. Implied decimal.
C	agreementNumber	string	25	Car Rental Agreement Number. Required as part of the Rental Key.
O	city	string	25	City where the car rental starts.
O	class
O	countryCode	string	2	Country where the car rental starts.
C	date	date	10	Date when the car rental starts. (YYYY-MM-DD format)
C	duration	integer	4	Car Rental Period in days.
O	dailyRateAmount	integer	8	Total rent amount per mile. Implied decimal.
O	extraChargesAmount	integer	8	Total dollar amount of extraChargeItems. Implied decimal.
O	insturanceAmount	integer	8	Car insurance amount. Implied decimal.
C	name	string	20	Name of the person who rented the car.
O	state	string	3	State where the car rental starts.
O	time	integer	4	Car rental start time in 24-Hour Format. (HHMM)
O	returnLocationCode	string	10	Identification code of the place where car was returned.
C	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)
O	returnCity	string	25	City where the car is returned
O	returnCountryCode	string	2	Country where the car is returned.
C	specialProgramType	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	extraChargeItems	object	n/a	List of extra charges. See below.

CarRentalExtraChargeItem

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
C	type	string	1	Car rental extra charge type: M = Extra Mileage S = Gas N = Late Return W = One-Way Service P = Parking Violation
C	amount	integer	8	Amount for car rental extra charge item. Implied decimal.

Performing Grouped Authorizations & Captures

Initial Authorizations

The formatting and content of a transaction request to BridgeComm will identify whether the request is an initial authorization or an incremental authorization. A series of transactions for lodging, with future support for Car Rental, are identified by a transaction group key. The group key is comprised of four data elements: the card number/token, the check-in date or rental date, the folio number or rental agreement number and the merchant lookup information.

When sending a grouped transaction to BridgeComm, the key is constructed based on the data elements mentioned above. If the transaction is the first transaction using that key, an initial authorization is created and the settlement delay is set to either the duration of the stay or the difference between the check-in date (rental start) and the check-out date (rental end).

For Car Rental transactions, provide all required fields to process a sale-auth. The gatewayTransID for this sale will be used for subsequent follow-on transactions as the referenceNumber. The group key will not be used for incremental authorizations and capture.

Incremental Authorizations

Incremental authorizations can be generated in one of two ways. The originating system can either send an incremental request by providing the amount to increment the total, or by sending the new total. For example, if the initial authorization is $250.00, to increase the total authorization amount to $300.00, the originating system can either send a $50.00 incremental message, or a $300.00 total message. Both operations end up in acquiring only $50.00 more for the key.

To send an incremental authorization with only the delta amount, the message to BridgeComm will set the TransactionType field to increment, and send the incremental amount in the Amount field. The originating system must also include all other elements required to process the transaction. For Lodging transactions, use the transaction group key described in the prior section to link the increment. For Car Rental transactions, use the gatewayTransID of the original sale-auth, as the referenceNumber to link the transactions.

To send an incremental authorization be specifying the new total amount, the message to BridgeComm will set the TransactionType field to sale-auth, and send the new total amount in the Amount field. The originating system must also include all other elements required to process the transaction. Note that this functionality is only available for Lodging. For Car Rental, use the increment transaction type with the ReferenceNumber mentioned above.

Capture/Check-Out/Return

The capture process for a group of authorizations for a key is handled in much the same way. It is not necessary to capture each individual authorization. Instead, for Lodging transactions, the merchant sends a capture request (See 2.2.11 – Capture Request) including the Card Number or Token, Check-In Date, Folio Number (or Rental Agreement Number) and Merchant Identification information. All authorizations for that key are then totaled and captured as one transaction in preparation for settlement.

For Car Rental transactions, Capture must be performed using the gatewayTransID of the original sale-auth as the referenceNumber, like the increment transaction type.

If the final amount of the transaction is different than the amount authorized to date, the merchant can also send the final amount with the capture message. This will trigger either a partial reversal (if the final amount is less than the total authorized to date amount) or a final incremental authorization (if the final amount is greater than the total authorized to date amount). This capture method also disables the settlement delay, allowing the transaction to be included in the next settlement batch.

\n","event":[{"listen":"prerequest","script":{"id":"2e62ebb0-ff13-43d0-b387-42a8bdc2fa0a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bc644580-126e-4663-a3b9-de36ec613ace","type":"text/javascript","exec":[""]}}],"_postman_id":"fdfeaaff-27b1-4c46-aa45-cab57943d3c9","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Card on File","item":[{"name":"Sale InitialUnscheduled","id":"7b9d9a96-38d9-4ffc-948c-3994ee995099","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"paymentAccountNumber\": \"4111111111111111\",\r\n \"expirationDate\": \"1235\",\r\n \"securityCode\": \"111\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test\",\r\n \"street\": \"8320 street St SE\",\r\n \"city\": \"city\",\r\n \"state\": \"FL\",\r\n \"zip\": \"22222\",\r\n \"countryCode\": \"US\",\r\n \"phone\": \"1231231234\",\r\n \"email\": \"a@a.aa\"\r\n },\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"DM\",\r\n \"storedCredential\": \"InitialUnscheduled\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"N\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following request shows how to process a Sale transaction with the Card on File type of InitialUnscheduled.

The following request shows how to process a Sale transaction with the Card on File type of InitialInstallment.

The following request shows how to process a Sale transaction with the Card on File type of InitialRecurring.

The following request shows how to process a Sale transaction with the Card on File type of UnscheduledCustomer.

The following request shows how to process a Sale transaction with the Card on File type of UnscheduledMerchant.

The following request shows how to process a Sale transaction with the Card on File type of Installment.

The following request shows how to process a Sale transaction with the Card on File type of Recurring.

Card on File revolves around two fundamental concepts:

Scheduled Payment versus Unscheduled Payment
\n
Customer Initiated Transaction versus Merchant Initiated Transaction
\n

Scheduled Payment versus Unscheduled Payment

An Unscheduled Payment is any payment that is not part of a recurring or installment plan.

Customer Initiated Transaction versus Merchant Initiated Transaction

Prior to a Merchant Initiated Transaction a Customer Initiated Transaction must have been performed.

Customer Initiated Transactions can be classified as Initial Unscheduled, Initial Installment or Initial Recurring or Unscheduled Customer.

Storing the Card On File

initialUnscheduled – customer initiated transaction where the cardholder’s payment information will be stored for later use not in association with an installment or recurring plan.

initialInstallment – customer initiated transaction where the cardholder’s payment information will be stored for later use in association with an installment payment plan.

initialRecurring – customer initiated transaction where the cardholder’s payment information will be stored for later use in association with a recurring payment plan.

Please note, this process does not allow for an Account Verification transaction as the initial transaction.

Processing Payments with the Card On File

Note: The examples provided in this section use raw card data; however, they can also use a BridgePay token in place of card data.

The following example shows how to process a credit card sale using raw card data.

The following section contains examples for processing Cash transactions to the gateway. These are record only transactions to document cash sales in the gateway.

\n","_postman_id":"096e9746-599b-43cd-9b30-838be1fd3975","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Convenience Fee","item":[{"name":"Convenience Fee","id":"9967b5f4-05cb-43e9-b6fb-7ac2d22bb94a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"paymentAccountNumber\": \"4111111111111111\",\r\n \"expirationDate\": \"1235\",\r\n \"securityCode\": \"111\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test\",\r\n \"street\": \"8320 street St SE\",\r\n \"city\": \"city\",\r\n \"state\": \"FL\",\r\n \"zip\": \"22222\",\r\n \"countryCode\": \"US\",\r\n \"phone\": \"1231231234\",\r\n \"email\": \"a@a.aa\"\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"RE\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"N\",\r\n \"amount\": 1234,\r\n \"feeAmount\": 200,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following example shows how to process a credit card sale with a convenience fee using raw card data.

The following section outlines how to process a transaction with a convenience fee through the Transaction API.

The following example shows how to process a credit card sale with a convenience fee using raw card data.

The following section outlines how to process a transaction with a surcharge through the Transaction API.

The following example shows how to process a credit card sale using raw card data.

The following section outlines how to process an Authorization or Sale transaction type using the Transaction API.

customFields Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
C	customFields	array		An array containing a list of custom fields denoted by two fields: name and value.

customField List Entry

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
C	name	string		The name defined for the custom field.
C	value	string		The value for the custom field.

The following request shows how to process a Sale Transaction with a Dynamic Descriptor using the Transaction API.

The following section outlines how to process a transaction with a Dynamic Descriptor using the Transaction API.

Note that Dynamic Descriptors are not supported on all processors. View the BridgePay processor matrix to confirm:

BridgePay Gateway API - Processor Matrix (site.com)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
C	address	string	38	Used to modify Dynamic Descriptor Address where supported with processors
C	city	string	38	Used to modify Dynamic Descriptor City where supported with processors
C	countryCode	string	21	Used to modify Dynamic Descriptor Country Code where supported with processors
C	county	string	21	Used to modify Dynamic Descriptor County where supported with processors
C	emailAddress	string	21	Used to modify Dynamic Descriptor Email Address where supported with processors
C	postalCode	string	15	Used to modify Dynamic Descriptor Postal Code where supported with processors
C	region	string	3	Used to modify Dynamic Descriptor Region where supported with processors
C	text	string	60	Used to modify Dynamic Descriptor Name or Text where supported with processors

","event":[{"listen":"prerequest","script":{"id":"b9f40ad0-cf9c-4169-b8fc-f20232853dc6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9813bdb9-e6fe-4b69-8b7a-11c3c141fe80","type":"text/javascript","exec":[""]}}],"_postman_id":"bb79e496-026d-43a6-932d-da5d9c911807","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Gift Cards","item":[{"name":"Gift Card Sale","id":"53556611-0639-42c3-b199-9e7668d392af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"paymentAccountNumber\": \"################\",\r\n \"expirationDate\": \"1235\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test\",\r\n \"street\": \"8320 street St SE\",\r\n \"city\": \"city\",\r\n \"state\": \"FL\",\r\n \"zip\": \"22222\",\r\n \"countryCode\": \"US\",\r\n \"phone\": \"1231231234\",\r\n \"email\": \"a@a.aa\"\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"RE\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"G\",\r\n \"transactionMode\": \"N\",\r\n \"amount\": 123,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following request shows how to process a Gift Card Sale transaction using the Transaction API.

The following request shows how to process a Gift Card Activate transaction type using the Transaction API.

This transaction type is used to enable a particular gift card or add funds to an existing gift card.

The following request shows how to process a Gift Card Deactivate transaction type using the Transaction API.

This transaction type is used to disable a particular gift card.

Use Deactive with extreme caution. WIth most gift card processors, Deactivation will deactive the card forever, and it cannot be Reactivated.

The following request shows how to process a Gift Card Reactivate transaction using the Transaction API.

This transaction type is used to add funds to an existing Gift Card. Note that this transaction type is not supported with all processors.

The following request shows how to process a Gift Card Balance transaction using the Transaction API.

This transaction type is used to check the current balance of an existing Gift Card.

The following section outlines how to process Gift Card transactions using the Transaction API.

\n","event":[{"listen":"prerequest","script":{"id":"7e2a4fa2-4092-4222-971b-7db6db5642b6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"34218dcf-9244-404d-a6f3-dbf01a98b4a8","type":"text/javascript","exec":[""]}}],"_postman_id":"6adcf992-49e7-4ad1-aec5-54316a36e12f","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Healthcare","item":[{"name":"Healthcare","id":"b23178ef-e73e-4b75-8843-f5e3b960d3bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"paymentAccountNumber\": \"4111111111111111\",\r\n \"expirationDate\": \"1235\",\r\n \"securityCode\": \"111\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test\"\r\n },\r\n \"healthcare\": {\r\n \"healthCareAmount\": 100,\r\n \"transitAmount\": 0,\r\n \"prescriptionAmount\": 0,\r\n \"visionAmount\": 0,\r\n \"dentalAmount\": 0,\r\n \"clinicAmount\": 0,\r\n \"isQualifiedIIAS\": true,\r\n \"copayAmount\": 0\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transIndustryType\": \"HC\",\r\n \"transactionType\": \"sale\",\r\n \"TransCatCode\": \"H\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"amount\": 1256,\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"N\",\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}},"urlObject":{"path":["Transaction.API","api","transaction"],"host":["https://www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"2347ebf2-7c2a-4455-bc37-fae1b68c6ba8","name":"Healthcare","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"paymentAccountNumber\": \"4111111111111111\",\r\n \"expirationDate\": \"1235\",\r\n \"securityCode\": \"111\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test\"\r\n },\r\n \"healthcare\": {\r\n \"healthCareAmount\": 100,\r\n \"transitAmount\": 0,\r\n \"prescriptionAmount\": 0,\r\n \"visionAmount\": 0,\r\n \"dentalAmount\": 0,\r\n \"clinicAmount\": 0,\r\n \"isQualifiedIIAS\": true,\r\n \"copayAmount\": 0\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transIndustryType\": \"HC\",\r\n \"transactionType\": \"sale\",\r\n \"TransCatCode\": \"H\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"amount\": 1256,\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"N\",\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"cardType\": \"Visa\",\n \"token\": \"1000000010261111\",\n \"authorizationCode\": \"838482\",\n \"referenceNumber\": \"364267317\",\n \"gatewayResult\": \"00000\",\n \"authorizedAmount\": 1256,\n \"originalAmount\": 1256,\n \"expirationDate\": \"1230\",\n \"avsResult\": \"4E\",\n \"avsMessage\": \"Street address and 5-digit ZIP match\",\n \"cvResult\": \"N\",\n \"cvMessage\": \"Not matches\",\n \"isCommercialCard\": \"False\",\n \"gatewayTransID\": \"69398604\",\n \"gatewayMessage\": \"A01 - Approved\",\n \"internalMessage\": \"Approved: 838482 (approval code)\",\n \"transactionDate\": \"20221104\",\n \"remainingAmount\": 0,\n \"isoCountryCode\": \"840\",\n \"isoCurrencyCode\": \"USD\",\n \"isoTransactionDate\": \"2022-11-04T13:20:37.83\",\n \"isoRequestDate\": \"2022-11-04T13:20:37.83\",\n \"networkReferenceNumber\": \"364267317\",\n \"merchantCategoryCode\": \"5999\",\n \"networkMerchantId\": \"1939001\",\n \"networkTerminalId\": \"10001\",\n \"maskedPAN\": \"************1111\",\n \"responseTypeDescription\": \"sale\",\n \"cardBIN\": \"41111111\",\n \"cardClass\": \"Visa\",\n \"cardIdentifier\": \"Credit\",\n \"cardModifier\": \"FSA\",\n \"cardHolderName\": \"Test\",\n \"providerResponseMessage\": \"Approved\",\n \"organizationId\": \"13808\",\n \"merchantAccountCode\": \"1939001\",\n \"transactionID\": \"transactionID123\",\n \"requestType\": \"004\",\n \"responseCode\": \"00000\",\n \"responseDescription\": \"Successful Request\"\n}"}],"_postman_id":"b23178ef-e73e-4b75-8843-f5e3b960d3bc"}],"id":"98896418-4aa6-493e-b58b-6aa8d095e5a7","description":"

The following section outlines how to process a HealthCare transaction using the Transaction API.

The cardModifier data element will return FSA if the card used in the transaction was FSA/HSA, isQualifiedIIAS=true and healthCareAmt is greater than 0.

Note that Healthcare data is only permitted on Visa and Mastercard transactions. Healthcare data should not be sent on American Express or Discover transactions. American Express and Discover transactions should be run as E-Commerce, Direct Marketing, or Retail depending on the context.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
R	healthCareAmount	integer	8	The portion of the Total Amount spent on healthcare related services or products. Processed as implied decimal. $1.25 would be represented as 125.
O	transitAmount	integer	8	The portion of the Total Amount spent on healthcare related transportation. Processed as implied decimal. $1.25 would be represented as 125.
O	prescriptionAmount	integer	8	The portion of the Healthcare Amount spent on prescription drugs or products. Processed as implied decimal. $1.25 would be represented as 125.
O	visionAmount	integer	8	The portion of the Healthcare Amount spent on vision related medical services. Processed as implied decimal. $1.25 would be represented as 125.
O	dentalAmount	integer	8	The portion of the Healthcare Amount spent on dental related medical services. Processed as implied decimal. $1.25 would be represented as 125.
O	clinicAmount	integer	8	The portion of the Healthcare Amount spent on hospitalization. Processed as implied decimal. $1.25 would be represented as 125.
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’.
O	copayAmount	integer	8	The copay amount of the transaction. Processed as implied decimal. $1.25 would be represented as 125.

","event":[{"listen":"prerequest","script":{"id":"0a762d8e-2a89-4ab6-bdfd-8018c7cd5683","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e514fb1b-24f4-4078-a4dd-7f7ea967612a","type":"text/javascript","exec":[""]}}],"_postman_id":"98896418-4aa6-493e-b58b-6aa8d095e5a7","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Level II & III","item":[{"name":"Level II & III","id":"35915084-5a89-4b51-9f0e-0bb2e9936ef9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"paymentAccountNumber\": \"4111111111111111\",\r\n \"expirationDate\": \"1235\",\r\n \"securityCode\": \"111\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test\"\r\n },\r\n \"level2\": {\r\n \"taxRate\": 550,\r\n \"taxamount\": 125,\r\n \"taxIndicator\": \"P\",\r\n \"shipToName\": \"shipToNameTEST\",\r\n \"shipToStreet\": \"shipToStreetTEST\",\r\n \"shipToCity\": \"shipToCityngTEST\",\r\n \"shipToState\": \"shipToStateTEST\",\r\n \"shipToZip\": \"12345\",\r\n \"shipToCountryCode\": \"US\"\r\n },\r\n \"level3\": {\r\n \"shippingOriginZip\": \"12345\",\r\n \"discountamount\": 125,\r\n \"shippingamount\": 125,\r\n \"dutyamount\": 125,\r\n \"taxInvoiceCode\": \"taxInvoiceCode\",\r\n \"localTaxamount\": 125,\r\n \"localTaxIndicator\": \"P\",\r\n \"nationalTaxamount\": 125,\r\n \"nationalTaxIndicator\": \"P\",\r\n \"orderCode\": \"orderCode113322\",\r\n \"orderDate\": \"20220216\",\r\n \"commodityCode\": \"5999\",\r\n \"customerAccountTaxId\": \"123456789\",\r\n \"items\": [\r\n {\r\n \"code\": \"5999\",\r\n \"commodityCode\": \"5999\",\r\n \"description\": \"An Item\",\r\n \"quantity\": 1,\r\n \"unitCostamount\": 223,\r\n \"unitMeasure\": \"ea\",\r\n \"taxamount\": 0,\r\n \"taxRate\": 0,\r\n \"taxIndicator\": \"N\",\r\n \"taxCode\": \"0\",\r\n \"discountRate\": 0,\r\n \"discountamount\": 0,\r\n \"totalamount\": 100,\r\n \"isCredit\": true\r\n }\r\n ]\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transIndustryType\": \"RE\",\r\n \"transactionType\": \"sale\",\r\n \"TransCatCode\": \"R\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"amount\": 1256,\r\n \"holderType\": \"O\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"N\",\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following example shows how to process a Level III transaction. To process a Level II transaction, this example would stay the same; however, the Level III object would be removed.

The following section outlines how to process a Level II or III transaction through the Transaction API.

For Level III transactions, holderType must be set to O.

Level2

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
C	taxRate	integer	5	Additional Tax Amount. REQUIRED FOR LEVEL II/III. Processed as implied decimal. 5.5% would be represented as 550.
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	ISO 3166-1 alpha-2 codes.Shipping address country code. REQUIRED FOR LEVEL II/III.

Level3

Required	Data Element	Data Type	Length	Description
C	shippingOriginZip	string	10	Postal code of the origin of the shipment. 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. REQUIRED FOR LEVEL III.
C	discountAmount	integer	8	Processed as implied decimal. $1.25 would be represented as 125. Additional discount amount. REQUIRED FOR LEVEL III.
C	shippingAmount	integer	8	Processed as implied decimal. $1.25 would be represented as 125. Additional discount amount. REQUIRED FOR LEVEL III.
C	dutyAmount	integer	8	Processed as implied decimal. $1.25 would be represented as 125. Additional discount amount. REQUIRED FOR LEVEL III.
C	taxInvoiceCode	string	15	Must be at least 1 and up to 15 characters. When separate VAT invoice is produced within the context of the order, unique identifier of this invoice. REQUIRED FOR LEVEL III.
C	localTaxAmount	integer	8	Processed as implied decimal. $1.25 would be represented as 125. Additional Local Tax Amount. REQUIRED FOR LEVEL III.
C	localTaxIndicator	string	1	P (Provided), N (Not Provided), or E (Exempt). REQUIRED FOR LEVEL III.
C	nationalTaxAmount	integer	8	Processed as implied decimal. $1.25 would be represented as 125. Additional National Tax Amount. REQUIRED FOR LEVEL III.
C	nationalTaxIndicator	string	1	P (Provided), N (Not Provided), or E (Exempt). REQUIRED FOR LEVEL III.
C	orderCode	string	17	Unique identifier assigned to the order associated with this transaction in submitter's/merchant's front-end/ inventory system. REQUIRED FOR LEVEL III.
C	orderDate	string	8	Date in format YYYYMMDD. Date when the order associated with the transaction was placed. REQUIRED FOR LEVEL III.
C	commodityCode	string	4	Acquirer designated standardized code that classifies the group of items associated with this order/transaction. REQUIRED FOR LEVEL III.
C	customerAccountTaxId	string	13	VAT registration number of the customer responsible for this transaction. REQUIRED FOR LEVEL III
C	items	object		The Level3Item object outlined in the following table.

Level3Item

Data Element	Data Type	Length	Description
code	string	12	Unique identifier assigned to this item in the submitter’s inventory system.
commodityCode	string	12	Acquirer designated standardized code that classifies this item.
description	string	35	Short description of the item.
quantity	integer	12	Quantity of item units purchased as part of this transaction. Up to 4 decimal places.
unitCostAmount	integer	12	Cost of a single unit of the item. Processed as implied decimal. $1.25 would be represented as 125.
unitMeasure	string	12	Unit of measure used to quantify the items purchased/refunded (e.g. kg, lb., inch).
taxAmount	integer	8	Processed as implied decimal. $1.25 would be represented as 125. Amount of tax charged for this item.
taxRate	integer	12	Rate of the tax (if any) charged on this item. Processed as implied decimal. 5.5% would be represented as 550.
taxIndicator	string	1	P (Provided), N (Not provided), or E (Exempt).
taxCode	string	4	Acquirer designated value classifying the tax that was charged for this item.
discountRate	integer	8	Rate of discount (if any) that was applied to this item. Processed as implied decimal. 5.5% would be represented as 550.
discountAmount	integer	8	Total amount of discount applied to this item. Processed as implied decimal. $1.25 would be represented as 125.
totalAmount	integer	8	Total amount paid for the item (including tax and discount). Processed as implied decimal. $1.25 would be represented as 125.
isCredit	boolean	1	True (Item is being returned), False (Default if not passed - Item is being purchased).

","event":[{"listen":"prerequest","script":{"id":"837663bd-78e3-4691-a6b9-323e50254933","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b5d76fa8-e208-4a74-bd71-f8aa3113fd4d","type":"text/javascript","exec":[""]}}],"_postman_id":"e2deddee-8d16-4408-a8dd-c66ff220a466","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Lodging","item":[{"name":"Credit Card Authorization (Lodging)","id":"31b4293a-e418-4b29-86c8-1bddb8bbad6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"paymentAccountNumber\": \"4111111111111111\",\r\n \"expirationDate\": \"1235\",\r\n \"securityCode\": \"111\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test\",\r\n \"street\": \"8320 street road\",\r\n \"city\": \"city\",\r\n \"state\": \"FL\",\r\n \"zip\": \"22222\",\r\n \"countryCode\": \"US\",\r\n \"phone\": \"1231231234\",\r\n \"email\": \"a@a.aa\"\r\n },\r\n \"lodging\": {\r\n \"roomNumber\": \"12A\",\r\n \"folioNumber\": \"123456\",\r\n \"roomRateAmount\": 500,\r\n \"roomTaxAmount\": 100,\r\n \"lodgingChargeType\": \"H\",\r\n \"checkInDate\": \"2023-08-25T09:14:17.612755+04:00\",\r\n \"checkOutDate\": \"2023-09-01T14:39:23.513481+04:00\",\r\n \"duration\": 8,\r\n \"specialProgramType\": \"AR\",\r\n \"departureAdjustmentAmount\": 100,\r\n \"lodgingItems\": [\r\n {\r\n \"amount\": 200,\r\n \"type\": \"B\"\r\n },\r\n {\r\n \"amount\": 300,\r\n \"type\": \"T\"\r\n }\r\n ]\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale-auth\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"LD\",\r\n \"settlementDelay\": \"7\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"N\",\r\n \"amount\": 1200,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following example shows how to process a credit card authorization using raw card data.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}},"urlObject":{"path":["Transaction.API","api","transaction"],"host":["https://www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"b990ecdf-4b02-441a-88e3-35a169f02947","name":"Credit Card Authorization (Lodging)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"paymentAccountNumber\": \"4111111111111111\",\r\n \"expirationDate\": \"1235\",\r\n \"securityCode\": \"111\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test\",\r\n \"street\": \"8320 street road\",\r\n \"city\": \"city\",\r\n \"state\": \"FL\",\r\n \"zip\": \"22222\",\r\n \"countryCode\": \"US\",\r\n \"phone\": \"1231231234\",\r\n \"email\": \"a@a.aa\"\r\n },\r\n \"lodging\": {\r\n \"roomNumber\": \"12A\",\r\n \"folioNumber\": \"123456\",\r\n \"roomRateAmount\": 500,\r\n \"roomTaxAmount\": 100,\r\n \"lodgingChargeType\": \"H\",\r\n \"checkInDate\": \"2023-08-25T09:14:17.612755+04:00\",\r\n \"checkOutDate\": \"2023-09-01T14:39:23.513481+04:00\",\r\n \"duration\": 8,\r\n \"specialProgramType\": \"AR\",\r\n \"departureAdjustmentAmount\": 100,\r\n \"lodgingItems\": [\r\n {\r\n \"amount\": 200,\r\n \"type\": \"B\"\r\n },\r\n {\r\n \"amount\": 300,\r\n \"type\": \"T\"\r\n }\r\n ]\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale-auth\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"LD\",\r\n \"settlementDelay\": \"7\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"N\",\r\n \"amount\": 1200,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"cardType\": \"Visa\",\n \"token\": \"1000000010261111\",\n \"authorizationCode\": \"796045\",\n \"referenceNumber\": \"804414233\",\n \"gatewayResult\": \"00000\",\n \"authorizedAmount\": 1234,\n \"originalAmount\": 1234,\n \"expirationDate\": \"1235\",\n \"avsResult\": \"4E\",\n \"avsMessage\": \"Street address and 5-digit ZIP match\",\n \"cvResult\": \"M\",\n \"cvMessage\": \"Matches\",\n \"isCommercialCard\": \"False\",\n \"gatewayTransID\": \"4527206405\",\n \"gatewayMessage\": \"A01 - Approved\",\n \"internalMessage\": \"Approved: 796045 (approval code)\",\n \"transactionDate\": \"20240531\",\n \"remainingAmount\": 0,\n \"isoCountryCode\": \"840\",\n \"isoCurrencyCode\": \"USD\",\n \"isoTransactionDate\": \"2024-05-31T12:52:31.863\",\n \"isoRequestDate\": \"2024-05-31T12:52:31.863\",\n \"networkReferenceNumber\": \"804414233\",\n \"merchantCategoryCode\": \"5999\",\n \"networkMerchantId\": \"14243001\",\n \"networkTerminalId\": \"10001\",\n \"maskedPAN\": \"************1111\",\n \"responseTypeDescription\": \"auth\",\n \"cardBIN\": \"41111111\",\n \"cardClass\": \"Visa\",\n \"cardIdentifier\": \"Credit\",\t\n \"cardModifier\": \"None\",\n \"cardHolderName\": \"Test\",\n \"providerResponseMessage\": \"Approved\",\n \"organizationId\": \"59900\",\n \"merchantAccountCode\": \"14243001\",\n \"transactionID\": \"transactionID123\",\n \"requestType\": \"004\",\n \"responseCode\": \"00000\",\n \"responseDescription\": \"Successful Request\"\n}"}],"_postman_id":"31b4293a-e418-4b29-86c8-1bddb8bbad6e"},{"name":"Increment (Lodging)","id":"c69b7703-76d2-444a-b856-e12c3fc19d5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"increment\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"referenceNumber\": \"gatewayTransID from original transaction\",\r\n \"amount\": 500,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}},"urlObject":{"path":["Transaction.API","api","transaction"],"host":["https://www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"402d0a93-5c5d-4ff3-ad5a-b121ae73bbe4","name":"Increment (Lodging)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"increment\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"referenceNumber\": \"gatewayTransID from original transaction\",\r\n \"amount\": 500,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"cardType\": \"None\",\n \"authorizationCode\": \"796045\",\n \"gatewayResult\": \"00000\",\n \"authorizedAmount\": 2834,\n \"isCommercialCard\": \"False\",\n \"gatewayTransID\": \"4527206405\",\n \"gatewayMessage\": \"A09 - Incremental Auth Posted\",\n \"internalMessage\": \"Incremental Auth Posted\",\n \"remainingAmount\": 0,\n \"cardClass\": \"None\",\n \"cardModifier\": \"None\",\n \"organizationId\": \"59900\",\n \"merchantAccountCode\": \"14243001\",\n \"transactionID\": \"transactionID123\",\n \"requestType\": \"004\",\n \"responseCode\": \"00000\",\n \"responseDescription\": \"Successful Request\"\n}"}],"_postman_id":"c69b7703-76d2-444a-b856-e12c3fc19d5b"},{"name":"Capture Authorization (Lodging)","id":"ef1ab3c5-4a70-48cb-9bd7-b5b38941620c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionID\": \"transactionID123\",\r\n \"amount\": 1700,\r\n \"merchantAccountCode\": \"#####\",\r\n \"referenceNumber\": \"gatewayTransID from original authorization\",\r\n \"Memo\": \"Capture Auth\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"N\",\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\",\r\n \"Lodging\": {\r\n \"RoomNumber\": \"12A\",\r\n \"FolioNumber\": \"123456\",\r\n \"RoomRateamount\": 500,\r\n \"RoomTaxamount\": 100,\r\n \"LodgingChargeType\": \"H\",\r\n \"CheckInDate\": \"2023-08-25T09:14:17.612755+04:00\",\r\n \"CheckOutDate\": \"2023-09-01T14:39:23.513481+04:00\",\r\n \"Duration\": 8,\r\n \"SpecialProgramType\": \"AR\",\r\n \"departureAdjustmentAmount\": 600,\r\n \"LodgingItems\": [\r\n {\r\n \"amount\": 300,\r\n \"Type\": \"B\"\r\n },\r\n {\r\n \"amount\": 300,\r\n \"Type\": \"T\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction/capture","description":"

When processing an unreferenced refund in the lodging industry type, you must provide lodging data in the refund request. This is not required for referenced refunds.

The following section outlines how to process a Lodging transaction using the Transaction API. Note that Partial Authorizations are not permitted for Lodging Transactions. Also note that all Lodging data elements are required if including Lodging information in the transaction. Omitting a data element could result in an error.

Clients processing lodging industry transactions and desiring to itemize the charges for additional service can include lodging items sub-records as a part of the request message.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
C	roomNumber	string	25	Hotel room number
C	folioNumber	string	15	Hotel folio number Required for all lodging transactions.
C	roomRateAmount	integer	8	Daily room rate. Implied decimal. Required when LodgingChargeType = 'H'
C	roomTaxAmount	integer	8	Tax charged on daily rate. Implied decimal. This amount shall not exceed RoomRateAmount
C	lodgingChargeType	string	1	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	string		The date of actual or anticipated check-in. Required when LodgingChargeType = 'H'
C	checkOutDate	string		The date of actual or anticipated check-out Required when LodgingChargeType = 'H'
C	duration	integer		Indicates the length of anticipated, actual or incremental stay.
C	specialProgramType	string	2	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'
C	departureAdjustmentAmount	integer	8	Additional amount charged after the cardholder left the hotel.
C	lodgingItems	object		The lodgingItems object.

LodgingItem

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
C	type	string	1	Lodging extra charge type : G = Gift Shop L = Laundry B = Mini bar R = Restaurant T = Telephone
C	amount	integer	8	Amount for lodging extra charge item. Implied decimal.

The following example shows how to process a push-payment transaction. This requires a transactionType value of \"push-payment\".

The following examples shows how to perform a push-inquiry. This function is used to determine if a push-payment can be performed to a particular card.

Push Payments are transactions in which the merchant is sending, or pushing, funds to the cardholder. The BridgePay gateway supports two functions: push-payment and push-inquiry.

push-payments are done via the transaction endpoint. Push-inquirys are done via a dedicated push-inquiry endpoint as shown in the following examples.

This functionality is supported via the Repay processor and requires the use of specific test cards. If you intend to use push payments in your integration, request the push payment processor setup when submitting your test account request. Please see the test card page linked in the appendix.

\n","_postman_id":"64ce8d53-8cb2-4fe5-80b3-462b8423c49c","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Service Fee","item":[{"name":"Service Fee","id":"25b10827-ad41-4623-b6c5-590a1aa97c9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"paymentAccountNumber\": \"4111111111111111\",\r\n \"expirationDate\": \"1235\",\r\n \"securityCode\": \"111\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test\",\r\n \"street\": \"8320 street St SE\",\r\n \"city\": \"city\",\r\n \"state\": \"FL\",\r\n \"zip\": \"22222\",\r\n \"countryCode\": \"US\",\r\n \"phone\": \"1231231234\",\r\n \"email\": \"a@a.aa\"\r\n },\r\n \"ServiceFees\": [\r\n {\r\n \"ServiceFeeId\": \"SrvFee12345\",\r\n \"amount\": 500,\r\n \"merchantAccountCode\": \"#####\",\r\n \"ServiceUser\": \"#####\",\r\n \"ServicePassword\": \"#####\"\r\n }\r\n ],\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"RE\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"N\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following example shows how to process a credit card Sale with a Service Fee using raw card data.

The following section outlines how to process a Sale transaction with a Service Fee using the Transaction API.

The Transaction API can process a separate service fee transaction for a given principal transaction by providing data about the service fee in the request message.

Note that when voiding or refunding a transaction with an associated service fee, the gateway will automatically void or refund the service fee.

serviceFee Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Description
C	serviceFeeId	string	A user-defined identifier that will be returned in the response
O	resellerCode	string	The code of the reseller that owns the service merchant account. Use if not providing service credentials.
C	merchantAccountCode	string	The code of the service merchant account. Use if not providing service credentials.
C	amount	integer	The implied decimal implementation of the service fee amount.
C	serviceUser	string	The username associated with the merchant service fee account. Use if not providing ResellerCode, MerchantCode and MerchantAccountCode.
C	servicePassword	string	The password associated with the merchant service fee account. Use if not providing ResellerCode, MerchantCode and MerchantAccountCode.
C	wallet	string
C	walletPaymentMethodID	string

serviceFeeResults

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Data Element	Data Type	Length	Description
serviceFeeID	string		The user-defined identifier associated with the service fee request
authorizationCode	string	50	The transaction authorization code returned from the processor.
referenceNumber	string		The network reference number for the service fee transaction.
gatewayResult	string		5 digit response code for the result of the service fee request
authorizedAmount	integer		Implied decimal representation of the amount that was authorized/charged/refunded.
originalAmount	integer		Implied decimal representation of the amount that was requested to be authorized/charged/refunded.
gatewayTransID	string		Transaction ID from the gateway (used as Reference Number for Voids / Refunds).
gatewayMessage	string		Response message from the gateway for the transaction.
internalMessage	string		Provides more information from the gateway and processor regarding the results of the transaction request.
providerResponseCode	string		Displays the response code as provided by the Processor for the Service Fee transaction.
providerResponseMessage	string		Displays the response message as provided by the Processor for the Service Fee transaction.

","event":[{"listen":"prerequest","script":{"id":"8c062464-09aa-491b-8401-d1c53001032b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a413827a-fd42-4453-a594-855c57a34c72","type":"text/javascript","exec":[""]}}],"_postman_id":"b0aadccf-e2da-476a-89b0-afb8592e8f0d","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Tips (Retail)","item":[{"name":"Credit Card Authorization w/Tip (Retail)","id":"13a879cd-866e-46d2-9fe9-e67bbb686ad1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payment\": {\r\n \"paymentAccountNumber\": \"4111111111111111\",\r\n \"expirationDate\": \"1235\",\r\n \"securityCode\": \"111\"\r\n },\r\n \"accountHolder\": {\r\n \"name\": \"Test\",\r\n \"street\": \"8320 street St SE\",\r\n \"city\": \"city\",\r\n \"state\": \"FL\",\r\n \"zip\": \"22222\",\r\n \"countryCode\": \"US\",\r\n \"phone\": \"1231231234\",\r\n \"email\": \"a@a.aa\"\r\n },\r\n \"tip\": {\r\n \"tipAmount\": 500,\r\n \"tipRecipientCode\": \"tRCode\"\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale-auth\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"RE\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"N\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following example shows how to process a credit card authorization using raw card data.

The following example shows how to process a credit card sale using raw card data.

The following section outlines how to process an Authorization or Sale transaction type with a Tip using the Transaction API.

payment

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
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	tipRecipientCode	string	15	Can contain alphanumerics, hyphens, and periods. Server ID for the customer.

The following example shows how to process a credit card authorization using raw card data.

The following example shows how to process a credit card sale using raw card data.

The following section outlines how to process an Authorization or Sale transaction type with a Tip using the Transaction API.

payment

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
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	tipRecipientCode	string	15	Can contain alphanumerics, hyphens, and periods. Server ID for the customer.

The following example shows how to process a credit card sale using Track Data.

The following section outlines how to process a transaction using Track Data through the Transaction API.

If your integration requires sending track information in separate fields, you can use the Track1 and Track2 data elements to send the data.

To send the data without extra encryption, simply send the appropriate data elements in the appropriate fields. You must include all start and end sentinels and the field separators as well.

To send the data with hardware level encryption, your reader must provide the encrypted data in separate fields. This encrypted combined track data would then be placed in the Track1 and Track2 elements respectively.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
1	paymentAccountNumber	string	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.
1	expirationDate	string	22	Expiration date of the card. If present, the supported format are: MMYY and MM/YY. Required if track data not present.
O	securityCode	string	3-4	When present, must be 3 or 4 digits long CVV / CVV2 of the card.
C	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.
C	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.
C	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	token	string		When present, represents the tokenized card number received from a token request. This is used in place of the paymentAccountNumber.
3	bankAccountNumber	string		The bank account number for ACH and Check transactions. Must contain at least one number.
3	routingNumber	string	10	The routing number for ACH and Check transactions. Can contain up to 10 numbers.
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).

","event":[{"listen":"prerequest","script":{"id":"dd7fa1c1-4fdc-4281-961e-4d0dd6b0d347","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"69e7974c-235e-4e3a-a873-5baec139e049","type":"text/javascript","exec":[""]}}],"_postman_id":"69c408ef-ee72-4013-8131-acf2ff207983","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Void/Refund","item":[{"name":"Void","id":"1f5f19f2-9d68-4e6c-8604-42bebebfce09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionID\": \"transactionID123\",\r\n \"referenceNumber\": \"gatewayTransID from original transaction\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"void\",\r\n \"transIndustryType\": \"RE\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"transactionMode\": \"N\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction/voidrefund","description":"

The following request shows how to process a Void transaction type using the Transaction API. Note that a void may only be used on a transaction that has not been settled.

The following request shows how to process a Refund transaction type referencing a prior Sale using the Transaction API. Note that a refund may only be used on a transaction that has been settled.

The following section outlines how to process a Void or Refund using the Transaction API. Note that the Proxy processor in UAT only allows for one partial void or refund. This does not apply to production processors where you can perform more than one partial void or refund.

voidRefundRequest

Required	Data Element	Data Type	Length	Description
R	transactionID	string	60	A unique value, generated by the integrating application, used to identify the transaction.
R	merchantAccountCode	string		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	The amount requested to be refunded / voided. Processed as implied decimal. $1.25 would be represented as 125.
R	referenceNumber	string	12	The gatewayTransID returned as a part of the response to a payment request.
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.
O	token	string	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	folioNumber	string	15	Hotel folio number Required when LodgingChargeType = 'H'
O	checkInDate	string		The date of actual or anticipated check-in. Required when LodgingChargeType = 'H'
R	originatingTechnologySource	string	N/A	Name of software transmitting the transaction.
R	originatingSoftwareVendor	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	customerAccountCode	string	24	Alphanumeric and dashes accepted. User supplied data.
O	invoiceNumber	string	24	Invoice number. Spaces are not allowed. Alphanumeric and dashes accepted. User supplied data.
O	memo	string

voidRefundResponse

Data Element	Data Type	Description
transactionID	string	The transactionID that was send with the request.
requestType	string
responseCode	string
responseDescription	string
merchantAccountCode	string	The merchant account code used to process the original authorization and the void or refund.
responseType	string
referenceNumber	string
gatewayResult	string
gatewayTransID	string
gatewayMessage	string
transactionCode	string
remainingAmount	integer
responseTypeDescription	string
cardType	string
cardClass	string
cardModifier	string
cardHolderName	string
providerResponseCode	string
providerResponseMessage	string
organizationId	string

","event":[{"listen":"prerequest","script":{"id":"0cdbe809-eb71-4b76-b61e-bf7ac8eaba2e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ab78efcc-7407-4e62-b74e-759d17ddc188","type":"text/javascript","exec":[""]}}],"_postman_id":"e3ceee94-bcc9-42c1-bf4a-659d307e66fc","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}}],"id":"5f1bb0df-3f50-4508-9e39-5c8be9840503","description":"

The following section contains examples of Card Not Present transactions through the Transaction API. A card not present transaction is defined as a transaction in which the card data was not directly read off of the card and instead manually keyed into a program, web page, or virtual terminal. The card information is then formatted into a Transaction API request and used to process a transaction.

It is recommended that card data collected on a web page be collected using BridgePay's TokenPay.js product. See the TokenPay.js folder for more information.

\n","_postman_id":"5f1bb0df-3f50-4508-9e39-5c8be9840503","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"TokenPay.js","item":[{"name":"TokenPay Sale","event":[{"listen":"prerequest","script":{"id":"26a79c72-6fe6-4eaa-a711-9d7de07a3765","exec":["var authorizationTokenPay = pm.collectionVariables.get(\"AuthenticationTokenId\") + \":\" + pm.collectionVariables.get(\"TokenPayPrivateKey\")\r","pm.collectionVariables.set(\"AuthorizationTokenPay\", \"TokenPay \" + btoa(authorizationTokenPay));"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"0e6abf59-6bc8-4298-94ae-f2fc1d96ca37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"TokenPay ZjUwMjFkZGYtYWZlMS00ZGI2LTk2MWMtYTY1MTg1ZTc5ZDEzOlR0WE5NWVpVWFJTWldmdzQ=","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountHolder\": {\r\n \"name\": \"Test\"\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"RE\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following example shows how to process a credit card sale using TokenPay.js data.

See the Authentication section above for a description of how the Authorization Header is built. In Javascript, using PostMan collection variables, the pre-request script will look like this:

var authorizationTokenPay = pm.collectionVariables.get(\"AuthenticationTokenId\") + \":\" + pm.collectionVariables.get(\"TokenPayPrivateKey\")\npm.collectionVariables.set(\"AuthorizationTokenPay\", \"TokenPay \" + btoa(authorizationTokenPay));\n\n

\n","urlObject":{"path":["Transaction.API","api","transaction"],"host":["https://www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"e37dbcf2-1d23-4192-98dd-790de5485f24","name":"TokenPay Sale CC","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"accountHolder\": {\r\n \"name\": \"Test\"\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"RE\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"cardType\": \"Visa\",\n \"token\": \"1000000010261111\",\n \"authorizationCode\": \"370806\",\n \"referenceNumber\": \"251779553\",\n \"gatewayResult\": \"00000\",\n \"authorizedAmount\": 2500,\n \"originalAmount\": 2500,\n \"expirationDate\": \"0225\",\n \"avsResult\": \"4E\",\n \"avsMessage\": \"Street address and 5-digit ZIP match\",\n \"cvResult\": \"N\",\n \"cvMessage\": \"Not matches\",\n \"isCommercialCard\": \"False\",\n \"gatewayTransID\": \"70076204\",\n \"gatewayMessage\": \"A01 - Approved\",\n \"internalMessage\": \"Approved: 370806 (approval code)\",\n \"transactionDate\": \"20230605\",\n \"remainingAmount\": 0,\n \"isoCountryCode\": \"840\",\n \"isoCurrencyCode\": \"USD\",\n \"isoTransactionDate\": \"2023-06-05T17:36:21.553\",\n \"isoRequestDate\": \"2023-06-05T17:36:21.553\",\n \"networkReferenceNumber\": \"251779553\",\n \"merchantCategoryCode\": \"5999\",\n \"networkMerchantId\": \"1939001\",\n \"networkTerminalId\": \"10001\",\n \"maskedPAN\": \"************1111\",\n \"responseTypeDescription\": \"sale\",\n \"cardBIN\": \"41111111\",\n \"cardClass\": \"Visa\",\n \"cardIdentifier\": \"Credit\",\n \"cardModifier\": \"None\",\n \"cardHolderName\": \"Test\",\n \"providerResponseMessage\": \"Approved\",\n \"organizationId\": \"13808\",\n \"merchantAccountCode\": \"1939001\",\n \"transactionID\": \"transactionID123\",\n \"requestType\": \"004\",\n \"responseCode\": \"00000\",\n \"responseDescription\": \"Successful Request\"\n}"},{"id":"a2d3fa70-dce8-44b6-8d5c-810abd7a650d","name":"TokenPay Sale ACH","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"accountHolder\": {\r\n \"name\": \"Test\"\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"sale\",\r\n \"invoiceNumber\": \"InvoiceNumber123\",\r\n \"transIndustryType\": \"RE\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"amount\": 1234,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"cardType\": \"None\",\n \"token\": \"11110000000000697890\",\n \"gatewayResult\": \"00000\",\n \"authorizedAmount\": 1234,\n \"originalAmount\": 1234,\n \"isCommercialCard\": \"False\",\n \"gatewayTransID\": \"4439332404\",\n \"gatewayMessage\": \"A01 - Approved\",\n \"internalMessage\": \"Approved: Accepted (no approval code)\",\n \"transactionDate\": \"20230809\",\n \"remainingAmount\": 0,\n \"isoCountryCode\": \"840\",\n \"isoCurrencyCode\": \"USD\",\n \"isoTransactionDate\": \"2023-08-09T12:02:35.063\",\n \"isoRequestDate\": \"2023-08-09T12:02:35.063\",\n \"responseTypeDescription\": \"sale\",\n \"cardClass\": \"None\",\n \"cardModifier\": \"None\",\n \"cardHolderName\": \"Test\",\n \"organizationId\": \"11861\",\n \"merchantAccountCode\": \"12345001\",\n \"transactionID\": \"transactionID123\",\n \"requestType\": \"004\",\n \"responseCode\": \"00000\",\n \"responseDescription\": \"Successful Request\"\n}"}],"_postman_id":"0e6abf59-6bc8-4298-94ae-f2fc1d96ca37"},{"name":"TokenPay Push Payment","event":[{"listen":"prerequest","script":{"id":"26a79c72-6fe6-4eaa-a711-9d7de07a3765","exec":["var authorizationTokenPay = pm.collectionVariables.get(\"AuthenticationTokenId\") + \":\" + pm.collectionVariables.get(\"TokenPayPrivateKey\")\r","pm.collectionVariables.set(\"AuthorizationTokenPay\", \"TokenPay \" + btoa(authorizationTokenPay));"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"ab705401-d79c-4621-9adc-4b829cef548e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"TokenPay ZjUwMjFkZGYtYWZlMS00ZGI2LTk2MWMtYTY1MTg1ZTc5ZDEzOlR0WE5NWVpVWFJTWldmdzQ=","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountHolder\": {\r\n \"name\": \"Test\",\r\n \"street\": \"8320 street St SE\",\r\n \"city\": \"city\",\r\n \"state\": \"FL\",\r\n \"zip\": \"22222\",\r\n \"countryCode\": \"US\",\r\n \"phone\": \"1231231234\",\r\n \"email\": \"a@a.aa\"\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"transactionType\": \"push-payment\",\r\n \"invoiceNumber\": \"InvNum123\",\r\n \"transIndustryType\": \"RE\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"amount\": 2500,\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction","description":"

The following example shows how to process a push-payment using TokenPay.js data.

See the Authentication section above for a description of how the Authorization Header is built. In Javascript, using PostMan collection variables, the pre-request script will look like this:

var authorizationTokenPay = pm.collectionVariables.get(\"AuthenticationTokenId\") + \":\" + pm.collectionVariables.get(\"TokenPayPrivateKey\")\npm.collectionVariables.set(\"AuthorizationTokenPay\", \"TokenPay \" + btoa(authorizationTokenPay));\n\n

The following example shows how to process a push-inquiry using TokenPay.js data.

See the Authentication section above for a description of how the Authorization Header is built. In Javascript, using PostMan collection variables, the pre-request script will look like this:

var authorizationTokenPay = pm.collectionVariables.get(\"AuthenticationTokenId\") + \":\" + pm.collectionVariables.get(\"TokenPayPrivateKey\")\npm.collectionVariables.set(\"AuthorizationTokenPay\", \"TokenPay \" + btoa(authorizationTokenPay));\n\n

\n","urlObject":{"path":["Transaction.API","api","PaymentMethod","pushinquiry"],"host":["https://www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"6302e2dc-10d1-45a7-975c-f1ae9ca93863","name":"TokenPay Push Inquiry","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"TokenPay ZjUwMjFkZGYtYWZlMS00ZGI2LTk2MWMtYTY1MTg1ZTc5ZDEzOlR0WE5NWVpVWFJTWldmdzQ=","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountHolder\": {\r\n \"name\": \"Test\",\r\n \"street\": \"8320 street St SE\",\r\n \"city\": \"city\",\r\n \"state\": \"FL\",\r\n \"zip\": \"22222\",\r\n \"countryCode\": \"US\",\r\n \"phone\": \"1231231234\",\r\n \"email\": \"a@a.aa\"\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"invoiceNumber\": \"InvNum123\",\r\n \"transIndustryType\": \"RE\",\r\n \"holderType\": \"P\",\r\n \"accountType\": \"R\",\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/PaymentMethod/pushinquiry"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"cardBIN\": \"41111111\",\n \"cardClass\": \"Visa\",\n \"cardIdentifier\": \"Credit\",\t\n \"transactionType\": \"PushInquiry\",\n \"responseType\": \"Good\",\n \"token\": \"11110000000623390004\",\n \"expirationDate\": \"1225\",\n \"referenceNumber\": \"4506308505\",\n \"gatewayResult\": \"00000\",\n \"gatewayMessage\": \"A01 - Approved(SUCCESSFUL)\",\n \"transactionDate\": \"20240220\",\n \"providerReferenceNumber\": \"1893314a-d72a-419b-a898-00d1d8b97c0f\",\n \"organizationId\": \"15950\",\n \"transactionID\": \"transactionID123\",\n \"requestType\": \"015\",\n \"responseCode\": \"00000\",\n \"responseDescription\": \"Successful Request\"\n}"}],"_postman_id":"2248d53c-939b-4a50-b1ec-29365fc53f26"},{"name":"TokenPay Card Verification","event":[{"listen":"prerequest","script":{"id":"84a35f0c-aa87-4d68-bff9-b1403aa46836","exec":["var authorizationTokenPay = pm.collectionVariables.get(\"AuthenticationTokenId\") + \":\" + pm.collectionVariables.get(\"TokenPayPrivateKey\")\r","pm.collectionVariables.set(\"AuthorizationTokenPay\", \"TokenPay \" + btoa(authorizationTokenPay));"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"06530bff-e1b0-4455-a7d9-7830074d22d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"TokenPay ZjUwMjFkZGYtYWZlMS00ZGI2LTk2MWMtYTY1MTg1ZTc5ZDEzOlR0WE5NWVpVWFJTWldmdzQ=","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"accountHolder\": {\r\n \"name\": \"Test\",\r\n \"street\": \"8320 Fun Rd\",\r\n \"zip\": \"55555\"\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"holderType\": \"P\",\r\n \"transIndustryType\": \"RE\",\r\n \"accountType\": \"R\",\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/PaymentMethod/verify","description":"

The following request shows how to process a Card Verification transaction using TokenPay.js data. This request is used to validate card information without processing an authorization.

See the Authentication section above for a description of how the Authorization Header is built. In Javascript, using PostMan collection variables, the pre-request script will look like this:

var authorizationTokenPay = pm.collectionVariables.get(\"AuthenticationTokenId\") + \":\" + pm.collectionVariables.get(\"TokenPayPrivateKey\")\npm.collectionVariables.set(\"AuthorizationTokenPay\", \"TokenPay \" + btoa(authorizationTokenPay));\n\n

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"54d86686-aa74-4b22-8ad3-e41eea897c21","id":"54d86686-aa74-4b22-8ad3-e41eea897c21","name":"TokenPay.js","type":"folder"}},"urlObject":{"path":["Transaction.API","api","PaymentMethod","verify"],"host":["https://www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"0f86799f-f4ed-462a-bd9c-b7a3fed06171","name":"TokenPay Card Verification","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"accountHolder\": {\r\n \"name\": \"Test\",\r\n \"street\": \"8320 Fun Rd\",\r\n \"zip\": \"55555\"\r\n },\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"holderType\": \"P\",\r\n \"transIndustryType\": \"RE\",\r\n \"accountType\": \"R\",\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/PaymentMethod/verify"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"cardBIN\": \"41111111\",\n \"cardClass\": \"Visa\",\n \"cardIdentifier\": \"Credit\",\n \"transactionType\": \"AccountVerification\",\n \"responseType\": \"Good\",\n \"token\": \"1000000010261111\",\n \"expirationDate\": \"0225\",\n \"referenceNumber\": \"70077204\",\n \"gatewayResult\": \"00000\",\n \"gatewayMessage\": \"A01 - Approved (CARD OK)\",\n \"transactionDate\": \"20230605\",\n \"avsResult\": \"4E\",\n \"avsMessage\": \"Street address and 5-digit ZIP match\",\n \"cvResult\": \"N\",\n \"cvMessage\": \"Not matches\",\n \"organizationId\": \"13808\",\n \"networkMerchantId\": \"1939001\",\n \"networkTerminalId\": \"10001\",\n \"transactionID\": \"transactionID123\",\n \"requestType\": \"015\",\n \"responseCode\": \"00000\",\n \"responseDescription\": \"Successful Request\"\n}"}],"_postman_id":"06530bff-e1b0-4455-a7d9-7830074d22d0"},{"name":"TokenPay PaymentMethodToken","event":[{"listen":"prerequest","script":{"id":"84a35f0c-aa87-4d68-bff9-b1403aa46836","exec":["var authorizationTokenPay = pm.collectionVariables.get(\"AuthenticationTokenId\") + \":\" + pm.collectionVariables.get(\"TokenPayPrivateKey\")\r","pm.collectionVariables.set(\"AuthorizationTokenPay\", \"TokenPay \" + btoa(authorizationTokenPay));"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"a97b253d-c1da-4530-81b0-5eb03c1f5dc4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"TokenPay ZjUwMjFkZGYtYWZlMS00ZGI2LTk2MWMtYTY1MTg1ZTc5ZDEzOlR0WE5NWVpVWFJTWldmdzQ=","type":"text"}],"body":{"mode":"raw","raw":"{\"transactionID\": \"transactionID123\"}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/PaymentMethodToken","description":"

The following request shows how to create a multi-use token using TokenPay.js dataI. This request is used to tokenize card information without processing an authorization.

See the Authentication section above for a description of how the Authorization Header is built. In Javascript, using PostMan collection variables, the pre-request script will look like this:

var authorizationTokenPay = pm.collectionVariables.get(\"AuthenticationTokenId\") + \":\" + pm.collectionVariables.get(\"TokenPayPrivateKey\")\npm.collectionVariables.set(\"AuthorizationTokenPay\", \"TokenPay \" + btoa(authorizationTokenPay));\n\n

Overview

User TokenPay.js to securely collect card information and execute transactions in a PCI compliant manner.

The base integration solutions for TokenPay.js include:

Transaction API – a web services API for payment processing. The use of Transaction API (without TokenPay.js) for payment capture places 100% of PCI Compliance responsibility on the Customer’s integration.
\n
TokenPay.js – is an extension of the Transaction API that combines client-side and server-side technologies for PCI-compliant online payment capture.
\n

TokenPay.js maximizes the user experience by allowing for the capture of sensitive card data within the payment form on the merchant’s website. The consumer remains on the merchant’s payment page at all times. The payment ‘token’ is only valid for use within 15 minutes of being generated or until used for the Transaction API transaction.

TokenPay.js is an integration interface for the Payment Gateway that primarily facilitates online card payments in a manner that ensures that no sensitive card data ever needs to reach your servers so your integration can operate in a PCI compliant way.

To ensure that merchants are eligible for the simplest PCI validation method, Self-Assessment Questionnaire (SAQ A)*, TokenPay.js utilizes:

Isolation – Payment Gateway hosts the card sensitive data input fields. The fields are injected into your form as an HTML iframe thus isolating your page and your server from card sensitive data.
\n
Tokenization – in order to execute transactions against the user’s card, TokenPay.js tokenizes the card sensitive data. The card token is generated via the use of the TokenPay.js JavaScript library and your payment form.
\n
Segregation - Requests for charges against the user's card are made server-to-server not in the browser where it is publicly visible. The tokenized card data is submitted to your server where a secure server-to-server request is made to execute the transaction.
\n
Public/Private Keys – The injection of the TokenPay.js hosted input fields and card tokenization is authenticated via a public key assigned to the merchant. API requests to execute charges against the tokenized card information are made by the backend server and are authenticated with a private key assigned to the merchant.
\n
If you are processing more than six million transactions per year, you are not eligible to use a SAQ to prove PCI compliance. Payment brands require you to complete a Report on Compliance (RoC) to validate your PCI compliance annually.
\n

Authentication

TokenPay.js transactions will not use Basic Authorization like other transaction types in the BridgePay Transaction API. To authenticate a TokenPay.js transaction, Basic Authorization must be disabled and an Authorization header must be included.

The Authorization header value is a combination of a static text value (TokenPay) and a base64 encoded combination of the AuthenticationTokenID and the TokenPay.js PrivateKey separated by a colon (:). Examples of how this is achieved are provided in this collection, and the process for compiling is exemplified in the pre-request script for these examples.

Below is an example of the raw and Base64 encoded values:

RAW: TokenPay f5021ddf-afe1-4db6-961c-a65185e79d13:TtXNMYZUXRSZWfw4
Base64: TokenPay ZjUwMjFkZGYtYWZlMS00ZGI2LTk2MWMtYTY1MTg1ZTc5ZDEzOlR0WE5NWVpVWFJTWldmdzQ=

Client Side

TokenPay.js is the JavaScript library for building payment flows within the Payment Gateway. With it you can collect card sensitive data from the user and create payment tokens for securely sending the data to your server in a PCI compliant manner.

TokenPay.js provides a ready-made UI component for collecting the card sensitive data from the user. TokenPay.js then tokenizes the information without ever having to touch your server.

The TokenPay.js UI component includes:

Automatically format card information as it is entered
\n
Validation of card information as it is entered
\n
Responsive design that works on user’s screen or mobile device
\n
Customizable styling to match your look and feel
\n

Payment Form Submission Best Practices

When implementing payment forms, it is recommended that the integrator utilize reCAPTCHA. reCAPTCHA protects payment forms from SPAM and bot abuse. Using reCAPTCHA on your payment forms reduces the risk of fraudulent transactions on the merchant's eCommerce sites by performing a Completely Automated Public Turing Test to Tell Computers and Humans Apart (CAPTCHA) test to tell humans and bots apart.

For more information on reducing form SPAM and bot abuse visit:
https://developers.google.com/recaptcha/intro

Public and Private Keys

When a Payment Gateway Merchant using the Transaction API wants to utilize TokenPay.js for online transactions, a public/private key pair is assigned to the merchant for use with TokenPay.js. The public/private key is tied to a merchant account and merchant account code combination.

The public key is utilized by the TokenPay.js JavaScript library on your payment web page and is publicly visible, but this key only allows for the injection of the Payment Gateway hosted input fields. This key cannot be used to execute transactions against the user’s card.

The private key MUST be secured and never shared. The combination of the TokenPay.js generated card payment token and private key allows for charges to be made against the associated user’s card.

HTTP Requirements

All submission of payment information using TokenPay.js is made via a secure HTTPS connection. To protect yourself from man-in-the-middle attacks and to prevent your users from experiencing mixed content warnings in their browser, you MUST serve the page with your payment form over HTTPS.

The URL of the page containing TokenPay.js MUST begin with https://.

TEST URL:

https://{{BaseURL}}/WebSecurity/TokenPay/plain-js/tokenPay.js

PRODUCTION URL:

https://{{BASE_PROD_URL}}/WebSecurity/TokenPay/plain-js/tokenPay.js

Step 1: Setting Up TokenPay.js

To get started, include this script on your page (sample code is using the Test URL):

<html lang=\"en\">\n<head>\n<title>Test React</title>\n<script type=\"text/javascript\" src=\"https://www.bridgepaynetsecuretest.com/WebSecurity/TokenPay/plain-js/tokenPay.js\"></script>;\n<link rel=\"stylesheet\" href=\"https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css\" integrity=\"sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u\" crossorigin=\"anonymous\">\n    <style>\n        #amount {\n            width: 75px;\n        }\n        #card {\n            background: #ffffffa3;\n            height: 100px;\n            padding: 10px 12px;\n            border-radius: 5px;\n            border: 1px solid #84a6ae;\n            box-sizing: border-box;\n            line-height: 0;\n            margin: 9px 0px;\n            width: 500px;\n        }\n    </style>\n    <style id=\"customStyles\">\n        .input-style {\n            color: #32a866;\n        }\n        .input-hint {\n            color: #5e95a1;\n            border-color: #9ac0c8;\n        }\n        /* All fields in form */\n        .form-wrapper {\n            width: 400px;\n        }\n        /* Credit Card Number */\n        .input-wrapper {\n            width: 200px;\n        }\n        /* Expiry Date */\n        .sub-wrapper {\n            width: 100px;\n        }\n        .valid-class {\n            color: #217195;\n        }\n        .invalid-class {\n            color: #b05826;\n        }\n    </style>\n</head>\n\n

Step 2: Create Your Payment Form

To securely collect card sensitive details from your users, TokenPay.js creates UI components for you that are hosted by BridgePay. They are then inserted into your payment form.

To determine where to insert the UI components, create empty DOM elements with unique IDs within your payment form.

If you want to modify and customize the style of the card entry area, create a hidden

element to contain your styling. The id of this element MUST be 'customStyles'.

NOTE: The POST method to the ...echo.aspx URL is for testing purposes only and should not be used in production. Remove this POST from your page's implementation.

<body>\n<form id=\"paymentForm\" action=\"https://www.bridgepaynetsecuretest.com/WebSecurity/echo.aspx\" method=\"post\" style=\"margin: 10px;\">\n    <select class=\"form-control\" name=\"amount\" id=\"amount\" style=\"width: 100px;\">\n        <option value=\"25\">$25</option>\n        <option value=\"50\">$50</option>\n    </select>\n    <div class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; id=\"card\" style=\"border: solid 1px lightgray; height: 100px; width: 500px; padding: 20px 10px; border-radius: 10px; margin: 10px 0px;\"></div>\n    <div class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; id=\"errorMessage\" style=\"margin-bottom: 10px; color: #c0392b;\"></div>\n    <button type=\"submit\" class=\"btn btn-default\">Submit</button>\n</form>\n\n

When the form is loaded, initialize the Pay element:

Replace the phrase your-public-key, shown below, with your publishable public key tied to your merchant account and merchant account codes. To display ACH instead of credit card fields set useACH to true - useACH: true. To disable zip code field (prevent zip code field from displaying) set disableZip to true - disableZip: true. To disable CVV field (prevent CVV field from displaying) set disableCVV to true - disableCVV: true.

<script>\n    var tokenpay = TokenPay('tokenpay2572api202034114652681');\n    tokenpay.initialize({\n        dataElement: 'card',\n        errorElement: 'errorMessage',\n        amountElement: 'amount',\n        useACH: false,\n        //if displaying all 4 fields then useStyles=false, disableZip=false, disableCvv=false\n        //if displaying 3 out of 4 fields then useStyles=false, and set disableZip or disableCvv equal to true\n        //if displaying 2 out of 4 fields then useStyles=true, disableZip=true, disableCvv=true\n        useStyles: false,\n        disableZip: false,            \n        disableCvv: false   \n    });\n\n

The TokenPay element simplifies the form and minimizes the fields required by inserting a single input field that securely collects all needed card data.

If you have created the customStyles element to style the card entry area, change the value of 'useStyles' to true.

Step 3: Submit the Token

The card data collected by the TokenPay element returns a payment token to be used with the private key for the transaction request to the Transaction API. If there are any errors in the collection of the card data or creation of the payment token, information is automatically displayed in the 'errorElement' of your payment form.

   var form = document.getElementById('paymentForm');\n    form.addEventListener('submit', function(event) {\n        event.preventDefault();\n        tokenpay.createToken(function (result) {\n            var hiddenInput = document.createElement('input');\n            hiddenInput.setAttribute('type', 'hidden');\n            hiddenInput.setAttribute('name', 'token');\n            hiddenInput.setAttribute('value', result.token);\n            form.appendChild(hiddenInput);\n            form.submit();\n        }, function (result) {\n            console.log(\"error: \" + result);\n        });\n    });\n</script>\n</body>\n</html>\n<html><head><META HTTP-EQUIV=\"Content-Type\" CONTENT=\"text/html; charset=utf-8\"><meta name=\"Robots\" content=\"NOINDEX \" /></head><body></body>\n                <script type=\"text/javascript\">\n                 var gearPage = document.getElementById('GearPage');\n                 if(null != gearPage)\n                 {\n                     gearPage.parentNode.removeChild(gearPage);\n                     document.title = \"Error\";\n                 }\n                 </script>\n                 </html><html><head><META HTTP-EQUIV=\"Content-Type\" CONTENT=\"text/html; charset=utf-8\"><meta name=\"Robots\" content=\"NOINDEX \" /></head><body></body>\n                <script type=\"text/javascript\">\n                 var gearPage = document.getElementById('GearPage');\n                 if(null != gearPage)\n                 {\n                     gearPage.parentNode.removeChild(gearPage);\n                     document.title = \"Error\";\n                 }\n                 </script>\n                 </html>\n\n

Server Side

Please refer to the URLs at the beginning of this documentation for transaction endpoints.

Once you have securely collected and tokenized your user’s card payment data using TokenPay.js, you will have a 15 minute window in which to complete the transaction request. The payment token expires after the 15 minute window or when used.

To complete the transaction, you must perform a sale, validation or multi-use token request in a call to the Transaction API.

ZIP Codes

Because integrators can use TokenPay.js fields to capture the cardholder ZIP, it is possible to collect the ZIP both via the fields and via the integrator's checkout page. If ZIP is sent in both Token and in the Transaction API Payload, the ZIP from TokenPay.js takes priority.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"7f5bb2fd-2d2d-4e23-9275-cecc697bce54","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f3df4eca-8f3c-44ab-9d4f-18827c9a5dc1","type":"text/javascript","exec":[""]}}],"_postman_id":"54d86686-aa74-4b22-8ad3-e41eea897c21"},{"name":"Functions","item":[{"name":"Account Verification","item":[{"name":"Card Verification Credit/Debit","id":"c56429e0-8a02-4926-a310-b03da28a6be3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"paymentAccountNumber\": \"4111111111111111\",\r\n \"expirationDate\": \"1235\",\r\n \"securityCode\": \"111\",\r\n \"accountHolder\": {\r\n \"name\": \"Test\",\r\n \"street\": \"8320 Street Road\",\r\n \"city\": \"city\",\r\n \"state\": \"FL\",\r\n \"zip\": \"55555\",\r\n \"countryCode\": \"US\",\r\n \"phone\": \"1231231234\",\r\n \"email\": \"a@a.aa\"\r\n },\r\n \"holderType\": \"P\",\r\n \"transIndustryType\": \"RE\",\r\n \"accountType\": \"R\",\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/PaymentMethod/verify","description":"

The following request shows how to process a Card Verification transaction using the Transaction API. This request is used to validate card information without processing an authorization.

The following section outlines how to process an Account Verification transaction using the Transaction API.

Required	Data Element	Data Type	Description
O	accountHolder	object	The accountHolder object contains information related to the account holder. See the following table for the data elements in this object.
R	merchantAccountCode	string
	paymentAccountNumber	string
	accountType	string
	expirationDate	string
	holderType	string
	laneCode	string
	customerAccountCode	string
	transIndustryType	string
	transactionDate	string
	track1	string
	track2	string
	originatingTechnologySource	string
	originatingSoftwareVendor	string
	voucherNumber	string
	securityCode	string
	transactionMode	string
	storedCredential	string

AccountHolder

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Data Element	Data Type	Length	Description
O	name	string	150	Name on the credit card or ACH account. Any upper or lower case letter, hyphens, and spaces are allowed.
O	street	string	128	Street associated with the account. Can contain alphanumerics, spaces, hyphens, periods and slashes.
O	city	string	50	City associated with the account. Can contain alphanumerics, spaces, hyphens, periods and slashes.
O	state	string	2	State associated with the account. Can contain alphanumerics, spaces, hyphens, periods and slashes.
O	zip	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	countryCode	string	2	Country code associated with the account. Can contain alphanumerics, spaces, hyphens, periods and slashes.
O	phone	string	20	Billing phone number. Numerics only. No special characters allowed.
O	email	string	60	Email address associated with the account. Can contain alphanumerics, spaces, hyphens, periods and slashes.

","event":[{"listen":"prerequest","script":{"id":"9ea437b0-da13-430d-9095-4c7d1b2e3f3e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"dcaa5ba9-96ba-482a-9508-a336a5561632","type":"text/javascript","exec":[""]}}],"_postman_id":"c0f7412f-251f-4a86-b7b7-a41249d3feaa","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"BIN Lookup","item":[{"name":"Bin Lookup","id":"0bf65dce-7ef3-42bc-b820-b1dc9cbcfc3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/BinLookup/411111","description":"

The BIN Lookup is performed on the BIN provided at the end of the GET URL as seen in this example.

The BIN Lookup request will return information about the BIN provided in the inquiry. The BIN Lookup allows for 6, 8, and 11 digit BIN ranges and will return an indicator of credit or debit.

If we do not have data on the BIN provided in this request, the system defaults to credit.

\n","event":[{"listen":"prerequest","script":{"id":"09a3f9c8-c795-443a-ada8-3787c503f9ff","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4d222aa5-7aca-434c-b0b0-d334a2da40f2","type":"text/javascript","exec":[""]}}],"_postman_id":"f17c158d-4a2b-4b5b-a3ed-29d428c27ceb","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Capture","item":[{"name":"Capture Authorization","id":"729b484c-f589-4135-8740-f6d9aab88ef8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionID\": \"transactionID123\",\r\n \"amount\": 1234,\r\n \"merchantAccountCode\": \"#####\",\r\n \"referenceNumber\": \"gatewayTransID from original authorization\",\r\n \"Memo\": \"Capture Auth\",\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction/capture","description":"

The following section outlines how to process a Capture transaction using the Transaction API.

\n","event":[{"listen":"prerequest","script":{"id":"421347dc-3d08-419b-a6d7-8848f1cbf7b7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7d9a2d1f-b32e-4a93-92df-d96e3f5457ad","type":"text/javascript","exec":[""]}}],"_postman_id":"3704e6ba-e064-47f5-ab99-1d5641a1d640","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Find Transaction","item":[{"name":"Find Transaction (gatewayTransID)","id":"4f6086b2-3700-4adb-992a-e3fafa57bcd0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction/{gatewayTransID}?merchantAccountCode=#####","description":"

The following request shows how to process a Find Transaction request using the Transaction API. This request will return information related to the transaction referenced in the request.

The {invoiceNumber} value in the GET URL should be replaced with the invoiceNumber of the transaction you wish to query.

Note that all parameters are optional, however, if no parameters are provided, or if the results of the query return more than one row, the Transaction API will return an error indicating the need to restrict the search parameters.

The following request shows how to process a Find Transaction request using the Transaction API. This request will return information related to the transaction referenced in the request.

The {invoiceNumber} value in the GET URL should be replaced with the invoiceNumber of the transaction you wish to query.

The following request shows how to process a Find Transaction request using the Transaction API. This request will return information related to the transaction referenced in the request.

The {gatewayTransID} value in the GET URL should be replaced with the gatewayTransID of the transaction you wish to query.

The following request shows how to process a Find Transaction request using the Transaction API. This request will return information related to the transaction referenced in the request.

The {gatewayTransID} value in the GET URL should be replaced with the gatewayTransID of the transaction you wish to query.

The following request shows how to process a Find Transaction request using the Transaction API. This request will return information related to the transaction referenced in the request.

The {gatewayTransID} value in the GET URL should be replaced with the gatewayTransID of the transaction you wish to query.

The following section outlines how to submit a Find Transaction request using the Transaction API.

This allows a user to pull transaction details by providing an invoiceNumber, gatewayTransId, or purchaseToken.

When interpreting the Find Transaction response:

If you receive a non-zero responseCode, you can interpret that value as defined in the BridgePay response code table.
\n
If you receive a responseCode of 00000, review the transactionType for further detail:
\n
- transactionType = Sale
  \n
  - The transaction is an approved Sale
  \n
- transactionType = Refund
  \n
  - The transaction is an approved Refund
  \n
- transactionType = Void
  \n
  - The transaction is a successfully voided transaction
  \n
- transactionType = Decline
  \n
  - The transaction is a declined transaction
  \n
\n

\n","event":[{"listen":"prerequest","script":{"id":"9ad1a97a-aff3-44a3-96b7-e390d5f9ae3e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f4421604-3c4b-4b15-9d68-451db96d1bb5","type":"text/javascript","exec":[""]}}],"_postman_id":"7bb1ed03-9d34-4375-a3e1-708e4ccb8240","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Get Fee Amount","item":[{"name":"Get Fee Amount","id":"2707752f-fdd6-4b4a-b591-4707c75f1b17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionID\": \"transactionID123\",\r\n \"amount\": 50000,\r\n \"merchantAccountCode\": \"14243001\",\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/transaction.api/api/transaction/calculatefee","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}},"urlObject":{"path":["transaction.api","api","transaction","calculatefee"],"host":["https://www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"d30b31a5-862b-4cdd-b826-15e20f34de36","name":"Get Fee Amount","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionID\": \"transactionID123\",\r\n \"amount\": 50000,\r\n \"merchantAccountCode\": \"14243001\",\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/transaction.api/api/transaction/calculatefee"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"transactionID\": \"f74efef7-1545-4270-905d-7c5cfbf9c5f2_20240614T201744\",\n \"transactionID\": \"transactionID123\",\n \"requestType\": \"026\",\n \"responseCode\": \"00000\",\n \"responseDescription\": \"Successful Request\",\n \"feeAmount\": 5012,\n \"feeType\": \"Service\"\n}"}],"_postman_id":"2707752f-fdd6-4b4a-b591-4707c75f1b17"}],"id":"920e1d5a-d39d-40c3-b47c-e3c384edcff6","description":"

This request method is used to calculate a FeeAmount value based on the configured fee percentage in MyBridgePay's Gateway Configuration tab in Account Management.

\n","_postman_id":"920e1d5a-d39d-40c3-b47c-e3c384edcff6","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Get Merchant Info","item":[{"name":"Get Merchant Information","id":"c001a5ca-5c06-430c-814a-9c3f3d7a3795","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/MerchantInfo","description":"

The GET MerchantInfo request will return the Merchant Account Information related to the credentials used for authorization.

The following section outlines the GET Merchant Information functionality of the Transaction API. It is used to return merchant information related to the authorization credentials.

\n","event":[{"listen":"prerequest","script":{"id":"fef75a1a-1cf5-4d78-b1e1-4a56febeaf80","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"36231f58-4b4b-4361-b02c-682ebe93ee61","type":"text/javascript","exec":[""]}}],"_postman_id":"ea98798f-cdf4-4e66-83ad-b3588ad02178","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Multi-Use Card Token","item":[{"name":"Tokenize Credit Card","id":"3ed0c052-4352-4af7-be44-70d2cc9fbbfb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionID\": \"transactionID123\",\r\n \"paymentAccountNumber\": \"4111111111111111\",\r\n \"expirationDate\": \"1235\",\r\n \"securityCode\": \"111\",\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/PaymentMethodToken","description":"

The example below shows how to tokenize a credit card number using the Transaction API.

For credit card token transactions, the token must be used in conjunction with the expiration date to process a transaction, so it is recommended that the token and expiration date be stored as a token pair.

The example below shows how to tokenize a credit card number using the Transaction API.

The following example shows how to tokenize an ACH account number using the Transaction API.

For ACH token transactions, the token must be used in conjunction with the routing number to process a transaction, so it is recommended that the token and routing number be stored as a token pair.

The following section outlines how to use the Multi-Use Card Token request to tokenize a Credit Card or ACH account number. The generated token can be stored for future transaction processing.

\n","event":[{"listen":"prerequest","script":{"id":"efcf617c-1bda-442c-8bdf-71db3030b6f0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9a21b8c4-e863-4993-abf2-7a8b1d1398b3","type":"text/javascript","exec":[""]}}],"_postman_id":"c2c0f24a-8b63-4619-a434-3aa1c6b7ee76","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Settlement","item":[{"name":"Settlement","id":"272cc1eb-b4cf-4ea6-b74c-e9d430cc4b67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionID\": \"transactionID123\",\r\n \"merchantAccountCode\": \"#####\",\r\n \"Memo\": \"Settle Batch\",\r\n \"originatingSoftwareVendor\": \"Name of vendor that developed the software used in transmitting the transaction\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/Transaction.API/api/batch/close","description":"

The following request shows how to process a Settlement using the Transaction API. This request will trigger the BridgePay gateway to settle the current batch. All unsettled transactions will be submitted to the processors for settlement.

The following section outlines how to process a manual Settlement using the Transaction API.

Settlement can also be automated via the virtual terminal. This is only required if settlement is intended to be triggered by the integrated solution.

\n","event":[{"listen":"prerequest","script":{"id":"af06169b-a905-4a58-8c69-4d5d58846942","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8c5fa1c0-26c6-4906-bef9-cd99703ead06","type":"text/javascript","exec":[""]}}],"_postman_id":"6768645f-1c03-4297-afd0-8a0b53c1edcd","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}}],"id":"ce245c41-5fa0-443a-a1e8-13f768acfe5e","description":"

The following section outlines the various non-transaction functions provided by the gateway.

\n","_postman_id":"ce245c41-5fa0-443a-a1e8-13f768acfe5e","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}}],"id":"2a7b3fd2-ac09-4be1-ab70-f76a9034fe74","description":"

The following section will outline each unique request type and its corresponding response.

\n","event":[{"listen":"prerequest","script":{"id":"e691691e-d46d-41da-96e9-bb3c3584fd65","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8d442f2b-ebd1-4908-82eb-a269039838a0","type":"text/javascript","exec":[""]}}],"_postman_id":"2a7b3fd2-ac09-4be1-ab70-f76a9034fe74","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]},"isInherited":true,"source":{"_postman_id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","id":"06b1da33-f0f1-4150-a70d-636b6ae9cff4","name":"Transaction API Development Guide","type":"collection"}}},{"name":"Appendix","item":[],"id":"33441c1d-59e7-4895-a70d-628432c2ebbc","description":"

Test Credit Card Numbers

Test Dollar Amount Ranges

AVS and CVV Information

Handling of CVV and AVS responses

Certification Script

BridgePay Gateway Certification Script

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Legend
R = Required
O = Optional
C = Conditional
1 = Required if not sending Track Data
3 = ACH/Checks

Document Version:

Version:	Updated by:	Change(s):	Date:
1.32	Noah Hippensteel	Added Unreferenced Refund example for Lodging	02/10/2026
1.31	Noah Hippensteel	Added detail to how the BIN Lookup function works when the BIN data is not present in our reference table.	02/04/2026
1.30	Noah Hippensteel	Added transactionId to all transaction examples	01/13/2026
1.29	Noah Hippensteel	Added clarity to settlementDelay section regarding its interaction with duration data element in Lodging. Added clarity to cardModifer regarding FSA/HSA cards. Added clarity to Card on File transactions regarding raw card data and tokens. Added clarity to holderType in relation to Level III transactions. Added clarity to Lodging regarding the relationship between roomTaxAmount and roomRateAmount.	01/06/2026
1.28	Noah Hippensteel	Added transactionID to voidrefund requests examples and data element table.	12/30/2025
1.27	Noah Hippensteel	Added clarity to settlementDelay data element. Added SettlementDelay to Lodging transaction examples.	12/18/2025
1.26	Noah Hippensteel	Added additional information regarding the proxy processor and partial refunds/voids	12/16/2025
1.25	Noah Hippensteel	Added clarity to settlementDelay data element regarding its lack of association with MyBridgePay's \"Default Action Delay\" setting.	11/14/2025
1.24	Noah Hippensteel	Updated accountPhone field to reflect accurate length requirements (10-11 characters)	11/06/2025
1.23	Mark Mauer	Updated all sample request address information to match the proxy gateway's AVS test settings. Now all sample transactions to the proxy gateway will return valid successful AVS information in the responses. Updated all sample responses accordingly.	09/15/2025
1.22	Noah Hippensteel	Updated Find Transaction section with additional detail for interpreting response data.	08/21/2025
1.21	Mark Mauer	Updated incorrect formatting on Car Rental data in example requests.	07/22/2025
1.20	Mark Mauer	Updated Loadging Data camel-case issue on the \"departureAdjustmentAmount\" field	07/08/2025
1.19	Mark Mauer	Added both required fields of originatingTechnologySource and originatingSoftwareVendor to all request examples.	06/30/2025
1.18	Noah Hippensteel	Updated for FE 24.10 release.	04/02/2025
1.17	Mark Mauer	Added \"transactionMode\": \"P\" to all Sale, Sale-Auth, Void, Refund, Capture, Adjust request examples in the Card Present section. Added \"transactionMode\": \"N\" to all Sale, Sale-Auth, Void, Refund, Capture, Adjust request examples in the Card Not Present section.	02/20/2025
1.16	Mark Mauer	Updated all Void and Refund (Referenced) payload URLs. The new UAT URL is https://www.bridgepaynetsecuretest.com/Transaction.API/api/transaction/voidrefund The Unreferenced refund URL has not changed.	02/06/2025
1.15	Noah Hippensteel	Updated Lodging documentation to require FolioNumber for all Lodging transactions.	01/31/2025
1.14	Mark Mauer	Added Surcharge to both Card Present and Card Not Present payload examples.	01/13/2025
1.13	Mark Mauer	Updated the Find Transaction requests. Supported search types are gatewayTransID, Invoice Number, Transaction Code and Purchase Token. Transaction Code is the field passed on a transaction called transactionId. It is not the gatewayTransId of the transaction being searched for.	12/03/2024
1.12	Noah Hippensteel	Added Timeout information to Key Elements section.	10/29/2024
1.11	Noah Hippensteel	FE 24.5 Updates. See release notes for details.	10/11/2024
1.10	Noah Hippensteel	Added additional detail to EMV section in Card Present documentation around using track1 or track2 data.	10/11/2024
1.9	Noah Hippensteel	Updated Find Transaction example responses to include the \"[]\" characters indicating the response is an array with one entry in the list.	09/30/2024
1.8	Mark Mauer	Added Get Fee Amount request. Updated ACH responses to iunclude the returned routing number field. Updated Find Transaction calls with the new request types of Invoice#, gatewayTransID and purchaseToken. There are now more options for finding transactions.	06/17/2024
1.7	Mark Mauer	Updated Zip/Postal Code field description.	05/03/2024
1.6	Mark Mauer	Added additional details to the description of the amount, feeAmount and tipAmount fields.	03/28/2024
1.5	Mark Mauer Noah Hippensteel	Added Card Present transactions. Added Bar Tab transactions. Added Increment. Added Tip Adjustment. Added TokenPay transaction support. Adjusted Car Rental and Lodging transaction scenarios.	06/29/2023
1.4	Noah Hippensteel	Reworked Void and Refund examples to not use the \"payment\" object.	04/25/2023
1.3	Mark Mauer	Added Custom Field Sample.	2/24/2023
1.2	Mark Mauer	Added additional Account Verification Samples.	1/26/2023
1.1	Mark Mauer	Added Tip Calls	01/18/2023
1.0	Mark Mauer Noah Hippensteel	Initial creation of the API documentation.	11/18/2022

","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"1e5d812c-1c94-4d38-aa9f-20133aaad1dc"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"18ab1d26-efb0-4138-982c-807f5abf855b"}}],"_postman_id":"33441c1d-59e7-4895-a70d-628432c2ebbc"}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"#####"},{"key":"password","value":"#####"}]}},"event":[{"listen":"prerequest","script":{"id":"0989d965-8b4a-4d90-b8dd-617dbd688b10","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ea2f64c2-6920-44d2-9573-8b29f7d1855c","type":"text/javascript","exec":[""]}}],"variable":[{"key":"merchantCode","value":"#####","type":"string"},{"key":"merchantAccountCode","value":"#####","type":"string"},{"key":"username","value":"#####","type":"string"},{"key":"password","value":"#####","type":"string"},{"key":"baseUrl","value":"https://www.bridgepaynetsecuretest.com","type":"string"},{"key":"paymentAccountNumber","value":"4111111111111111","type":"string"},{"key":"expirationDate","value":"1235","type":"string"},{"key":"securityCode","value":"111","type":"string"},{"key":"bankAccountNumber","value":"40999992","type":"string"},{"key":"routingNumber","value":"021000021","type":"string"},{"key":"testBin","value":"411111","type":"string"},{"key":"giftCardAccount","value":"################","type":"string"},{"key":"transactionCode","value":"{transactionCode}","type":"string"},{"key":"gatewayTransID","value":"{gatewayTransID}","type":"string"},{"key":"invoiceNumber","value":"{invoiceNumber}","type":"string"},{"key":"purchaseToken","value":"{purchaseToken}","type":"string"},{"key":"serviceMerchantAccountCode","value":"#####","type":"string"},{"key":"serviceUser","value":"#####","type":"string"},{"key":"servicePassword","value":"#####","type":"string"},{"key":"token","value":"1000000044935454","type":"string"},{"key":"AuthorizationTokenPay","value":"TokenPay ZjUwMjFkZGYtYWZlMS00ZGI2LTk2MWMtYTY1MTg1ZTc5ZDEzOlR0WE5NWVpVWFJTWldmdzQ=","type":"string"},{"key":"TokenPayPrivateKey","value":"","type":"string"},{"key":"AuthenticationTokenId","value":"","type":"string"},{"key":"pushPaymentToken","value":"","type":"string"},{"key":"pushPaymentAccountNumber","value":"","type":"string"}]}