Businesses API

Businesses API

QuickStream uses a business to store business rules and assist data segregation. Your facility has one or more businesses. Usually, a business in QuickStream represents an actual business or company. A business can:

  • accept credit card transactions for different card schemes
  • apply credit card surcharges
  • settle funds to merchant or direct entry facilities
  • segregate reporting, data and users.

Use this resource to:

  1. List and retrieve businesses.
  2. List and retrieve accepted credit card types and surcharge rates for a business.
  3. Query the surcharge rate for a card.

Get

Get the business, contact and address details of a business.

Request

GET /businesses/{supplierBusinessCode}

Use your Secret API key to access this resource.

Path parameters

Parameter Name Format Description
supplierBusinessCode string The code that uniquely identifies your business.

Request body

None.

Response

If successful, this method returns a Business Model in the response body.

HTTP status codes

See HTTP Status Codes for more.

Status Code Description More information
200 OK The request has succeeded.
404 NOT FOUND The supplierBusinessCode path parameter may be incorrect. View more.
401 UNAUTHORIZED The secret API key in the request is expired, or you have used your Publishable API key instead of your Secret API key. View more.

List

List all the businesses in your QuickStream facility.

Request

GET /businesses

Use your Secret API key to access this resource.

Request body

None.

Response

This is a paginated resource.

Field Format Description
links Array of Links Links to related documents and resources.
data Array of Business Model A paginated list of businesses.

HTTP status codes

See HTTP Status Codes for more.

Status Code Description More information
200 OK The request has succeeded.
401 UNAUTHORIZED The secret API key in the request is expired, or you have used your Publishable API key instead of your Secret API key. View more.

List accepted cards

Use this resource to list the credit card schemes you accept. To retrieve surcharge rates you can use the list-card-surcharges resource.

Request

GET /businesses/{supplierBusinessCode}/accepted-cards

Use your Secret API key or Publishable API key to access this resource.

Path parameters

Parameter Name Format Description
supplierBusinessCode string The code that uniquely identifies your business.

Request body

None.

Response

If successful, this method returns the following in the response body.

Field Format Description
links Array of Links Links to related documents and resources.
data Array of Card Scheme Model A list of accepted credit card schemes.

For example:

{
  "links": [],
  "data": [
    {
      "links": [],
      "cardScheme": "VISA"
    },
    {
      "links": [],
      "cardScheme": "MASTERCARD"
    },
    {
      "links": [],
      "cardScheme": "AMEX"
    },
    {
      "links": [],
      "cardScheme": "DINERS"
    },
    {
      "links": [],
      "cardScheme": "UNIONPAY"
    }
  ]
}

HTTP status codes

See HTTP Status Codes for more.

Status Code Description More information
200 OK The request has succeeded.
404 NOT FOUND The supplierBusinessCode path parameter may be incorrect. View more.

List card surcharges

Use this resource to list the credit card schemes and types you accept and their surcharge rates.

See the surcharging section for more information on how surcharges are processed.

Request

GET /businesses/{supplierBusinessCode}/card-surcharges

Use your Secret API key or Publishable API key to access this resource.

Path parameters

Parameter Name Format Description
supplierBusinessCode string The code that uniquely identifies your business.

Request body

None.

Response

If successful, this method returns the following in the response body.

Field Format Description
links Array of Links Links to related documents and resources.
data Array of Card Surcharge Model A list of accepted credit card schemes and their surcharges.

For example:

{
  "links": [],
  "data": [
    {
      "links": [],
      "cardScheme": "VISA",
      "cardType": "CREDIT",
      "surchargePercentage": "0.400"
    },
    {
      "links": [],
      "cardScheme": "VISA",
      "cardType": "DEBIT",
      "surchargePercentage": "0.125"
    },
    {
      "links": [],
      "cardScheme": "MASTERCARD",
      "cardType": "CREDIT",
      "surchargePercentage": "0.400"
    },
    {
      "links": [],
      "cardScheme": "MASTERCARD",
      "cardType": "DEBIT",
      "surchargePercentage": "0.125"
    },
    {
      "links": [],
      "cardScheme": "AMEX",
      "cardType": "CREDIT",
      "surchargePercentage": "0.300"
    },
    {
      "links": [],
      "cardScheme": "DINERS",
      "cardType": "CREDIT",
      "surchargePercentage": "0.200"
    },
    {
      "links": [],
      "cardScheme": "UNIONPAY",
      "cardType": "CREDIT",
      "surchargePercentage": "0.100"
    }
  ]
}

