The Mobipaid API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

You can use the Mobipaid API in test/development mode, which does not affect your live data or interact with the banking networks. The URL and API key you use to authenticate the request determines whether the request is live mode or test mode.

The Mobipaid API uses API keys to authenticate requests. You can view and manage your API keys in the Mobipaid Developer Dashboard.

Every application have two access keys in place, development mode and production mode

Development mode specifications:

• The URL is https://test.mobipaid.io/.
• Access key have the prefix mp_test_.

Production mode specifications:

1. The URL is https://live.mobipaid.io/.
2. Access key have the prefix mp_live_.
3. Connect your application with a merchant.
4. Change your status application to Published.
5. Merchant have to enable your application on their dashboard.

Your Access keys carry many privileges, so be sure to keep them secure! Do not share your access API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Authentication to the API is performed via HTTP Bearer Auth. Provide your Access key as the bearer auth value.

This is the example with CURL.

curl -X GET https://test.mobipaid.io/v2/payments -H "Authorization: Bearer mp_test_w3Lwv3CZIZzye4cYxxr0"

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

Request a payment to your customer email or mobile number with this feature. We will send invoice to the customer automatically.

We support Credit Card, Direct Debit, Paypal, Apple Pay, Google Pay, Nedbank, American Express, etc. With mobipaid wallet in place, customer can pay quickly with payment options that has been saved.

This payment request is intended for one time payment.

Create a new single payment request.

Body Params

Required Header:

• Authorization

You can update the payment request by using the same parameters from create a payment request, but you have to add transaction_id to the body.

Required Header:

• Authorization

You can fetch a single payment request by using the GET method with a transaction_id in the route parameter.

Required Header:

• Authorization

You can delete a single payment request by using the DELETE method with a transaction_id in the route parameter.

Please note that you will not be allowed to delete a transaction that already has a payment history.

Required Header:

• Authorization

The payment response is sent via the payment response URL that you provided in your payment request.We send a JSON response in a POST parameter called response.On your payment response provided URL you will need to check for a post parameter called response and read the JSON payload contained within the post variable.

Two possible result codes of NOK for failure in the payment attempt and ACK for a successful payment.

Sample payment response

response {
    "result": "ACK",
    "token": "9b6352ab516a043cd33cf65cf8210af35bd4d3c9",
    "transaction_id": "211PO",
    "payment_id": "8ac7a4a074726760017472b283ce070f",
    "amount": "50.33",
    "currency": "USD",
    "currency_symbol": "$",
    "result_code": "000.100.110",
    "result_description": "Request successfully processed in 'Merchant in Integrator Test Mode'",
    "additional_info_text": {
        "Type": "baju baru"
    },
    "additional_info_dropdown": {
        "Size": "M"
    },
    "cart_items": "[{\"sku\":\"123\",\"name\":\"Blue Shirt XL\",\"qty\":1,\"unit_price\":11.2},{\"sku\":\"456\",\"name\":\"Black Short Pant XL\",\"qty\":2,\"unit_price\":22.4}]"
}

Fetch your payment history from Mobipaid in order to show how many payments have been done through our application.

Our payment history API support fetching payment history and refund a paid transaction

You can get a list of payment history using our GET method.

Here are the available query string parameters to help you fetch the right payment history:

Fetch a single payment history from Mobipaid

You can use the same GET method like in Payment History, but you have to add payment_id in the route parameter.

Refund a paid payment history from Mobipaid. You have to include the payment_id of the payment history you want to refund.

Body Params

Capture a pre-authorization payment. You have to include the payment_id of the payment history you want to capture.

Body Params

Cancel a subscription that is already paid in the payment history with type scheduled. You have to include the payment_id of the scheduled payment in the payment history in order to cancel it.

Create a POS payment link with this feature.

We support Credit Card, Direct Debit, Paypal, Apple Pay, Google Pay, Nedbank, etc. With mobipaid wallet in place, customer can pay quickly with payment options that has been saved.

You can create one POS link for many payments.

Create a POS payment link for the merchant. One merchant can only have one POS link.

Body Params

Update an existing POS payment link for the merchant.

Body Params

Get existing POS link for the connected merchant.

Generate a POS link with pre-filled parameters for the connected merchant.
* You need to create POS Link before run this request

Body Params

The payment response is sent via the payment response URL that you provided in your payment request.We send a JSON response in a POST parameter called response.On your payment response provided URL you will need to check for a post parameter called response and read the JSON payload contained within the post variable.

