API Documentation
Authorization Any request made without the authorization key (secret key) will fail with a 401
(Unauthorized)
response code.
The authorization key is sent via the request header as Bearer Token Authorization
Example: Authorization: Bearer sandbox_sk_94f2b798466408ef4d19e848ee1a4d1a3e93f104046f
Get all Transactions
This API allows you get all your SquadPOS transactions
Allows you get all your Squad POS transactions
GET
https://sandbox-api-d.squadco.com/softpos/transactions?perPage&page
Query Parameters
Name | Type | Description |
---|---|---|
perPage* | Integer | Number of transactions per page |
page* | Integer | page number |
date_from | date | Format : YYYY-MM-DD Start Date |
date_to | date | Format : YYYY-MM-DD End Date |
sort_by | String | Sorting Parameter. This can have a value of "createdAt" |
sort_by_dir | String | This arranges the transactions in ascending or descending order. possible values are "ASC" - ascending order "DESC" - descending order |
Create Terminal
This API allows yopu create multiple SquadPOS terminals which are associated to your squad account
POST
https://sandbox-api-d.squadco.com/softpos/terminal
Headers
Name | Type | Description |
---|---|---|
content-type* | String | application/json |
Request Body
Name | Type | Description |
---|---|---|
email* | String | unique email to be associated to the terminal being created |
name* | String | Name to be associated to the terminal |
phone* | String | 11 digit phone number to be associated to the terminal |
location_id* | Integer | unique ID that identifies a particular location |
Sample Request
Get all Terminals
This API allows you see all SquadPOS terminals created and associated to your account.
GET
https://sandbox-api-d.squadco.com/softpos/terminals
Query Parameters
Name | Type | Description |
---|---|---|
location_id | Integer | an ID that identifies a location |
page* | Integer | Page Number |
perPage* | Integer | Number of results per page |
sort_by | String | Sorting Parameter. This can have a value of "createdAt" |
sort_by_dir | String | This arranges the transactions in ascending or descending order. possible values are "ASC" - ascending order "DESC" - descending order |
date_from | date | Format : YYYY-MM-DD Start Date |
date_to | date | Format : YYYY-MM-DD End Date |
active | Boolean | It takes a value of "True" or "False" |
GO LIVE - Production
To Use this API on production:
Kindly change the base URL of the endpoint from sandbox-api-d.squadco.com to api-d.squadco.com
Get production keys from your production environment on dashboard.squadco.com and replace as authorization keys.
Last updated