HTTP status codes

See HTTP Status Codes for more.

Status Code Description More information
200 OK The request has succeeded.
404 NOT FOUND The supplierBusinessCode path parameter may be incorrect. View more.

Query card surcharge

Use this resource to query the surcharge to be applied to a card, along with the card's scheme (Visa, Mastercard, etc.) and type (Credit or Debit).

See the surcharging section for more information on how surcharges are processed.

Request

POST /businesses/{supplierBusinessCode}/query-card-surcharge

Use your Publishable API key to access this resource.

Path parameters

Parameter Name Format Description
supplierBusinessCode string The code that uniquely identifies your business.

Request body

Field Format Description
cardNumber string The card number for which to query the surcharge details.

Response

If successful, this method returns a Card Surcharge Model in the response body.

HTTP status codes

See HTTP Status Codes for more.

Status Code Description More information
200 OK The request has succeeded.
404 NOT FOUND The supplierBusinessCode path parameter may be incorrect. View more.
422 UNPROCESSABLE ENTITY The cardNumber parameter contained invalid data. Refer to errors in the response body for more. View more

Surcharging

QuickStream can apply surcharges to credit card payments on your behalf. Each business in your facility can have different accepted cards and surcharges.

To process payments, send the principal amount. QuickStream calculates the surcharge amount. The customer pays the principal plus surcharge.

You receive settlement for the full payment amount.

If you decide to impose a surcharge, you must ensure your customers are aware - before they enter into the transaction or contract - that a surcharge will apply and the amount of the surcharge.

QuickStream does not calculate a surcharge for bank account payments.

To set your surcharge rates:

  1. Sign-in to QuickStream Portal
  2. Click on Administration -> Business Settings.
  3. Search for your business.
  4. Update the surcharge rates for the credit card types accepted by the business.

Business model

Field Format Description
links Array of Links Links to related documents and resources.
supplierBusinessName string Name of business.
supplierBusinessCode string Uniquely identifies your business.
registeredName string Registered business or company name.
abn string Australian Business Number (ABN) or other business number.
contactName string Contact name for an individual or group in your business.
contactEmail string Contact email address of your business.
contactPhone string Contact phone number of your business.
customerNotificationEmail string Email address used for communication with your customers.
businessAddress Address Model Address of business.

For example:

{
    "links": [],
    "supplierBusinessName": "My Company",
    "supplierBusinessCode": "MYCOMPANY",
    "registeredName": "My Company Pty. Ltd.",
    "abn": "123 456 789",
    "contactName": "Finance Department",
    "contactEmail": "finance@mycompany.com",
    "contactPhone": "02 1234 5678",
    "customerNotificationEmail": "sales@mycompany.com",
    "businessAddress": {
        "country": "Australia",
        "street1": "Level 1, Shop 13",
        "street2": "York Street",
        "city": "Devonport",
        "state": "TAS",
        "postcode": "2100"
    }
}

To change these details:

  1. Sign-in to QuickStream Portal.
  2. Click on Administration -> Business Settings.
  3. Search for your business.
  4. Click on Change Business and Contact Details.

Address model

Field Format Description
street1 string Line 1 of the address.
street2 string Line 2 of the address.
street3 string Line 3 of the address.
city string The city or suburb.
state string The state code.
postcode string The postal or zip code.
country string The two character ISO country code.

For example:

{
    "street1": "Level 1, Shop 13",
    "street2": "York Street",
    "city": "Devonport",
    "state": "TAS",
    "postcode": "2100",
    "country": "AU"
}

Card scheme model

Field Format Description
cardScheme string The card scheme. One of VISA, MASTERCARD, AMEX, DINERS, JCB, UNIONPAY.

For example:

{
  "links": [],
  "cardScheme": "VISA"
}

Card surcharge model

Field Format Description
cardScheme string The card scheme. One of VISA, MASTERCARD, AMEX, DINERS, JCB, UNIONPAY.
cardType string The card type. One of CREDIT, DEBIT.
surchargePercentage string Percentage added to payments for the credit card type.

For example:

{
  "links": [],
  "cardScheme": "VISA",
  "cardType": "CREDIT",
  "surchargePercentage": "0.400"
}