MobilePay Subscriptions



Subscription providers


Create & Update


Subscription payments

Create & Update


One-off payments

Create & Update







Create & Update

Review & Delete

PDF invoice examples


Release notes


Get Started

API Principles

Error Handling

API Change

🤫 Coming soon

An integration is considered finished when all the elements of the relevant API’s checklist are done

Get started

  1. Read API documentation. You’ll find it in the APIs menu. The API documentation provides insight into the structure of the API and will help you determine the best approach for integration as well as provide details on typical use cases.

  2. Log-in Go to Sandbox developer portal and log in with your credentials.

  3. Create app - My Apps > Create new App to register a new application. IMPORTANT: Please make a note of your Client Secret as you will only see this once! You need to supply the x-ibm-client-id and x-ibm-client-secret when calling the api. You should always store the x-ibm-client-id in a secure location, and never reveal it publicly. If you suspect that the secret key has been compromised, you may reset it immediately by clicking the link on the application details page.

  4. Subscribe to APIs. To implement MobilePay Subscriptions, go to APIs and subscribe to the following APIs:

    • Subscriptions
    • Subscriptions User Simulation

Step 2 - Authentication

Once you have

you can start implementing the OpenID Connect flow. Read more about OpenID Connect and the process here

If you have any questions, please write to

Step 3 - Test

Step 3 - Avoid Integration pitfalls

Third Party integrators

In addition, all Integrators are required to complete the following:

When the integration checklist is completed, notify the MobilePay Developer Support, who will verify the integration, and contact the Integrator.

MobilePay then adds the integrator to the MobilePay Website

Once you have followed the steps above, you are ready to do the self-certification. Click the “I’m ready” button here