An integration is considered finished when all the elements of the relevant API’s checklist are done
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.
Log-in Go to Sandbox developer portal and log in with your credentials.
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-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.
Subscribe to APIs. To implement MobilePay Subscriptions, go to APIs and subscribe to the following APIs:
Once you have
redirect_uri(Send an e-mail to firstname.lastname@example.org with your
redirect_uriand we will revert back to you, once it has been whitelisted.
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 email@example.com
We supply a testing API, that simulates user actions in the app.
user-redirect. All proper data comunication and logging and monitoring should be done thorugh callbacks and GET calls.
cancel-redirect. This should result in a timely update of the MobilePay Agreement.
In the table below, you can see the parameter in the Subscriptions API to the corresponding parameter in the Transaction Reporting Api. Please use the table below for correlating transactions between MobilePay Subscriptions and external merchant / integrator system.
|Transaction Reporting API||Subscriptions API||Description|
||Used for correlating transactions between MobilePay & Integrator system.|
||Is included in the subject field, if user sends an email from the MobilePay app|
||Identifier assigned by merchant to a specific payment|
||Includes transaction_id for all payments: recurring, one-off and refund. Visible on the users receipt screen.|
|Transfer Method||Instant Transfer||Daily Transfer|
|TIME OF TRANSFER||MobilePay transfer instantly after the user pays.||MobilePay does transfer once per day, at night. Payments payed on day X will be transferred on day X+1.|
|REFERENCE NUMBER||external_id is used.||Generated by MobilePay|
|BANK STATEMENT||external_id is used.||Generated by MobilePay|
In addition, all Integrators are required to complete the following:
description) and payment screens parameters (
external_id) as well as
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