Two possible result codes of NOK for failure in the payment attempt and ACK for a successful payment.

Sample payment response

response {
    "result": "ACK",
    "token": "9b6352ab516a043cd33cf65cf8210af35bd4d3c9",
    "transaction_id": "211PO",
    "payment_id": "8ac7a4a074726760017472b283ce070f",
    "amount": "50.33",
    "currency": "USD",
    "currency_symbol": "$",
    "result_code": "000.100.110",
    "result_description": "Request successfully processed in 'Merchant in Integrator Test Mode'",
    "additional_info_text": {
        "Type": "baju baru"
    },
    "additional_info_dropdown": {
        "Size": "M"
    },
    "cart_items": "[{\"sku\":\"123\",\"name\":\"Blue Shirt XL\",\"qty\":1,\"unit_price\":11.2},{\"sku\":\"456\",\"name\":\"Black Short Pant XL\",\"qty\":2,\"unit_price\":22.4}]"
}

Create new message template for SMS and Email with this feature.

We support Credit Card, Direct Debit, Paypal, Apple Pay, Google Pay, Nedbank, etc. With mobipaid wallet in place, customer can pay quickly with payment options that has been saved.

You can create message template based on transaction type.

Create a new message template for the merchant.

Body Params

You can update the message template by using the same parameters from create a message template, but you have to add template_id to the body.

Required Header:

• Authorization

You can fetch a message template detail by using GET method with a template_id in the route parameter

Required Header:

• Authorization

You can delete a message template by using the DELETE method with a template_id in the route parameter.

Required Header:

• Authorization

You can get, create, edit and delete customer with this feature.

Create a new customer for the merchant.

Body Params

You can update the customer by using the same parameters from create a customer, but you have to add customer_id to the body.

Required Header:

• Authorization

You can fetch a customer detail by using GET method with a customer_id in the route parameter

Required Header:

• Authorization

You can delete a customer by using the DELETE method with a customer_id in the route parameter.

Required Header:

• Authorization

You can get, create, edit and delete customer group with this feature.

Create a new customer group for the customer.

Body Params

You can update the customer group by using the same parameters from create a customer group, but you have to add customer_group_id to the body.

Required Header:

• Authorization

You can fetch a customer group detail by using GET method with a customer_group_id in the route parameter

Required Header:

• Authorization

You can delete a customer group by using the DELETE method with a customer_group_id in the route parameter.

Required Header:

• Authorization

The application management API provides api requests for your created applications in
developer portal along with merchant management functions.

To access this API, you need a special access key with the prefix mp_app_. You can get this
access key in your users_profile page in developer portal once you login. Authentication to
the API is performed via HTTP Bearer Auth. Provide your Access key as the bearer auth
value.

The get all apps route provides the developer with a list of all applications under the
developer identified by his/her access token. You will be able to retrieve a full list of
applications in the api route.

Get the details of one app based on app_id, containing a list of merchants connected to it along with his/her access key to your applications.

Create a new application in the developer portal.

Body Params

This request has the same body structure as the Create New Application endpoint. The difference is the addition of url parameter app_id this is the unique identifier for your application that you have created and require to be edited.

This request provides application status given app_id in the url parameter. The available status is deleted, drafted, published, and suspended.

Draft - Status is not yet published on production developer is required to update the status from draft for production implementation.

Deleted - The application has been removed from the merchants , the application is no longer able to be accessed from merchants.

Published - The application is published for production from the developer.

Suspended - The application is suspended from usage , there is a temporary suspension placed on your application no merchants will be able to get access to your application or be able to use your application.

Modify status of application into Draft, Deleted, Published, and Suspended given the app_id in url parameter.

Draft - Status is not yet published on production developer is required to update the status from draft for production implementation.

Deleted - The application has been removed from the merchants , the application is no longer able to be accessed from merchants.

Published - The application is published for production from the developer.

Suspended - The application is suspended from usage , there is a temporary suspension placed on your application no merchants will be able to get access to your application or be able to use your application.

This requests a return token that can be used by the merchant to connect to the application, by the given app_id in the url parameter.

Please keep in mind that the token will only be returned if the developer already has agreed to the eula in that specific application. Otherwise, the application can't access messages returned.

This request returns the details of the merchant connected to the application, given the app_id and merchant_id in the request.

Disconnect the merchant from application. It will disconnect automatically from developer's side and merchant's side, given the merchant_id and app_id in the url parameters.