Properties   Methods   Events   Configuration Settings  

QBMSAuthorize is used to charge credit cards using QuickBooks Merchant Services

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The QBMSAuthorize component is used to authorize credit cards using QuickBooks Merchant Services (QBMS). The QBMSAuthorize component corresponds to the new credit card authorization capability integrated into the QuickBooks Receive Payments and Sales Receipt forms.

Required Connection Fields: ApplicationId, ApplicationLogin, ConnectionTicket, and SessionTicket*.

Additional required fields (Auth and Charge): CardNumber, CardExpMonth. CardExpYear, and TransactionAmount.

* = If using session authentication (on by default)

Supported Methods: AuthorizeCard, ChargeCard, CaptureTransaction (TransactionId, Amount), VoidTransaction (TransactionId), and GetXMLAggregate.

This component is not supported for QuickBooks Online Edition.

The following example shows how to charge or authorize a credit card:

component.ApplicationLogin = "MY_APP_LOGIN" component.ApplicationId = "MY_APP_ID" component.ConnectionTicket = "MY_CONNECTION_TICKET" component.SessionTicket = "MY_SESSION_TICKET" 'When authorizing with a beta application, uncomment the following to use the test servers 'component.Config "QBMSServer=https://merchantaccount.ptc.quickbooks.com/j/AppGateway" 'component.Config "SessionTicketUpdateURL=https://login.ptc.quickbooks.com/j/qbn/sdkapp/connauth" 'component.Config "DTD=http://merchantaccount.ptc.quickbooks.com/dtds/qbmsxml10.dtd" component.CardNumber = "4111111111111111" component.CardExpMonth = "12" component.CardExpYear = "2008" component.TransactionAmount = "203.00" component.StreetAddress = "23 Garcia Ave" component.PostalCode = "94043" component.ChargeCard()

To use the above demo, you will first need to sign up for QuickBooks Merchant Services. You need to acquire the properties ApplicationLogin, ApplicationId, ConnectionTicket, and SessionTicket, before you can accept credit card payments. There are three steps to this process.

Step One:

First, to register with QuickBooks Merchant Services, go to http://appreg.quickbooks.com. You will be given a choice between creating an application for a Production environment or a Beta (ptc) environment for testing purposes. Regardless of which option you choose, follow the instructions and you will receive an ApplicationLogin and ApplicationId. We'll assume for the moment that the values for these two fields are "MY_APP_LOGIN", and "MY_APP_ID" respectively.

Step Two:

Now you must acquire a connection ticket Use the real application id value you received from the previous step, and plug it into the following url instead of "MY_APP_ID".

Step Three:

If session authentication is required, you will also need to acquire a session ticket when you wish to authorize credit cards. (This session ticket will eventually time out and expire). To acquire a session ticket, take the ApplicationId received in Step 1 and plug it into the following url instead of "MY_APP_ID".

You may now process credit cards.

In addition to receiving credit card payments, the results of each transaction may be pushed to quickbooks via the RECEIVEPAYMENT and SALESRECEIPT components. After a successful charge (or a successful authorize followed by a capture), you may call GetXMLAggregate to generate an XML aggregate containing all the relevant information pertaining to the transaction. This aggregate should be passed to the RECEIVEPAYMENT or SALESRECEIPT component's CCAggregate property. You may then submit the Payment or Sales Receipt as you normally would. (Making sure the QBXMLVersion is set to 4.1 or higher). QuickBooks will now show credit card data attached to the payment or sales receipt.

Method List

Event List

Configuration Settings