API Reference

Create Online Checkout Redirect

post
https://{env}.gsg.tech/api/v1/pay/carts

The Online Cart Creation request will be used to build the subsequent cart in the redirect / checkout page. The cart response will indicate the URL the user should be directed to in order to complete the transaction.

Body Params
items
array of objects
required
length ≥ 1

Array of the items to be checked out during the cart transaction. At least one item must be provided to complete checkout.

items*
string
required
length ≥ 6

Unique identifier for the item in the cart provided by caller. This identifier should ideally be used to uniquely identify the item in question in the system of record.

meta
object

A hash of meta information about the parent object (payment, item, etc) which is passed in by the API client to be attached to the object in question for later use by the client, but generally not used by GSG services.

limitTenders
array of objects

List of tender types to limit to allowing payment from for the given item.

limitTenders
string

The type of item, or business category, to which the item belongs. GSG will provide the necessary value(s) for this field.

This field is primarily used in reporting to differentiate items of one type from another.

string
required
length ≥ 3

A short descriptive title of the item as the user would expect to see it, or as it would be represented on a report of the items paid for.

string
required
length ≥ 4

The primary amount (before fees) to be paid on the item.

All currency values:

  • Must have at least one digit before the decimal
  • Exactly 2 digits after the decimal
  • No thousands separator
  • No currency symbol
  • Double quotes surrounding the value will be ignored

Examples: "0.01", "1.20", "1234.01"

string

The department code for/from which this item should be charged. Optional.

string
required
length ≥ 3

The "funding category" that the money collected for this item should be routed to the client via.

billingInfo
object

Billing information for the customer completing the checkout transaction. This information pre-fills the fields for the cashier/user in the cart, but can be further amended by the checkout process, and as such the fields within are not required.

request
object
required

Basic information about the request being made to create a cart.

Responses

Updated 7 months ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago