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

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.

List

List all the businesses in your QuickStream facility that can accept payments using this API.

Request

GET /businesses

Use your Secret API key to access this resource.

Request body

None.

Response

This is a paginated resource.

HTTP status codes

See HTTP Status Codes for 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

Request body

None.

Response

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

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.

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

Request body

None.

Response

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

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.

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 or Secret API key to access this resource.

Path parameters

Request body

Response

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

HTTP status codes

See HTTP Status Codes for 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

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

For example:

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

Card scheme model

For example:

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

Card surcharge model

For example:

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