Consumer guides

In short#

You are a consumer when you subscribe an app to a product and call it through the gateway. The subscription belongs to you or to your organisation, the key belongs to an app, and each app belongs to one environment: Sandbox (the portal calls it Testing) or Production. These guides follow the order you meet things in.

The guides#

Start here if you are new, in this order:

1. From sign-up to your first call: one path from the sign-up form to a response from a product.
2. Your account, your organisation and its members: the profile, KYC and KYB, departments, invitations and roles.
3. Create an app and manage its keys: where the key is, how to add a second one and remove the first.
4. Sandbox and Production: which key and which gateway address belong to which environment.
5. Subscribe an app to a product: platform plans, product plans, approvals, renewal and cancellation.
6. Pay and read your invoices: the card payment, saved cards and what the billing screens show.
7. Quotas and usage: the quotas that stop a call, and where to see usage.
8. Try an endpoint in the playground: send a request from the product page.
9. Errors, status codes and retries: what the gateway answers and when to try again.
10. Events and notifications: what you are told, and how.
11. Get help and open a ticket

Related#

• Authentication: the headers a call carries.
• Glossary: the terms these guides use, in English and Arabic.