SOAP XML BridgeComm API
Introduction
The SOAP BridgeCommAPI Developer Documentation:
BridgeCommAPI Development Guide
The BridgeComm Direct Post API provides an Internet-facing web services interface for requesting a variety of payment related services in real-time. The interface is a Windows Communication Foundation (WCF) web service using the request/response architecture.
All requests to BridgeComm must be base64 encoded XML formatted request messages and will return base64 encoded XML formatted responses.
Note that not every request type requires the same information/fields. Be sure to review the documentation for each request you intend to use to ensure that you are sending only the required and relevant optional fields for that request.
SDK
Test URL
Set url in
BridgeCommConnection.processRequest(url, bcRequest)to URL:
https://www.bridgepaynetsecuretest.com/paymentservice/requesthandler.svcProduction URL
Set url in
BridgeCommConnection.processRequest(url, bcRequest)to URL:
https://www.bridgepaynetsecuretx.com/PaymentService/RequestHandler.svcC#
BridgeComm Request Object
The request object is an object containing all possible fields of a payment request or a special system function request.
BridgeCommRequest bcRequest = new BridgeCommRequest();
bcRequest.User = "The merchant username.";
bcRequest.Password = "The merchant password.";
bcRequest.RequestType = "The type of this request message.";
bcRequest.TransactionID = "A unique value that identifies the transaction.";
bcRequest.RequestDateTime = "The date and time the request was sent.";
bcRequest.requestMessage = new RequestMessage();BridgeComm Request Message Object
The request message object is an object containing all possible fields of a payment request or a special system function request.
RequestMessage rqMessage = new RequestMessage();
rqMessage.MerchantCode = "The merchant code.";
rqMessage.MerchantAccountCode = "The merchant account code.";
rqMessage.Descriptor = "The message descriptor.";
rqMessage.PaymentType = "The payment type.";
rqMessage.TransactionType = "The transaction type.";
rqMessage.TransIndustryType = "The transaction industry type.";
rqMessage.TransactionMode = "The transaction mode.";
rqMessage.TransCatCode = "The transaction category code.";
rqMessage.Amount = "The amount.";
rqMessage.CashBackAmount = "The cashback amount.";
rqMessage.FeeAmount = "The fee amount.";
rqMessage.TipAmount = "The tip amount.";
rqMessage.TipRecipientCode = "The tip recipient code.";
rqMessage.PaymentAccountNumber = "The payment account number.";
rqMessage.ExpirationDate = "The card expiration date.";
rqMessage.SecurityCode = "The card security code.";
rqMessage.PINCode = "The card PIN code.";
rqMessage.PurchaseToken = "The purchase token.";
rqMessage.Token = "The transaction token.";
rqMessage.InvoiceNum = "The invoice number.";
rqMessage.PONum = "The PO number.";
rqMessage.Track1 = "The card track1 data.";
rqMessage.Track2 = "The card track2 data.";
rqMessage.Track3 = "The card track3 data.";
rqMessage.EncryptionID = "The ecryption id.";
rqMessage.PINBlock = "The PIN block.";
rqMessage.PINKey = "The PIN key.";
rqMessage.SwipeResult = "The swipe result.";
rqMessage.VoiceAuthCode = "The voice authorization code.";
rqMessage.PartialAuthorization = "The partial authorization code.";
rqMessage.BankAccountNum = "The bank account number.";
rqMessage.RoutingNum = "The routing number.";
rqMessage.AcctType = "The account type.";
rqMessage.AccountHolderName = "The account holder name.";
rqMessage.HolderType = "The account holder type.";
rqMessage.CustomerAccountCode = "The customer account code.";
rqMessage.VoucherNumber = "The voucher number.";
rqMessage.DeviceMake = "The device make.";
rqMessage.DeviceModel = "The device model.";
rqMessage.DeviceSerial = "The device serial.";
rqMessage.DeviceFirmware = "The device firmware.";
rqMessage.SecureFormat = "The secure format.";
rqMessage.BDKSlot = "The BDK slot.";
rqMessage.DUKPT = "The DUKPT.";
rqMessage.AppHostMachineId = "The application host id.";
rqMessage.IntegrationMethod = "The integration method.";
rqMessage.OriginatingTechnologySource = "The originating technology source.";
rqMessage.SoftwareVendor = "The software vendor.";
rqMessage.SecurityTechnology = "The security technology.";
rqMessage.WalletPaymentMethodID = "The wallet payment method id.";
rqMessage.WalletToken = "The wallet token.";
rqMessage.WalletKey = "The wallet key.";
rqMessage.CustomerWalletID = "The customer's wallet id.";BridgeComm Response Object
The request object is an object containing all possible fields of a payment request or a special system function request.
BridgeCommConnection connection = new BridgeCommConnection();
BridgeCommResponse bcResponse = connection.processRequest(URL, bcRequest);
bcResponse.BridgeCommResponseType = "";
bcResponse.RequestType = "";
bcResponse.ResponseCode = "";
bcResponse.ResponseDescription = "";
bcResponse.responseMessage = "";
bcResponse.TransactionID = "";BridgeComm Response Message Object
The request message object is an object containing all possible fields of a payment request or a special system function request.
ResponseMessage rsMessage = bcResponse.responseMessage;
rsMessage.Token = "";
rsMessage.Algorithm = "";
rsMessage.CreateDate = "";
rsMessage.ID = "";
rsMessage.KeySize = "";
rsMessage.PublicKey = "";
rsMessage.AuthorizationCode = "";
rsMessage.ReferenceNumber = "";
rsMessage.GatewayResult = "";
rsMessage.AuthorizedAmount = "";
rsMessage.OriginalAmount = "";
rsMessage.ExpirationDate = "";
rsMessage.AVSResult = "";
rsMessage.AVSMessage = "";
rsMessage.StreetMatchMessage = "";
rsMessage.ZipMatchMessage = "";
rsMessage.CVResult = "";
rsMessage.CVMessage = "";
rsMessage.IsCommercialCard = "";
rsMessage.GatewayTransID = "";
rsMessage.GatewayMessage = "";
rsMessage.InternalMessage = "";
rsMessage.Balance = "";
rsMessage.CashBackAmount = "";
rsMessage.TransactionCode = "";
rsMessage.TransactionDate = "";
rsMessage.CardClass = "";
rsMessage.CardType = "";
rsMessage.CardModifier = "";
rsMessage.CardHolderName = "";
rsMessage.ProviderResponseCode = "";
rsMessage.ProviderResponseMessage = "";
rsMessage.RemainingAmount = "";
rsMessage.IsoCountryCode = "";
rsMessage.IsoCurrencyCode = "";
rsMessage.IsoTransactionDate = "";
rsMessage.IsoRequestDate = "";
rsMessage.NetworkReferenceNumber = "";
rsMessage.NetworkMerchantId = "";
rsMessage.NetworkTerminalId = "";
rsMessage.MaskedPan = "";
rsMessage.WalletID = "";
rsMessage.WalletPaymentMethodID = "";
rsMessage.WalletResponseMessage = "";
rsMessage.WalletResponseCode = "";
rsMessage.ResponseTypeDescription = "";
rsMessage.MerchantCategoryCode = "";
rsMessage.ReceiptTagData = "";
rsMessage.IssuerTagData = "";
rsMessage.CardIdentifier = "";
rsMessage.SecondsRemaining = "";
rsMessage.MerchantCode = "";
rsMessage.MerchantAccountCode = "";
rsMessage.MerchantName = "";
rsMessage.GatewayResults = "";
rsMessage.ResponseType = "";
rsMessage.TransactionType = "";
rsMessage.AuthrorizationCode = "";
rsMessage.ProviderAVSCode = "";
rsMessage.ProviderCVCode = "";
rsMessage.ProviderReferenceNumber = "";
rsMessage.CycleCode = "";
rsMessage.RoutingNumber = "";
rsMessage.PurchaseToken = "";
rsMessage.ApprovalCode = "";
rsMessage.CSCResponseCode = "";
rsMessage.GatewayTransId = "";
rsMessage.HolderName = "";
rsMessage.InvoiceNum = "";
rsMessage.TransactionCategory = "";
rsMessage.Amount = "";
rsMessage.AVSResponseCode = "";
rsMessage.Email = "";
rsMessage.Holdertype = "";
rsMessage.AccountType = "";
rsMessage.City = "";
rsMessage.Memo = "";
rsMessage.Phone = "";
rsMessage.AccountNumberMasked = "";
rsMessage.CountryCode = "";
rsMessage.State = "";
rsMessage.Street = "";
rsMessage.TransactionIndustryType = "";
rsMessage.ZipCode = "";
rsMessage.PersistedData = "";
rsMessage.ResponseCode = "";
rsMessage.ResponseDescription = "";
rsMessage.BatchID = "";Java
For the JAVA SDK, add the following dependencies to your Project Object Model
<dependency>
<groupId>com.fasterxml.jackson.dataformat</groupId>
<artifactId>jackson-dataformat-xml</artifactId>
<version>2.9.8</version>
</dependency>
<dependency>
<groupId>axis</groupId>
<artifactId>axis-jaxrpc</artifactId>
<version>1.4</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
<version>3.3.2</version>
</dependency>BridgeComm Request Object
BridgeCommRequest bcRequest = new BridgeCommRequest();
bcRequest.setUser("The merchant username.");
bcRequest.setPassword("The merchant password.");
bcRequest.setRequestType("The type of this request message.");
bcRequest.setTransactionID("A unique value that identifies the transaction.");
bcRequest.setRequestDateTime("The date and time the request was sent.");
bcRequest.setRequestMessage( new RequestMessage());BridgeComm Request Message Object
RequestMessage rqMessage = new RequestMessage();
rqMessage.setMerchantCode("The merchant code.");
rqMessage.setMerchantAccountCode("The merchant account code.");
rqMessage.setDescriptor("The message descriptor.");
rqMessage.setPaymentType("The payment type.");
rqMessage.setTransactionType("The transaction type.");
rqMessage.setTransIndustryType("The transaction industry type.");
rqMessage.setTransactionMode("The transaction mode.");
rqMessage.setTransCatCode("The transaction category code.");
rqMessage.setAmount("The amount.");
rqMessage.setCashBackAmount("The cashback amount.");
rqMessage.setFeeAmount("The fee amount.");
rqMessage.setTipAmount("The tip amount.");
rqMessage.setTipRecipientCode("The tip recipient code.");
rqMessage.setPaymentAccountNumber("The payment account number.");
rqMessage.setExpirationDate("The card expiration date.");
rqMessage.setSecurityCode("The card security code.");
rqMessage.setPINCode("The card PIN code.");
rqMessage.setPurchaseToken("The purchase token.");
rqMessage.setToken("The transaction token.");
rqMessage.setInvoiceNum("The invoice number.");
rqMessage.setPONum("The PO number.");
rqMessage.setTrack1("The card track1 data.");
rqMessage.setTrack2("The card track2 data.");
rqMessage.setTrack3("The card track3 data.");
rqMessage.setEncryptionID("The ecryption id.");
rqMessage.setPINBlock("The PIN block.");
rqMessage.setPINKey("The PIN key.");
rqMessage.setSwipeResult("The swipe result.");
rqMessage.setVoiceAuthCode("The voice authorization code.");
rqMessage.setPartialAuthorization("The partial authorization code.");
rqMessage.setBankAccountNum("The bank account number.");
rqMessage.setRoutingNum("The routing number.");
rqMessage.setAcctType("The account type.");
rqMessage.setAccountHolderName("The account holder name.");
rqMessage.setHolderType("The account holder type.");
rqMessage.setCustomerAccountCode("The customer account code.");
rqMessage.setVoucherNumber("The voucher number.");
rqMessage.setDeviceMake("The device make.");
rqMessage.setDeviceModel("The device model.");
rqMessage.setDeviceSerial("The device serial.");
rqMessage.setDeviceFirmware("The device firmware.");
rqMessage.setMSRKey("The MSR key.");
rqMessage.setSecureFormat("The secure format.");
rqMessage.setBDKSlot("The BDK slot.");
rqMessage.setDUKPT("The DUKPT.");
rqMessage.setAppHostMachineId("The application host id.");
rqMessage.setIntegrationMethod("The integration method.");
rqMessage.setOriginatingTechnologySource("The originating technology source.");
rqMessage.setSoftwareVendor("The software vendor.");
rqMessage.setSecurityTechnology("The security technology.");
rqMessage.setWalletPaymentMethodID("The wallet payment method id.");
rqMessage.setWalletToken("The wallet token.");
rqMessage.setWalletKey("The wallet key.");
rqMessage.setCustomerWalletID("The customer's wallet id.");BridgeComm Response Object
BridgeCommConnection connection = new BridgeCommConnection();
BridgeCommResponse bcResponse = connection.processRequest(URL, bcRequest);
bcResponse.setBridgeCommResponseType("");
bcResponse.setRequestType("");
bcResponse.setResponseCode("");
bcResponse.setResponseDescription("");
bcResponse.setresponseMessage("");
bcResponse.setTransactionID("");BridgeComm Response Message Object
ResponseMessage rsMessage = bcResponse.getResponseMessage;
rsMessage.setToken("");
rsMessage.setAlgorithm("");
rsMessage.setCreateDate("");
rsMessage.setID("");
rsMessage.setKeySize("");
rsMessage.setPublicKey("");
rsMessage.setAuthorizationCode("");
rsMessage.setReferenceNumber("");
rsMessage.setGatewayResult("");
rsMessage.setAuthorizedAmount("");
rsMessage.setOriginalAmount("");
rsMessage.setExpirationDate("");
rsMessage.setAVSResult("");
rsMessage.setAVSMessage("");
rsMessage.setStreetMatchMessage("");
rsMessage.setZipMatchMessage("");
rsMessage.setCVResult("");
rsMessage.setCVMessage("");
rsMessage.setIsCommercialCard("");
rsMessage.setGatewayTransID("");
rsMessage.setGatewayMessage("");
rsMessage.setInternalMessage("");
rsMessage.setBalance("");
rsMessage.setCashBackAmount("");
rsMessage.setTransactionCode("");
rsMessage.setTransactionDate("");
rsMessage.setCardClass("");
rsMessage.setCardType("");
rsMessage.setCardModifier("");
rsMessage.setCardHolderName("");
rsMessage.setProviderResponseCode("");
rsMessage.setProviderResponseMessage("");
rsMessage.setRemainingAmount("");
rsMessage.setIsoCountryCode("");
rsMessage.setIsoCurrencyCode("");
rsMessage.setIsoTransactionDate("");
rsMessage.setIsoRequestDate("");
rsMessage.setNetworkReferenceNumber("");
rsMessage.setNetworkMerchantId("");
rsMessage.setNetworkTerminalId("");
rsMessage.setMaskedPan("");
rsMessage.setWalletID("");
rsMessage.setWalletPaymentMethodID("");
rsMessage.setWalletResponseMessage("");
rsMessage.setWalletResponseCode("");
rsMessage.setResponseTypeDescription("");
rsMessage.setMerchantCategoryCode("");
rsMessage.setReceiptTagData("");
rsMessage.setIssuerTagData("");
rsMessage.setCardIdentifier("");
rsMessage.setSecondsRemaining("");
rsMessage.setMerchantCode("");
rsMessage.setMerchantAccountCode("");
rsMessage.setMerchantName("");
rsMessage.setGatewayResults("");
rsMessage.setResponseType("");
rsMessage.setTransactionType("");
rsMessage.setAuthrorizationCode("");
rsMessage.setProviderAVSCode("");
rsMessage.setProviderCVCode("");
rsMessage.setProviderReferenceNumber("");
rsMessage.setCycleCode("");
rsMessage.setRoutingNumber("");
rsMessage.setPurchaseToken("");
rsMessage.setApprovalCode("");
rsMessage.setCSCResponseCode("");
rsMessage.setGatewayTransId("");
rsMessage.setHolderName("");
rsMessage.setInvoiceNum("");
rsMessage.setTransactionCategory("");
rsMessage.setAmount("");
rsMessage.setAVSResponseCode("");
rsMessage.setEmail("");
rsMessage.setHoldertype("");
rsMessage.setAccountType("");
rsMessage.setCity("");
rsMessage.setMemo("");
rsMessage.setPhone("");
rsMessage.setAccountNumberMasked("");
rsMessage.setCountryCode("");
rsMessage.setState("");
rsMessage.setStreet("");
rsMessage.setTransactionIndustryType("");
rsMessage.setZipCode("");
rsMessage.setPersistedData("");
rsMessage.setResponseCode("");
rsMessage.setResponseDescription("");
rsMessage.setBatchID("");PHP
Linked is a sample HTML form project that consumes the PHP SDK. To run the sample project, simply host the unzipped folder inside the web folder of a web server. Next, perform a request to the form.html file by typing its URL in the web browser. Running this URL will display the web form allowing you to process a transaction to our gateway.
BridgeComm Request Object
$request = new BridgeCommRequest();
$request->User = "The merchant username.";
$request->Password = "The merchant password.";
$request->RequestType = "The type of this request message.";
$request->TransactionID = "A unique value that identifies the transaction.";
$request->RequestDateTime = "The date and time the request was sent.";
$request->requestMessage = new RequestMessage();BridgeComm Request Message Object
$request = new BridgeCommRequest();
$request->requestMessage = new RequestMessage(); $request->requestMessage->MerchantCode = "The merchant code.";
$request->requestMessage->MerchantAccountCode = "The merchant account code.";
$request->requestMessage->Descriptor = "The message descriptor.";
$request->requestMessage->PaymentType = "The payment type.";
$request->requestMessage->TransactionType = "The transaction type.";
$request->requestMessage->TransIndustryType = "The transaction industry type.";
$request->requestMessage->TransactionMode = "The transaction mode.";
$request->requestMessage->TransCatCode = "The transaction category code.";
$request->requestMessage->Amount = "The amount.";
$request->requestMessage->CashBackAmount = "The cashback amount.";
$request->requestMessage->FeeAmount = "The fee amount.";
$request->requestMessage->TipAmount = "The tip amount.";
$request->requestMessage->TipRecipientCode = "The tip recipient code.";
$request->requestMessage->PaymentAccountNumber = "The payment account number.";
$request->requestMessage->ExpirationDate = "The card expiration date.";
$request->requestMessage->SecurityCode = "The card security code.";
$request->requestMessage->PINCode = "The card PIN code.";
$request->requestMessage->PurchaseToken = "The purchase token.";
$request->requestMessage->Token = "The transaction token.";
$request->requestMessage->InvoiceNum = "The invoice number.";
$request->requestMessage->PONum = "The PO number.";
$request->requestMessage->Track1 = "The card track1 data.";
$request->requestMessage->Track2 = "The card track2 data.";
$request->requestMessage->Track3 = "The card track3 data.";
$request->requestMessage->EncryptionID = "The ecryption id.";
$request->requestMessage->PINBlock = "The PIN block.";
$request->requestMessage->PINKey = "The PIN key.";
$request->requestMessage->SwipeResult = "The swipe result.";
$request->requestMessage->VoiceAuthCode = "The voice authorization code.";
$request->requestMessage->PartialAuthorization = "The partial authorization code.";
$request->requestMessage->BankAccountNum = "The bank account number.";
$request->requestMessage->RoutingNum = "The routing number.";
$request->requestMessage->AcctType = "The account type.";
$request->requestMessage->AccountHolderName = "The account holder name.";
$request->requestMessage->HolderType = "The account holder type.";
$request->requestMessage->CustomerAccountCode = "The customer account code.";
$request->requestMessage->VoucherNumber = "The voucher number.";
$request->requestMessage->DeviceMake = "The device make.";
$request->requestMessage->DeviceModel = "The device model.";
$request->requestMessage->DeviceSerial = "The device serial.";
$request->requestMessage->DeviceFirmware = "The device firmware.";
$request->requestMessage->MSRKey = "The MSR key.";
$request->requestMessage->SecureFormat = "The secure format.";
$request->requestMessage->BDKSlot = "The BDK slot.";
$request->requestMessage->DUKPT = "The DUKPT.";
$request->requestMessage->AppHostMachineId = "The application host id.";
$request->requestMessage->IntegrationMethod = "The integration method.";
$request->requestMessage->OriginatingTechnologySource = "The originating technology source.";
$request->requestMessage->SoftwareVendor = "The software vendor.";
$request->requestMessage->SecurityTechnology = "The security technology.";
$request->requestMessage->WalletPaymentMethodID = "The wallet payment method id.";
$request->requestMessage->WalletToken = "The wallet token.";
$request->requestMessage->WalletKey = "The wallet key.";
$request->requestMessage->CustomerWalletID = "The customer's wallet id.";BridgeComm Response Object
$connection = new BridgeCommConnection();
$bcResponse = $connection.processRequest(URL, $request);
$bcResponse->BridgeCommResponseType = "";
$bcResponse->RequestType = "";
$bcResponse->ResponseCode = "";
$bcResponse->ResponseDescription = "";
$bcResponse->responseMessage = "";
$bcResponse->TransactionID = "";BridgeComm Response Message Object
$rsMessage = $bcResponse->responseMessage;
$rsMessage->Token = "";
$rsMessage->Algorithm = "";
$rsMessage->CreateDate = "";
$rsMessage->ID = "";
$rsMessage->KeySize = "";
$rsMessage->PublicKey = "";
$rsMessage->AuthorizationCode = "";
$rsMessage->ReferenceNumber = "";
$rsMessage->GatewayResult = "";
$rsMessage->AuthorizedAmount = "";
$rsMessage->OriginalAmount = "";
$rsMessage->ExpirationDate = "";
$rsMessage->AVSResult = "";
$rsMessage->AVSMessage = "";
$rsMessage->StreetMatchMessage = "";
$rsMessage->ZipMatchMessage = "";
$rsMessage->CVResult = "";
$rsMessage->CVMessage = "";
$rsMessage->IsCommercialCard = "";
$rsMessage->GatewayTransID = "";
$rsMessage->GatewayMessage = "";
$rsMessage->InternalMessage = "";
$rsMessage->Balance = "";
$rsMessage->CashBackAmount = "";
$rsMessage->TransactionCode = "";
$rsMessage->TransactionDate = "";
$rsMessage->CardClass = "";
$rsMessage->CardType = "";
$rsMessage->CardModifier = "";
$rsMessage->CardHolderName = "";
$rsMessage->ProviderResponseCode = "";
$rsMessage->ProviderResponseMessage = "";
$rsMessage->RemainingAmount = "";
$rsMessage->IsoCountryCode = "";
$rsMessage->IsoCurrencyCode = "";
$rsMessage->IsoTransactionDate = "";
$rsMessage->IsoRequestDate = "";
$rsMessage->NetworkReferenceNumber = "";
$rsMessage->NetworkMerchantId = "";
$rsMessage->NetworkTerminalId = "";
$rsMessage->MaskedPan = "";
$rsMessage->WalletID = "";
$rsMessage->WalletPaymentMethodID = "";
$rsMessage->WalletResponseMessage = "";
$rsMessage->WalletResponseCode = "";
$rsMessage->ResponseTypeDescription = "";
$rsMessage->MerchantCategoryCode = "";
$rsMessage->ReceiptTagData = "";
$rsMessage->IssuerTagData = "";
$rsMessage->CardIdentifier = "";
$rsMessage->SecondsRemaining = "";
$rsMessage->MerchantCode = "";
$rsMessage->MerchantAccountCode = "";
$rsMessage->MerchantName = "";
$rsMessage->GatewayResults = "";
$rsMessage->ResponseType = "";
$rsMessage->TransactionType = "";
$rsMessage->AuthrorizationCode = "";
$rsMessage->ProviderAVSCode = "";
$rsMessage->ProviderCVCode = "";
$rsMessage->ProviderReferenceNumber = "";
$rsMessage->CycleCode = "";
$rsMessage->RoutingNumber = "";
$rsMessage->PurchaseToken = "";
$rsMessage->ApprovalCode = "";
$rsMessage->CSCResponseCode = "";
$rsMessage->GatewayTransId = "";
$rsMessage->HolderName = "";
$rsMessage->InvoiceNum = "";
$rsMessage->TransactionCategory = "";
$rsMessage->Amount = "";
$rsMessage->AVSResponseCode = "";
$rsMessage->Email = "";
$rsMessage->Holdertype = "";
$rsMessage->AccountType = "";
$rsMessage->City = "";
$rsMessage->Memo = "";
$rsMessage->Phone = "";
$rsMessage->AccountNumberMasked = "";
$rsMessage->CountryCode = "";
$rsMessage->State = "";
$rsMessage->Street = "";
$rsMessage->TransactionIndustryType = "";
$rsMessage->ZipCode = "";
$rsMessage->PersistedData = "";
$rsMessage->ResponseCode = "";
$rsMessage->ResponseDescription = "";
$rsMessage->BatchID = "";Transaction Examples
A transaction is fundamentally identified by a combination of tenderType and transType. The basic required fields for any transaction are: tenderType, transType, username, password, merchantCode, merchantAccountCode, mode, locationId, and terminalId. A transaction is sent as the body of an
HTTPS POSTto the appropriate endpoint URL. In this guide a transaction will be identified by
TENDERTYPE_TRANSTYPESALE
SALE will charge a credit card and immediately put it into the current open batch for settlement. On the test server, amounts under $5.00 will decline, and amounts over $5.00 will approve. The following example will initialize a sale transaction of $12.00.
Request Examples
C#
BridgeCommRequest bcRequest = new BridgeCommRequest();
RequestMessage rqMessage = new RequestMessage();
bcRequest.User = "xxxxxx";
bcRequest.Password = "xxxxxx";
bcRequest.RequestType = "004";
bcRequest.TransactionID = DateTime.Now.ToString("yyyyMMddHHmmss");
bcRequest.requestMessage = new rqMessage;
rqMessage.MerchantCode = "123456";
rqMessage.MerchantAccountCode = "789123";
rqMessage.Amount = "1200";
rqMessage.TransIndustryType = "RE";
rqMessage.TransactionType = "SALE";
rqMessage.EntryMedium = "MC";
rqMessage.EntryMode = "MX";
rqMessage.PaymentAccountNumber = "1234123412341234";
rqMessage.ExpirationDate = "1234";
rqMessage.AcctType = "R";Java
BridgeCommRequest bcRequest = new BridgeCommRequest();
RequestMessage rqMessage = new RequestMessage();
bcRequest.setUser("xxxxxx");
bcRequest.setPassword("xxxxxx");
bcRequest.setRequestType("004");
bcRequest.setTransactionID(DateTime.Now.ToString("yyyyMMddHHmmss"));
bcRequest.setRequestMessage(new rqMessage));
rqMessage.setMerchantCode("123456");
rqMessage.setMerchantAccountCode("789123");
rqMessage.setAmount("1200");
rqMessage.setTransIndustryType("RE");
rqMessage.setTransactionType("SALE");
rqMessage.setEntryMedium("MC");
rqMessage.setEntryMode("MX");
rqMessage.setPaymentAccountNumber("1234123412341234");
rqMessage.setExpirationDate("1234");
rqMessage.setAcctType("R");PHP
$bcRequest = new BridgeCommRequest();
$bcRequest->$requestMessage = new RequestMessage();
bcRequest.User = "xxxxxx";
bcRequest.Password = "xxxxxx";
bcRequest.RequestType = "004";
bcRequest.TransactionID = DateTime.Now.ToString("yyyyMMddHHmmss");
bcRequest.requestMessage = new rqMessage;
$bcRequest->$requestMessage->MerchantCode = "123456";
$bcRequest->$requestMessage->MerchantAccountCode = "789123";
$bcRequest->$requestMessage->Amount = "1200";
$bcRequest->$requestMessage->TransIndustryType = "RE";
$bcRequest->$requestMessage->TransactionType = "SALE";
$bcRequest->$requestMessage->EntryMedium = "MC";
$bcRequest->$requestMessage->EntryMode = "MX";
$bcRequest->$requestMessage->PaymentAccountNumber = "1234123412341234";
$bcRequest->$requestMessage->ExpirationDate = "1234";
$bcRequest->$requestMessage->AcctType = "R";Response Example
Approval
BridgeCommConnection connection = new BridgeCommConnection();
BridgeCommResponse bcResponse = connection.processRequest(URL, bcRequest);
ResponseMessage rsMessage = bcResponse.responseMessage;
bcResponse.BridgeCommResponseType = "Auth";
bcResponse.RequestType = "004";
bcResponse.ResponseCode = "00000";
bcResponse.ResponseDescription = "Successful Request";
bcResponse.TransactionID = "20190709092529";
rsMessage.GatewayMessage = "A01 - Approved";
rsMessage.GatewayResult = "00000";
rsMessage.GatewayTransID = "3710636504";
rsMessage.TransactionCode = "20190709092529";
rsMessage.TransactionDate = "20190709";
rsMessage.AuthorizationCode = "537977";
rsMessage.AuthorizedAmount = "1200";
rsMessage.InternalMessage = "Approved: 537977 (approval code)";
rsMessage.isCommercialCard = "False";
rsMessage.IsoCountryCode = "840";
rsMessage.IsoCurrencyCode = "USD";
rsMessage.IsoRequestDate = "2019-07-09 09:25:30.663";
rsMessage.IsoTransactionDate = "2019-07-09 09:25:30.663";
rsMessage.MaskedPan = "1***********1234";
rsMessage.ExpirationDate = "1234";
rsMessage.CardClass = "Credit";
rsMessage.CardType = "Visa";
rsMessage.OriginalAmount = "1200";
rsMessage.ProviderResponseMessage = "Approved";
rsMessage.Token = "11110000000375160150";Decline
BridgeCommConnection connection = new BridgeCommConnection();
BridgeCommResponse bcResponse = connection.processRequest(URL, bcRequest);
ResponseMessage rsMessage = bcResponse.responseMessage;
bcResponse.BridgeCommResponseType = "Auth";
bcResponse.RequestType = "004";
bcResponse.ResponseCode = "30032";
bcResponse.ResponseDescription = "Denied by customer's bank";
bcResponse.TransactionID = "20190709092529";
rsMessage.GatewayMessage = "D01 - Denied by customer's bank (Issuer Unavailable)";
rsMessage.GatewayResult = "30032";
rsMessage.GatewayTransID = "3710636804";
rsMessage.TransactionCode = "20190709094426";
rsMessage.TransactionDate = "20190709";
rsMessage.AuthorizationCode = "537977";
rsMessage.AuthorizedAmount = "1200";
rsMessage.InternalMessage = "Denied by customer's bank";
rsMessage.ResponseTypeDescription = "denied";
rsMessage.isCommercialCard = "False";
rsMessage.IsoCountryCode = "840";
rsMessage.IsoCurrencyCode = "USD";
rsMessage.IsoRequestDate = "2019-07-09 09:25:30.663";
rsMessage.IsoTransactionDate = "2019-07-09 09:25:30.663";
rsMessage.MaskedPan = "1***********1234";
rsMessage.ExpirationDate = "1234";
rsMessage.CardClass = "Credit";
rsMessage.CardType = "Visa";
rsMessage.OriginalAmount = "1200";
rsMessage.ProviderResponseMessage = "Approved";
rsMessage.Token = "11110000000375160150";SALE-AUTH
SALE_AUTH will authorize a credit card but WILL NOT place in the current open batch for settlement. The authorization must be captured to be put into the current batch. If the batch is closed before the authorization is captured, the card will not be charged and the authorization will be dropped. See CREDIT_CAPTURE.
Request Examples
C#
BridgeCommRequest bcRequest = new BridgeCommRequest();
RequestMessage rqMessage = new RequestMessage();
bcRequest.User = "xxxxxx";
bcRequest.Password = "xxxxxx";
bcRequest.RequestType = "004";
bcRequest.TransactionID = DateTime.Now.ToString("yyyyMMddHHmmss");
bcRequest.requestMessage = new rqMessage;
rqMessage.MerchantCode = "123456";
rqMessage.MerchantAccountCode = "789123";
rqMessage.Amount = "1200";
rqMessage.TransIndustryType = "RE";
rqMessage.TransactionType = "SALE-AUTH";
rqMessage.EntryMedium = "MC";
rqMessage.EntryMode = "MX";
rqMessage.PaymentAccountNumber = "1234123412341234";
rqMessage.ExpirationDate = "1234";
rqMessage.AcctType = "R";Java
BridgeCommRequest bcRequest = new BridgeCommRequest();
RequestMessage rqMessage = new RequestMessage();
bcRequest.setUser("xxxxxx");
bcRequest.setPassword("xxxxxx");
bcRequest.setRequestType("004");
bcRequest.setTransactionID(DateTime.Now.ToString("yyyyMMddHHmmss"));
bcRequest.setRequestMessage(new rqMessage);
rqMessage.setMerchantCode("123456");
rqMessage.setMerchantAccountCode("789123");
rqMessage.setAmount("1200");
rqMessage.setTransIndustryType("RE");
rqMessage.setTransactionType("SALE-AUTH");
rqMessage.setEntryMedium("MC");
rqMessage.setEntryMode("MX");
rqMessage.setPaymentAccountNumber("1234123412341234");
rqMessage.setExpirationDate("1234");
rqMessage.setAcctType("R");PHP
$bcRequest = new BridgeCommRequest();
$bcRequest->$requestMessage = new RequestMessage();
$bcRequest->User = "xxxxxx";
$bcRequest->Password = "xxxxxx";
$bcRequest->RequestType = "004";
$bcRequest->TransactionID = DateTime.Now.ToString("yyyyMMddHHmmss");
$bcRequest->$requestMessage->MerchantCode = "123456";
$bcRequest->$requestMessage->MerchantAccountCode = "789123";
$bcRequest->$requestMessage->Amount = "1200";
$bcRequest->$requestMessage->TransIndustryType = "RE";
$bcRequest->$requestMessage->TransactionType = "SALE-AUTH";
$bcRequest->$requestMessage->EntryMedium = "MC";
$bcRequest->$requestMessage->EntryMode = "MX";
$bcRequest->$requestMessage->PaymentAccountNumber = "1234123412341234";
$bcRequest->$requestMessage->ExpirationDate = "1234";
$bcRequest->$requestMessage->AcctType = "R";Response Example
BridgeCommConnection connection = new BridgeCommConnection();
BridgeCommResponse bcResponse = connection.processRequest(URL, bcRequest);
ResponseMessage rsMessage = bcResponse.responseMessage;
bcResponse.BridgeCommResponseType = "Auth";
bcResponse.RequestType = "004";
bcResponse.ResponseCode = "00000";
bcResponse.ResponseDescription = "Successful Request";
bcResponse.TransactionID = "20190709092529";
rsMessage.GatewayMessage = "A01 - Approved";
rsMessage.GatewayResult = "00000";
rsMessage.GatewayTransID = "3710636504";
rsMessage.TransactionCode = "20190709092529";
rsMessage.TransactionDate = "20190709";
rsMessage.AuthorizationCode = "537977";
rsMessage.AuthorizedAmount = "1200";
rsMessage.InternalMessage = "Approved: 537977 (approval code)";
rsMessage.isCommercialCard = "False";
rsMessage.IsoCountryCode = "840";
rsMessage.IsoCurrencyCode = "USD";
rsMessage.IsoRequestDate = "2019-07-09 09:25:30.663";
rsMessage.IsoTransactionDate = "2019-07-09 09:25:30.663";
rsMessage.MaskedPan = "1***********1234";
rsMessage.ExpirationDate = "1234";
rsMessage.CardClass = "Credit";
rsMessage.CardType = "Visa";
rsMessage.OriginalAmount = "1200";
rsMessage.ProviderResponseMessage = "Approved";
rsMessage.Token = "11110000000375160150";CAPTURE
CREDIT_CAPTURE will place an approved SALE_AUTH transaction into the current open batch by using the pnRefNum returned by the SALE_AUTH. This capture can be voided before the batch is closed by using the pnRefNum returned from the CREDIT_CAPTURE request.
Request Examples
C#
BridgeCommRequest bcRequest = new BridgeCommRequest();
RequestMessage rqMessage = new RequestMessage();
bcRequest.User = "xxxxxx";
bcRequest.Password = "xxxxxx";
bcRequest.RequestType = "019";
bcRequest.TransactionID = DateTime.Now.ToString("yyyyMMddHHmmss");
bcRequest.requestMessage = new rqMessage;
rqMessage.MerchantCode = "123456";
rqMessage.MerchantAccountCode = "789123";
rqMessage.TransIndustryType = "RE";
rqMessage.TransactionType = "CAPTURE";
rqMessage.ReferenceNumber = "12345678";Java
BridgeCommRequest bcRequest = new BridgeCommRequest();
RequestMessage rqMessage = new RequestMessage();
bcRequest.setUser("xxxxxx");
bcRequest.setPassword("xxxxxx");
bcRequest.setRequestType("019");
bcRequest.setTransactionID(DateTime.Now.ToString("yyyyMMddHHmmss"));
bcRequest.setRequestMessage(new rqMessage);
rqMessage.setMerchantCode("123456");
rqMessage.setMerchantAccountCode("789123");
rqMessage.setTransIndustryType("RE");
rqMessage.setTransactionType("CAPTURE");
rqMessage.setReferenceNumber("12345678");PHP
$bcRequest = new BridgeCommRequest();
$bcRequest->$requestMessage = new RequestMessage();
$bcRequest->User = "xxxxxx";
$bcRequest->Password = "xxxxxx";
$bcRequest->RequestType = "019";
$bcRequest->TransactionID = DateTime.Now.ToString("yyyyMMddHHmmss");
$bcRequest->$requestMessage->MerchantCode = "123456";
$bcRequest->$requestMessage->MerchantAccountCode = "789123";
$bcRequest->$requestMessage->TransIndustryType = "RE";
$bcRequest->$requestMessage->TransactionType = "CAPTURE";
$bcRequest->$requestMessage->ReferenceNumber = "12345678";Response Example
BridgeCommConnection connection = new BridgeCommConnection();
BridgeCommResponse bcResponse = connection.processRequest(URL, bcRequest);
ResponseMessage rsMessage = bcResponse.responseMessage;
bcResponse.BridgeCommResponseType = "Auth";
bcResponse.RequestType = "019";
bcResponse.ResponseCode = "00000";
bcResponse.ResponseDescription = "Successful Request";
bcResponse.TransactionID = "20190709092529";
rsMessage.GatewayMessage = "A01 - Approved";
rsMessage.GatewayResult = "00000";
rsMessage.GatewayTransID = "3710636504";
rsMessage.TransactionCode = "20190709092529";
rsMessage.TransactionDate = "20190709";
rsMessage.AuthorizationCode = "537977";TOKENADD
CREDIT_TOKENADD will tokenize a credit card number and store this token in the gateway for future use. TOKENADD is swipe-only. To use a token in the future the token must be supplied with the correct expiration date.
Request Examples
C#
BridgeCommRequest bcRequest = new BridgeCommRequest();
RequestMessage rqMessage = new RequestMessage();
bcRequest.User = "xxxxxx";
bcRequest.Password = "xxxxxx";
bcRequest.RequestType = "001";
bcRequest.TransactionID = DateTime.Now.ToString("yyyyMMddHHmmss");
bcRequest.requestMessage = new rqMessage;
rqMessage.MerchantCode = "123456";
rqMessage.MerchantAccountCode = "789123";
rqMessage.Amount = "1200";
rqMessage.TransIndustryType = "RE";
rqMessage.TransactionType = "TOKENADD";
rqMessage.EntryMedium = "MC";
rqMessage.EntryMode = "MX";Java
BridgeCommRequest bcRequest = new BridgeCommRequest();
RequestMessage rqMessage = new RequestMessage();
bcRequest.setUser("xxxxxx");
bcRequest.setPassword("xxxxxx");
bcRequest.setRequestType("001");
bcRequest.setTransactionID(DateTime.Now.ToString("yyyyMMddHHmmss"));
bcRequest.setRequestMessage(new rqMessage);
rqMessage.setMerchantCode("123456");
rqMessage.setMerchantAccountCode("789123");
rqMessage.setAmount("1200");
rqMessage.setTransIndustryType("RE");
rqMessage.setTransactionType("TOKENADD");
rqMessage.setEntryMedium("MC");
rqMessage.setEntryMode("MX");PHP
$bcRequest = new BridgeCommRequest();
$bcRequest->$requestMessage = new RequestMessage();
$bcRequest->User = "xxxxxx";
$bcRequest->.Password = "xxxxxx";
$bcRequest->RequestType = "001";
$bcRequest->TransactionID = DateTime.Now.ToString("yyyyMMddHHmmss");
$bcRequest->requestMessage->MerchantCode = "123456";
$bcRequest->requestMessage->MerchantAccountCode = "789123";
$bcRequest->requestMessage->Amount = "1200";
$bcRequest->requestMessage->TransIndustryType = "RE";
$bcRequest->requestMessage->TransactionType = "TOKENADD";
$bcRequest->requestMessage->EntryMedium = "MC";
$bcRequest->requestMessage->EntryMode = "MX";Response Example
BridgeCommConnection connection = new BridgeCommConnection();
BridgeCommResponse bcResponse = connection.processRequest(URL, bcRequest);
ResponseMessage rsMessage = bcResponse.responseMessage;
bcResponse.BridgeCommResponseType = "Auth";
bcResponse.RequestType = "004";
bcResponse.ResponseCode = "00000";
bcResponse.ResponseDescription = "Successful Request";
bcResponse.TransactionID = "20190709092529";
rsMessage.GatewayMessage = "A01 - Approved";
rsMessage.GatewayResult = "00000";
rsMessage.GatewayTransID = "3710636504";
rsMessage.Token = "11110000000375160150";VOID
VOID will void a transaction in the current open batch based upon the supplied pnRefNum. If the transaction has already been settled, the gateway will then REFUND the transaction.
Request Examples
C#
BridgeCommRequest bcRequest = new BridgeCommRequest();
RequestMessage rqMessage = new RequestMessage();
bcRequest.User = "xxxxxx";
bcRequest.Password = "xxxxxx";
bcRequest.RequestType = "001";
bcRequest.TransactionID = DateTime.Now.ToString("yyyyMMddHHmmss");
bcRequest.requestMessage = new rqMessage;
rqMessage.MerchantCode = "123456";
rqMessage.MerchantAccountCode = "789123";
rqMessage.Amount = "1200";
rqMessage.TransIndustryType = "RE";
rqMessage.TransactionType = "VOID";
rqMessage.ReferenceNumber = "253271404";Java
BridgeCommRequest bcRequest = new BridgeCommRequest();
RequestMessage rqMessage = new RequestMessage();
bcRequest.setUser("xxxxxx");
bcRequest.setPassword("xxxxxx");
bcRequest.setRequestType("001");
bcRequest.setTransactionID(DateTime.Now.ToString("yyyyMMddHHmmss"));
bcRequest.setRequestMessage(new rqMessage);
rqMessage.setMerchantCode("123456");
rqMessage.setMerchantAccountCode("789123");
rqMessage.setAmount("1200");
rqMessage.setTransIndustryType("RE");
rqMessage.setTransactionType("VOID");
rqMessage.setReferenceNumber = "253271404";PHP
$bcRequest = new BridgeCommRequest();
$bcRequest->$requestMessage = new RequestMessage();
$bcRequest->User = "xxxxxx";
$bcRequest->.Password = "xxxxxx";
$bcRequest->RequestType = "001";
$bcRequest->TransactionID = DateTime.Now.ToString("yyyyMMddHHmmss");
$bcRequest->requestMessage->MerchantCode = "123456";
$bcRequest->requestMessage->MerchantAccountCode = "789123";
$bcRequest->requestMessage->Amount = "1200";
$bcRequest->requestMessage->TransIndustryType = "RE";
$bcRequest->requestMessage->TransactionType = "VOID";
$bcRequest->requestMessage->ReferenceNumber = "253271404";Response Example
{
"requestID": "d9061af72f73f118fb9a2558c379066f3249b385028d486d404f0a0d",
"locationID": "C832D913-982C-4256-9895-2DD13BDA5947",
"terminalID": "9102C064-F990-41AB-BAD4-C98F33E4C684",
"approvedAmount": "",
"cashBackAmt": "",
"extData": {"lodgingItem": [],
"receiptTagData": {}
}, "gatewayMessage": "A03 - Void Posted (Auth Reversed)",
"gatewayResult": "0",
"pnRefNum": "253271404",
"remainingAmount": "0.00",
"requestedAmount": "",
"responseTypeDescription": "void",
"resultCode": "0",
"resultTxt": "Successful Request",
"submittedAmount": "",
"tipAmount": "",
"transactionCode": ""
}REFUND
REFUND will refund a transaction that has been settled. If the transaction is NOT settled and is in the current open batch, the gateway will then VOID the transaction.
Request Examples
C#
BridgeCommRequest bcRequest = new BridgeCommRequest();
RequestMessage rqMessage = new RequestMessage();
bcRequest.User = "xxxxxx";
bcRequest.Password = "xxxxxx";
bcRequest.RequestType = "004";
bcRequest.TransactionID = DateTime.Now.ToString("yyyyMMddHHmmss");
bcRequest.requestMessage = new rqMessage;
rqMessage.MerchantCode = "123456";
rqMessage.MerchantAccountCode = "789123";
rqMessage.Amount = "1200";
rqMessage.TransIndustryType = "RE";
rqMessage.TransactionType = "REFUND";
rqMessage.EntryMedium = "MC";
rqMessage.EntryMode = "MX";
rqMessage.ReferenceNumber = "253274504";Java
BridgeCommRequest bcRequest = new BridgeCommRequest();
RequestMessage rqMessage = new RequestMessage();
bcRequest.setUser("xxxxxx");
bcRequest.setPassword("xxxxxx");
bcRequest.setRequestType("004");
bcRequest.setTransactionID(DateTime.Now.ToString("yyyyMMddHHmmss"));
bcRequest.setRequestMessage(new rqMessage);
rqMessage.setMerchantCode("123456");
rqMessage.setMerchantAccountCode("789123");
rqMessage.setAmount("1200");
rqMessage.setTransIndustryType("RE");
rqMessage.setTransactionType("REFUND");
rqMessage.setReferenceNumber = "253271404";
rqMessage.setEntryMedium("MC");
rqMessage.setEntryMode("MX");PHP
$bcRequest = new BridgeCommRequest();
$bcRequest->$requestMessage = new RequestMessage();
$bcRequest->User = "xxxxxx";
$bcRequest->.Password = "xxxxxx";
$bcRequest->RequestType = "004";
$bcRequest->TransactionID = DateTime.Now.ToString("yyyyMMddHHmmss");
$bcRequest->requestMessage->MerchantCode = "123456";
$bcRequest->requestMessage->MerchantAccountCode = "789123";
$bcRequest->requestMessage->Amount = "1200";
$bcRequest->requestMessage->TransIndustryType = "RE";
$bcRequest->requestMessage->TransactionType = "REFUND";
$bcRequest->requestMessage->ReferenceNumber = "253271404";
$bcRequest->requestMessage->EntryMedium = "MC";
$bcRequest->requestMessage->EntryMode = "MX";Response Example
{
"requestID": "38128d5eacd3f3d11600b2b3e6a2a79f3c0decf97fc0a1b44f102b23",
"locationID": "C832D913-982C-4256-9895-2DD13BDA5947",
"terminalID": "9102C064-F990-41AB-BAD4-C98F33E4C684",
"approvedAmount": "",
"cashBackAmt": "",
"extData": {"lodgingItem": [],
"receiptTagData": {}
}, "gatewayMessage": "A03 - Refund Posted",
"gatewayResult": "0",
"pnRefNum": "253274504",
"remainingAmount": "0.00",
"requestedAmount": "",
"responseTypeDescription": "refund",
"resultCode": "0",
"resultTxt": "Successful Request",
"submittedAmount": "",
"tipAmount": "",
"transactionCode": ""
}Card Verification
Card Verification verifies with the processor that the card is valid.
Request Examples
C#
BridgeCommRequest bcRequest = new BridgeCommRequest();
RequestMessage rqMessage = new RequestMessage();
bcRequest.User = "xxxxxx";
bcRequest.Password = "xxxxxx";
bcRequest.RequestType = "015";
bcRequest.TransactionID = DateTime.Now.ToString("yyyyMMddHHmmss");
bcRequest.requestMessage = new rqMessage;
rqMessage.MerchantCode = "123456";
rqMessage.MerchantAccountCode = "789123";
rqMessage.TransIndustryType = "RE";
rqMessage.TransactionType = "Account-Verification";
rqMessage.EntryMedium = "MC";
rqMessage.EntryMode = "MX";
rqMessage.PaymentAccountNumber = "1234123412341234";
rqMessage.ExpirationDate = "1234";
rqMessage.AcctType = "R";Java
BridgeCommRequest bcRequest = new BridgeCommRequest();
RequestMessage rqMessage = new RequestMessage();
bcRequest.setUser("xxxxxx");
bcRequest.setPassword("xxxxxx");
bcRequest.setRequestType("015");
bcRequest.setTransactionID(DateTime.Now.ToString("yyyyMMddHHmmss"));
bcRequest.setRequestMessage(new rqMessage);
rqMessage.setMerchantCode("123456");
rqMessage.setMerchantAccountCode("789123");
rqMessage.setTransIndustryType("RE");
rqMessage.setTransactionType("Account-Verification");
rqMessage.setEntryMedium("MC");
rqMessage.setEntryMode("MX");
rqMessage.setPaymentAccountNumber("1234123412341234");
rqMessage.setExpirationDate("1234");
rqMessage.setAcctType("R");PHP
$bcRequest = new BridgeCommRequest();
$bcRequest->$requestMessage = new RequestMessage();
$bcRequest->User = "xxxxxx";
$bcRequest->Password = "xxxxxx";
$bcRequest->RequestType = "015";
$bcRequest->TransactionID = DateTime.Now.ToString("yyyyMMddHHmmss");
$bcRequest->requestMessage->MerchantCode = "123456";
$bcRequest->requestMessage->MerchantAccountCode = "789123";
$bcRequest->requestMessage->TransIndustryType = "RE";
$bcRequest->requestMessage->TransactionType = "Account-Verification";
$bcRequest->requestMessage->EntryMedium = "MC";
$bcRequest->requestMessage->EntryMode = "MX";
$bcRequest->requestMessage->PaymentAccountNumber = "1234123412341234";
$bcRequest->requestMessage->ExpirationDate = "1234";
$bcRequest->requestMessage->AcctType = "R";Card on File
Request Examples
C#
BridgeCommRequest bcRequest = new BridgeCommRequest();
RequestMessage rqMessage = new RequestMessage();
bcRequest.User = "xxxxxx";
bcRequest.Password = "xxxxxx";
bcRequest.RequestType = "004";
bcRequest.TransactionID = DateTime.Now.ToString("yyyyMMddHHmmss");
bcRequest.requestMessage = new rqMessage;
rqMessage.StoredCredential = "recurring";
rqMessage.MerchantCode = "123456";
rqMessage.MerchantCode = "123456";
rqMessage.MerchantAccountCode = "789123";
rqMessage.Amount = "1200";
rqMessage.TransIndustryType = "RE";
rqMessage.TransactionType = "SALE";
rqMessage.EntryMedium = "MC";
rqMessage.EntryMode = "MX";
rqMessage.PaymentAccountNumber = "1234123412341234";
rqMessage.ExpirationDate = "1234";
rqMessage.AcctType = "R";Java
BridgeCommRequest bcRequest = new BridgeCommRequest();
RequestMessage rqMessage = new RequestMessage();
bcRequest.setUser("xxxxxx");
bcRequest.setPassword("xxxxxx");
bcRequest.setRequestType("004");
bcRequest.setTransactionID(DateTime.Now.ToString("yyyyMMddHHmmss"));
bcRequest.setRequestMessage(new rqMessage);
rqMessage.setStoredCredential("recurring");
rqMessage.setMerchantCode("123456");
rqMessage.setMerchantCode("123456");
rqMessage.setMerchantAccountCode("789123");
rqMessage.setAmount("1200");
rqMessage.setTransIndustryType("RE");
rqMessage.setTransactionType("SALE");
rqMessage.setEntryMedium("MC");
rqMessage.setEntryMode("MX");
rqMessage.setPaymentAccountNumber("1234123412341234");
rqMessage.setExpirationDate("1234");
rqMessage.setAcctType("R");PHP
$bcRequest = new BridgeCommRequest();
$bcRequest->$requestMessage = new RequestMessage();
$bcRequest->User = "xxxxxx";
$bcRequest->Password = "xxxxxx";
$bcRequest->RequestType = "004";
$bcRequest->TransactionID = DateTime.Now.ToString("yyyyMMddHHmmss");
$bcRequest->requestMessage->StoredCredential = "recurring";
$bcRequest->requestMessage->MerchantCode = "123456";
$bcRequest->requestMessage->MerchantCode = "123456";
$bcRequest->requestMessage->MerchantAccountCode = "789123";
$bcRequest->requestMessage->Amount = "1200";
$bcRequest->requestMessage->TransIndustryType = "RE";
$bcRequest->requestMessage->TransactionType = "SALE";
$bcRequest->requestMessage->EntryMedium = "MC";
$bcRequest->requestMessage->EntryMode = "MX";
$bcRequest->requestMessage->PaymentAccountNumber = "1234123412341234";
$bcRequest->requestMessage->ExpirationDate = "1234";
$bcRequest->requestMessage->AcctType = "R";Custom Fields
Request Examples
C#
BridgeCommRequest bcRequest = new BridgeCommRequest();
RequestMessage rqMessage = new RequestMessage();
bcRequest.User = "xxxxxx";
bcRequest.Password = "xxxxxx";
bcRequest.RequestType = "004";
bcRequest.TransactionID = DateTime.Now.ToString("yyyyMMddHHmmss");
bcRequest.requestMessage = new rqMessage;
rqMessage.MerchantCode = "123456";
rqMessage.MerchantAccountCode = "789123";
rqMessage.Amount = "1200";
rqMessage.TransIndustryType = "RE";
rqMessage.TransactionType = "SALE";
rqMessage.EntryMedium = "MC";
rqMessage.EntryMode = "MX";
rqMessage.PaymentAccountNumber = "1234123412341234";
rqMessage.ExpirationDate = "1234";
rqMessage.AcctType = "R";
rqMessage.CustomFields = " 111 ";Java
BridgeCommRequest bcRequest = new BridgeCommRequest();
RequestMessage rqMessage = new RequestMessage();
bcRequest.setUser("xxxxxx");
bcRequest.setPassword("xxxxxx");
bcRequest.setRequestType("004");
bcRequest.setTransactionID(DateTime.Now.ToString("yyyyMMddHHmmss"));
bcRequest.setRequestMessage(new rqMessage);
rqMessage.setMerchantCode("123456");
rqMessage.setMerchantAccountCode("789123");
rqMessage.setAmount("1200");
rqMessage.setTransIndustryType("RE");
rqMessage.setTransactionType("SALE");
rqMessage.setEntryMedium("MC");
rqMessage.setEntryMode("MX");
rqMessage.setPaymentAccountNumber("1234123412341234");
rqMessage.setExpirationDate("1234");
rqMessage.setAcctType("R");
rqMessage.setCustomFields(" 111 ");PHP
$bcRequest = new BridgeCommRequest();
$bcRequest->$requestMessage = new RequestMessage();
$bcRequest->User = "xxxxxx";
$bcRequest->Password = "xxxxxx";
$bcRequest->RequestType = "004";
$bcRequest->TransactionID = DateTime.Now.ToString("yyyyMMddHHmmss");
$bcRequest->requestMessage->MerchantCode = "123456";
$bcRequest->requestMessage->MerchantAccountCode = "789123";
$bcRequest->requestMessage->Amount = "1200";
$bcRequest->requestMessage->TransIndustryType = "RE";
$bcRequest->requestMessage->TransactionType = "SALE";
$bcRequest->requestMessage->EntryMedium = "MC";
$bcRequest->requestMessage->EntryMode = "MX";
$bcRequest->requestMessage->PaymentAccountNumber = "1234123412341234";
$bcRequest->requestMessage->ExpirationDate = "1234";
$bcRequest->requestMessage->AcctType = "R";
$bcRequest->requestMessage->CustomFields = " 111 ";Dynamic Descriptors
Request Examples
C#
BridgeCommRequest bcRequest = new BridgeCommRequest();
RequestMessage rqMessage = new RequestMessage();
bcRequest.User = "xxxxxx";
bcRequest.Password = "xxxxxx";
bcRequest.RequestType = "004";
bcRequest.TransactionID = DateTime.Now.ToString("yyyyMMddHHmmss");
bcRequest.requestMessage = new rqMessage;
rqMessage.MerchantCode = "123456";
rqMessage.MerchantAccountCode = "789123";
rqMessage.Amount = "1200";
rqMessage.TransIndustryType = "RE";
rqMessage.TransactionType = "SALE";
rqMessage.EntryMedium = "MC";
rqMessage.EntryMode = "MX";
rqMessage.PaymentAccountNumber = "1234123412341234";
rqMessage.ExpirationDate = "1234";
rqMessage.DynamicDescriptorAddress = "123 street";
rqMessage.DynamicDescriptorCity = "Atlanta";
rqMessage.DynamicDescriptorCountry = "US";
rqMessage.DynamicDescriptorRegion = "";
rqMessage.DynamicDescriptorPostalCode = "30328";
rqMessage.DynamicDescriptorCountryCode = "840";
rqMessage.DynamicDescriptorEmailAddress = "test@test.com";
rqMessage.AcctType = "R";Java
BridgeCommRequest bcRequest = new BridgeCommRequest();
RequestMessage rqMessage = new RequestMessage();
bcRequest.setUser("xxxxxx");
bcRequest.setPassword("xxxxxx");
bcRequest.setRequestType("004");
bcRequest.setTransactionID(DateTime.Now.ToString("yyyyMMddHHmmss"));
bcRequest.setRequestMessage(new rqMessage);
rqMessage.setMerchantCode("123456");
rqMessage.setMerchantAccountCode("789123");
rqMessage.setAmount("1200");
rqMessage.setTransIndustryType("RE");
rqMessage.setTransactionType("SALE");
rqMessage.setEntryMedium("MC");
rqMessage.setEntryMode("MX");
rqMessage.setPaymentAccountNumber("1234123412341234");
rqMessage.setExpirationDate("1234");<"DynamicDescriptorText">
rqMessage.setDynamicDescriptorAddress("123 street");
rqMessage.setDynamicDescriptorCity("Atlanta");
rqMessage.setDynamicDescriptorCountry("US");
rqMessage.setDynamicDescriptorRegion("");
rqMessage.setDynamicDescriptorPostalCode("30328");
rqMessage.setDynamicDescriptorCountryCode("840");
rqMessage.setDynamicDescriptorEmailAddress("test@test.com");
rqMessage.setAcctType("R");PHP
$bcRequest = new BridgeCommRequest();
$bcRequest->$requestMessage = new RequestMessage();
$bcRequest->User = "xxxxxx";
$bcRequest->Password = "xxxxxx";
$bcRequest->RequestType = "004";
$bcRequest->TransactionID = DateTime.Now.ToString("yyyyMMddHHmmss");
$bcRequest->requestMessage->MerchantCode = "123456";
$bcRequest->requestMessage->MerchantAccountCode = "789123";
$bcRequest->requestMessage->Amount = "1200";
$bcRequest->requestMessage->TransIndustryType = "RE";
$bcRequest->requestMessage->TransactionType = "SALE";
$bcRequest->requestMessage->EntryMedium = "MC";
$bcRequest->requestMessage->EntryMode = "MX";
$bcRequest->requestMessage->PaymentAccountNumber = "1234123412341234";
$bcRequest->requestMessage->ExpirationDate = "1234";<"DynamicDescriptorText">
$bcRequest->requestMessage->DynamicDescriptorAddress = "123 street";
$bcRequest->requestMessage->DynamicDescriptorCity = "Atlanta";
$bcRequest->requestMessage->DynamicDescriptorCountry = "USA";
$bcRequest->requestMessage->DynamicDescriptorRegion = "";
$bcRequest->requestMessage->DynamicDescriptorPostalCode = "30328";
$bcRequest->requestMessage->DynamicDescriptorCountryCode = "840";
$bcRequest->requestMessage->DynamicDescriptorEmailAddress = "test@test.com";
$bcRequest->requestMessage->AcctType = "R";
- 1 Introduction
- 2 SDK
- 2.1.1 Test URL
- 2.1.2 Production URL
- 2.2 C#
- 2.3 Java
- 2.4 PHP
- 3 Transaction Examples
- 3.1 SALE
- 3.1.1 Request Examples
- 3.1.2 Response Example
- 3.2 SALE-AUTH
- 3.2.1 Request Examples
- 3.2.2 Response Example
- 3.3 CAPTURE
- 3.3.1 Request Examples
- 3.3.2 Response Example
- 3.4 TOKENADD
- 3.4.1 Request Examples
- 3.4.2 Response Example
- 3.5 VOID
- 3.5.1 Request Examples
- 3.5.2 Response Example
- 3.6 REFUND
- 3.6.1 Request Examples
- 3.6.2 Response Example
- 3.7 Card Verification
- 3.7.1 Request Examples
- 3.8 Card on File
- 3.8.1 Request Examples
- 3.9 Custom Fields
- 3.9.1 Request Examples
- 3.10 Dynamic Descriptors
- 3.10.1 Request Examples
- 3.1 SALE
Property of BridgePay Network Solution ©2025