Merchant Web Services - Forte
Merchant Web ServicesIntegration Guide v1.2Updated September 21, 2015This document is only for the maintenance of existing integrations. Tointegrate to the Forte platform using web services, Forte recommends that newmerchants use the latest version of Forte’s REST API. For more informationsee DevDocs (https://restdocs.forte.net/). 2021 CSG Systems International, Inc. and/or its affiliatesFor the latest Information,Confidential1 Pagevisitour website at www.forte.net
Revision HistoryDocument 5Added the Account Updater flag, SuppressAccountUpdater, to the Paymethod objectper WS-24.1.209/21/2015Added the AGI Transaction SOAP Endpoint. 2021 CSG Systems International, Inc. and/or its affiliates (“CSG”)All rights reserved. The information contained in this document is subject to change without notice. CSG makesno warranty of any kind with regard to this material, including but not limited to the documentation, function,and performance of these programs and their suitability for any purpose. CSG shall not be liable for any errorscontained herein for incidental or consequential damages in connection with the furnishing, performance, or useof this material.This document contains proprietary information, including trade secrets, which is protected by copyright. Allrights are reserved. No part of this document may be reproduced or translated into another document in anylanguage without prior consent of CSG Systems International, Inc., 500 W. Bethany Dr., Suite 200, Allen, TX75013. 2021 CSG Systems International, Inc. and/or its affiliatesConfidential2 Page
Table of ContentsIntroduction . 5Overview . 5Enum Reference . 6Overview . 6Available Enums . 6Type Reference . 8Overview . 8Folder. 8OriginationSummary . 8SettleSummary . 8Object Reference . 9Overview . 9Authentication . 9Client. 9EntryType . 10Hierarchy . 10LineItem . 11Merchant . 11Page . 11PaymentMethod . 11Range . 12ReceivedSummary . 12SearchFilter. 13Settlement . 13Transaction . 13Transaction Response . 14Transactionsummary. 15Methods Reference . 16getTransactionAuthTicket. 16getClientAuthTicket . 16createClient . 17updateClient . 17 2021 CSG Systems International, Inc. and/or its affiliatesConfidential3 Page
deleteClient . 18getClient. 19createPaymentMethod . 19updatePaymentMethod . 20deletePaymentMethod . 21getPaymentMethod . 22getHierarchyTree . 23searchTransactions . 23searchSettleActivity . 24getReceivedSummary . 26getOriginationSummary . 27getSettleSummary. 27getSettleDetail. 27getReceivedDetail . 28getTransaction . 30 2021 CSG Systems International, Inc. and/or its affiliatesConfidential4 Page
IntroductionOverviewForte’s merchant web services include the following: Client: Create and manage client and payment method tokens Transactions: Search and pull transaction information Merchant: Pull hierarchy data AGI Transaction: Create payment transactions using the Advanced GatewayInterface (AGI). See the AGI Guide for messaging and response details.Use the following test and production locations with the following web services:Client Sandbox: https://sandbox.paymentsgateway.net/WS/Client.svc Live: vcLocationsTransaction Sandbox: .svc Live: ion.svcMerchant Sandbox: c Live: .svcAGI Transaction Sandbox: way.asmx Live: asmxThe following table lists the requirement codes for the fields described in this document.Codes for nalConditionalResponse Only 2021 CSG Systems International, Inc. and/or its affiliatesDescriptionMust appear when table’s fields are usedMay appear when table’s fields are usedSee description for exact requirementsOnly appears in response messagesConfidential5 Page
Enum ReferenceOverviewThe following table lists the available enums in the merchant web Available peSortDirectionValues ThanNote: Equal behaves similar to Starts With. VISA MAST DISC AMER DINE JCB PPD CCD POP RCK WEB TEL CTX CIE POS ARC BOC NoneeCheck Funded Rejected Previously Funded RejectCredit Card Settled Chargeback UnChargeback eCheck CreditCard And Or Received Originated ascending descendingContinued 2021 CSG Systems International, Inc. and/or its affiliatesConfidential6 Page
Enum Reference (cont’d)NameTransactionColumnAvailable Enums(cont’d) 2021 CSG Systems International, Inc. and/or its affiliatesValues nsumerIDStatusConfidential7 Page
Type maryThe following tables lists the different types available for merchant web sstringintarrayarrayFolder NameHierarchy IDArray of Folder ObjectsArray of Merchant Objects (see the ObjectReference chant IDDate SummaryTransaction TypeStatusEntry TypeCountConvenience Fee Amount (Service Fee)Total stringintdoubledoubledoubledoubleMerchant IDSettle DateResponse CodeFundingTypeCountPrincipal Convenience Fee Amount (Service Fee)Principal Total AmountFunded Convenience Fee Amount (Service Fee)Funded Total Amount 2021 CSG Systems International, Inc. and/or its affiliatesConfidential8 Page
Object ReferenceOverviewThe following tables lists the different objects available for merchant web services.The Authentication object contains the APILoginID and Secure Transaction Key used toidentify and authenticate the requestor. Both fields may be maintained in the VirtualTerminal’s Gateway Settings HashstringstringUTCTimestringSet in the Virtual TerminalHMACMD5 (APILoginID “ ” UTCTime, Securetransactionkey)UTC in ticks (since 01/01/0001 00:00:00)The Client object represents the information for a given client. Most fields arealphanumeric in nature. The only validation rules are the following:A. The record must have either a First and Last Name or a Company NameB. The Status must be one of the following enumerated values: ACTIVE SUSPENDED DELETEDNote: Transactions for suspended clients will always fail.NameTypeCreateUpdate ingOO—RPhoneNumberstringOO—RMerchant IDClient IDOptional ifCompanyName ispresent.Optional ifCompanyName ispresent.Optional if FirstNameand LastName arepresent.First line of BillingAddress for customerSecond line of BillingAddress for customer(e.g., Apt #)Billing City for customerTwo-letter abbreviationfor the Billing State ofthe customerBilling Zip Code for thecustomerBilling Phone Numberfor the customerClientContinued 2021 CSG Systems International, Inc. and/or its affiliatesConfidential9 Page
Object Reference (cont’d)Client (cont’d)EntryTypeHierarchyNameTypeCreateUpdate ngenumO—OO——RRBilling Country Code forthe customer. UnitedStates is 01.Billing Email forcustomer.Billing Fax for customer.First Name of thereceiver of the goods.Last Name of thereceiver of the goods.Company Name of thereceiver of the goods, ifapplicable.First line of the ShippingAddressSecond line of theShipping AddressShipping City of thereceiver of the goods.Two-letter abbreviationof the shipping addressState.The shipping address ZipCode of the receiver ofthe goods.Country Code of theshipping address. UnitedStates is 01.Phone Number of thereceiver of the goods.Fax Number of thereceiver of the goods.Consumer ID ACTIVE SUSPENDED DELETEDNameTypeDescriptionCC Sale 10CC Auth Only 11CC Credit 13CC Ext Authorization 15eCheck Sale 20eCheck Auth Only 21eCheck Credit 23eCheck Force Credit Card Sale (10)Credit Card Authorization Only (11)Credit Card Credit (13)Credit Card External Authorization (15)eCheck Sale (20)eCheck Authorization Only (21)eCheck Credit (23)eCheck Force (25)NameTypeDescriptionFolderFolderTop Folder ObjectContinued 2021 CSG Systems International, Inc. and/or its affiliatesConfidential10 P a g e
Object Reference tringstringHeader dataItem hant NameMerchant TransactionColumnenumNumber of records returned. The maximum value is 0.Page number (0 based)Sort by this field.PageSortDirectionDirection of the sorted fieldThis object represents payment method data. The ClientID may be omitted if it is beingused without a Client record. Only the AcctHolderName, CcExpirationDate,CcProcurementCard, Note, and IsDefault fields may be updated. Other changesrepresent a new payment method and will have to be put into a new PaymentMethodrecord. CcCardNumber and EcAccountNumber fields are masked in responsemessages. Each record may hold either credit card or electronic check information butnever both.NameTypeCreateUpdate —RMerchant IDIf not zero, this fieldmust exist and beassociated with aMerchant ID.Assigned by the servicefor Create requests.Updates must exist andbe associated with aMerchant ID.Full name of the creditcard account holder as itappears on the creditcard.Must be a valid creditcard number.Expiration Date of thecredit card in YYYYMMformat.PaymentMethodContinued 2021 CSG Systems International, Inc. and/or its affiliatesConfidential11 P a g e
Object Reference aryNameTypeCreateUpdate DeleteCcCardTypeenumCO—GetDescriptionRSupported values includethe following: VISA MAST AMER DISC DINE JCBCcProcurementCardboolC——RA Boolean specifyingwhether the card is usedfor procurement.EcAccountNumberstringCC—RMust be a valid accountnumber.EcAccountTRNstringC——RMust be a valid routingnumber.EcAccountTypeenumC——RSupported values includethe following: Savings CheckingNotestringOO—RMerchant dataIsDefaultboolCC—RAutomatically sets to trueif the merchant has onlyspecified one paymentmethod.SuppressAccountUpdat boolC———A Boolean flagerspecifying whether Forteshould run AccountUpdater* services.* Forte’s Account Updater service automatically updates cardholder account information by exchanging electronic creditcard account updates with existing account databases that are maintained by the card associations. For more information onthis service, contact Customer datetimeBooleanEntryTypeTransactionTypeMerchant IDsStart Date of the rangeEnd Date of the rangeIf set to true, the child merchant IDs will be actionTypeStatusCodeEntryTypeCountConvFeeAmount tringstringstringintdoubledoubledoubleMerchant IDDate SummaryTransaction TypeStatusCodeEntry TypeCountConvenience Fee AmountService Fee AmountTotal AmountThis parameter has not been implementedContinued 2021 CSG Systems International, Inc. and/or its affiliatesConfidential12 P a g e
Object Reference menumField to SearchMethod of ComparisonMethod of SearchString to SearchThe settlement object holds information about transferring the funds from the card issuer’sbank to the acquiring bank, which is your store’s ringdoubledoubleobjectMerchant IDTransaction IDTransaction Settle IDSettle DateResponse CodeCredit Card or eCheckFunding TypeTotal Amount FundedService Fee Amount FundedTransaction ObjectThe transaction object holds the credit card/echeck, billing, and shipping information foran nt onIDUpdatetoDateBillTo o ingdoubledoubledoubleMerchant IDAmountSales Tax AmountConvenience Fee AmountdoubleConvenience Fee PrincipalstringstringstringstringdatetimeDebit or Credit TransactionEntered ByIP AddressTransaction or Trace IDUpdated Date of ingstringstringstringBill to First NameBill to Last NameBill to Company NameBill to AddressBill to Address 2Bill to CityBill to StateBill to Postal CodeBill to Email AddressBill to PhonestringstringstringShip to NameShip to Company NameShip to AddressContinued 2021 CSG Systems International, Inc. and/or its affiliatesConfidential13 P a g e
Object Reference (cont’d)NameTransaction(cont’d)ShipTo stalCodeShiptoFreightAmountDefined tData9LineItemsUser DefinedeCheck temDescriptionCredit Card ingShip to Address 2Ship to CityShip to StateShip to Postal CodeShip to Freight ringstringstringstringstringarraystringConsumer Order IDConsumer IDWallet IDMerchant Data 1Merchant Data 2Merchant Data 3Merchant Data 4Merchant Data 5Merchant Data 6Merchant Data 7Merchant Data 8Merchant Data 9Array of the LineItems objectsUser-defined ngstringstringOrigination DateUpdated DateAttempt NumberAccount Transit Routing NumberAccount TypeCheck NumberEntry Class CodeEntry DescriptionItem DescriptionstringstringstringCard TypeCard Expiration DateCardholder NameAfter the transaction has been submitted, this object holds the transaction ingstringstringstringstringintTransaction or Trace IDLast four digits of the credit card or echeck accountnumberResponse TypeResponse CodeResponse DescriptionStatusAuthorization CodePre-Authorization ResultPre-Authorization CodePre-Authorization DescriptionPre-Authorization Negative ItemsAddress Verification Service ResultMerchant Client ID, if createdContinued 2021 CSG Systems International, Inc. and/or its affiliatesConfidential14 P a g e
Object Reference (cont’d)The TransactionSummary object summarizes the transaction object, highlighting some ofthe more important ngstringstringstringstringdoubledoubleint 2021 CSG Systems International, Inc. and/or its affiliatesMerchant IDMerchant Client IDTransaction or Trace IDStatusDate of TransactionLast four digits of the echeck account or credit cardnumberBill to First NameBill to Last NameBill to Company NameCredit Card TypeDebit or Credit TransactionEntered ByConsumer Order IDConsumer IDWallet IDResponse CodeAuthorization CodeAmount of the transactionAmount of the Convenience Fee Principal, if applicableNumeric Transaction CodeConfidential15 P a g e
Methods ReferenceThis method allows the user to authenticate to the Transaction Service so the user can workwith the Transaction ationAPI Login ID for AuthenticationSecret Key for AuthenticationAn authentication object.Sample Codepublic static TransactionService.Authentication GetTransactionAuthTicket(stringstrAPILoginID, string strKey){TransactionService.Authentication ticket oginID strAPILoginID;ticket.UTCTime DateTime.UtcNow.Ticks.ToString();ticket.TSHash CalculateHMACMD5(ticket.APILoginID " " ticket.UTCTime, strKey.Trim());return ticket;}This method allows the user to authenticate to the Transaction Service so the user can workwith the Transaction API Login ID for AuthenticationSecret Key for AuthenticationAn authentication object.Sample Codepublic static ClientService.Authentication GetClientAuthTicket(string strAPILoginID,string strKey){ClientService.Authentication ticket new ClientService.Authentication();ticket.APILoginID strAPILoginID;ticket.UTCTime DateTime.UtcNow.Ticks.ToString();ticket.TSHash CalculateHMACMD5(ticket.APILoginID " " ticket.UTCTime,strKey.Trim());return ticket;}Continued 2021 CSG Systems International, Inc. and/or its affiliatesConfidential16 P a g e
Methods Reference (cont’d)This method creates a client and sets the client’s status to active thenticationobjectintAuthentication ObjectClient ObjectClient IDSample CodecreateClientprivate void CreateClient(int mid){ClientRecord client new ClientRecord();client.MerchantID MerchantID;client.FirstName "Bob";client.LastName "Smith";//other code describing client omittedtry{using (ClientServiceClient proxy new ClientServiceClient()){int id t(txtID.Text.Trim(),txtKey.Text.Trim()), client);Response.Write("Created Client ID " id.ToString());}}catch (Exception e){Response.Write(e.Message);}}This method updates a client. Note: Deleting a client or updating the client’s status toSuspended will likewise affect the client’s scheduled transactions. Updating the clientstatus from Suspended to Active will not affect the client’s scheduled cation objectClient objectClient IDContinued 2021 CSG Systems International, Inc. and/or its affiliatesConfidential17 P a g e
Methods Reference (cont’d)Sample Codeprivate void UpdateClient(int mid){ClientRecord client new ClientRecord();client.MerchantID MerchantID;client.FirstName "Bob";client.LastName "Smith";updateClient(cont’d)try{using (ClientServiceClient proxy new ClientServiceClient()){int id t(txtID.Text.Trim(),txtKey.Text.Trim()), client);Response.Write("Updated Client ID " id.ToString());}}catch (Exception e){Response.Write(e.Message);}}This method deletes a lientIDReturnAuthenticationintintintAuthentication ObjectMerchant IDClient IDClient IDSample CodedeleteClientprivate void DeleteClient(int ClientID, int mid){try{using (ClientServiceClient proxy new ClientServiceClient()){int id t(txtID.Text.Trim(),txtKey.Text.Trim()), mid, ClientID);Response.Write("Deleted Client ID: " id.ToString());}}catch (Exception e){Response.Write(e.Message);}}Continued 2021 CSG Systems International, Inc. and/or its affiliatesConfidential18 P a g e
Methods Reference (cont’d)This method gets a on ObjectMerchant IDClient IDClientSample CodegetClientcreatePaymentMethodpublic void GetClients(int mid){try{using (ClientServiceClient proxy new ClientServiceClient()){int ClientID txtClientID.Text.Trim().Length 0 ?Convert.ToInt32(txtClientID.Text) : 0;grid.DataSource xtID.Text.Trim(),txtKey.Text.Trim()), mid, ClientID);grid.DataBind();}}catch (Exception e){Response.Write(e.Message);}}This method creates a new PaymentMethod record. Either the credit card or echeckfields must be present, but not both. If the method is created for a valid ClientID and noother payment methods exists for that client, then the isDefault flag will be setautomatically. If successful, the new PaymentMethodID is returned and a fault isreturned on hodReturnAuthenticationobjectintAuthentication objectPayment Method objectPayment Method IDContinued 2021 CSG Systems International, Inc. and/or its affiliatesConfidential19 P a g e
Methods Reference (cont’d)Sample Codeprivate void CreateCCPayment(int ClientID, int mid){PaymentMethod payment new PaymentMethod();payment.AcctHolderName "Bob Smith";payment.CcCardNumber "4111111111111111";payment.CcExpirationDate "201506";payment.CcCardType CcCardType.VISA;payment.Note "Insert Note";payment.ClientID ClientID;payment.MerchantID mid;createPaymentMethod (cont’d)try{using (ClientServiceClient proxy new ClientServiceClient()){int id thTicket(txtID.Text.Trim(),txtKey.Text.Trim()), payment);Response.Write("Created CC Payment Method ID: " id.ToString());}}catch (Exception e){Response.Write(e.Message);}}This method updates an existing PaymentMethod object. Setting the isDefault flagfor a payment method will unset the flag for the previous default (if one existed). A fault isreturned upon failure. Note: The ClientID field may not be tAuthentication objectPayment Method objectPayment Method IDContinued 2021 CSG Systems International, Inc. and/or its affiliatesConfidential20 P a g e
Methods Reference (cont’d)Sample Codeprivate void UpdateCCPayment(int ClientID, int mid){PaymentMethod payment
Merchant Web Services Integration Guide v1.2 Updated September 21, 2015 For the latest Information, visit our website at www.forte.net This document is only for the maintenance of existing integrations. To integrate to the Forte platform using web services, Forte recommends that new merchants use the latest version of Forte's REST API.
2. Merchant Banking 22 - 37 Introduction - Definition - Origin - Merchant Banking in India - Merchant Banks and Commercial Banks - Services of Merchant Banks - Merchant Bankers as Lead Managers - Qualities Required for Merchant Bankers - Guidelines for Merchant Bankers - Merchant Bankers' Commission - Merchant Bankers in the
This Merchant Services Application and Agreement ("MSAA"), along with the Terms and Conditions attached hereto, serves as the Merchant Agreement by and between Forte Payment Systems ("Forte") and the Merchant named above ("Merchant" "you"). A copy of the Terms and Conditions, version number ----- 16.08.06 has been provided to you.
mint payments - virtual terminal & merchant portal user guide 1.0 2 contents chapter 1: merchant portal - logging in 3 chapter 2: merchant portal - home page 6 chapter 3: merchant portal - setting up your company 7 chapter 4: merchant portal - user registration 10 chapter 5: merchant portal - mpos device setup 14 chapter 6: merchant portal - transaction, exporting data, refunds 15
Merchant Banking Definition, Origin, Merchant Banking in India, Merchant Banks, and Commercial Banks, Services of Merchant Banks, Qualities of Merchant Bankers in Market Making Process, Progress of Merchant Banking in India, Problems, Scope of Merchant Banking in India. 12 02 Mutual Funds, Factoring and Forfeiting Mutual Funds
Merchant Services Application and Agreement Version 3-2013 V- eCheck / CC MSAA Page 2 Merchant Information Primary Contact - System Administrator E-mail: Name: E-mail: . TO FORTE HEREUNDER, MERCHANT WILL BE DEEMED TO HAVE ACCEPTED THE MERCHANT SERVICES TERMS & CONDITIONS; 3) All information provided in this MSAA .
Landau Forte Academy QEMS is a member of the family of Academies operated by Landau Forte Charitable Trust. This is an educational charitable trust founded by Martin . Landau and the Forte family over twenty years ago. The Trust expects each of the Academies to provide a Landau . Forte style of education which is distinctive, high quality and
The Merchant using the Gateway's services Acquirer The bank or financial institution used by the Merchant. Customer A customer of the Merchant making a payment etc. Cardholder The person who owns the payment card, normally the Customer. Merchant Account An account on the Gateway mapped to an Acquirer issued account. You/your The Merchant or .
via PHP (PHP Hypertext Preprocessor), a scripting language whose primary focus is to manipulate HTML for a webpage on the server before it is delivered to a client’s machine. A user can submit queries to a database via PHP, allowing insertion, retrieval and manipulation of information into/from the database. Databases: MySQL introduction 9 IT Learning Programme 2 Installation Guide to use .
