Formatting

Here you will see different formatting details useful when you are interacting with our API.

There are some details you should keep in mind when you be interacting with the API. We have prepared a list here so you can learn about each of them.

Data format

We use JSON Standard to receive and return the data with our API. Additionally, all successful (2xx) responses have the following format (with the key data):

JSON

{
  "data": {
    ...
  }
}

Resources ID’s

We use the UUID format for all our resources so we can uniquely identify all of them into a collection. You will find that most of the request will request you some resource ID like a merchant ID or customer ID by example. Also when you create a resource you will get an ID back that you can store on your end to further use and do not lose the reference to that object.

By example: if you use our user creation endpoint, you will receive your created resource with an ID generated by us, by example:

JSON

{
  "data": {
    "cell_phone": "[phone]",
    "email": "[email protected]",
    "email_validated": true,
    "email_verified_at": "2021-12-02T19:34:26.361Z",
    "first_name": "John",
    "id": "8b0d8d3a-d76a-4610-9463-88ac9ebbb9bc", // <-- Here is your id.
    "is_active": true,
    "last_name": "Doe",
    "photo": ""
  }
}

Pagination

Most of our listing services has a pagination feature enabled by default and you can take advantage of it using the pagination parameters: page and per_page.

Sorting

In the same places where the pagination apply you will see two fields more available to sort your data listed, the fields are order_by and order_type. The first indicate the field taken to the sorting and the second indicated whether the sort will be ascending (asc) or descending (desc).

Search filter

In those listings you will be able to filter your data with a Search string. You only need to send that parameter and your data will be compared with all the fields available in the listing.