Authorization

The RoundUp App API uses API keys to authenticate requests. You can view and manage your API keys in the RoundUp at Checkout Dashboard.

Your API keys enable a variety of data requests, so be sure to keep them secure! Never share your secret API keys in publicly accessible areas such as GitHub, client-side code, etc.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Example Header

curl --request GET \
  --url 'https://staging-api.roundupapp.com/api/merchants/institutions?page=1&per_page=10' \
  --header 'Accept: application/json'
  --header 'api-key: f0c558fb-2448-11eb-a770-164b8b0c5e42'

📘

API Keys

We provide both production and development keys. Development keys enable you to test without touching production data. In both environments, some endpoints are only accessible by public keys while others require private keys.