Documentation

Direct Carrier Billing

PFI (PayForIt)/Carrier payment is a direct method to get fast payments via mobile carrier. All subscriber acquisition and billing is done by the DCB provider.

User Flow

  1. method via S2S POST request.
  2. Get the PFI-URL as response from /api/dcb/init request.
  3. Redirect users browser to the PFI-URL received

Depending on if the user is connected to 3G/4G or WiFi one of the two flows will occur. (see example images below)

Initiate Request

POST https://gateway.mobivate.com/api/dcb/init
DATA: account_id=<account_id>&api_key=<api_key>&source=<shortcode>&service_id=<service_id>&return=https://<clients site>¬ification=http://<clients s2s endpoint>

Upon successful call you will get http 200 response with url that the visitor should be redirected to.

Parameters

ParameterFormatDescription
sourceNumberService Number / Shortcode. This is provided to you upon provisioning your service with one of our account managers.
account_idStringYour account identification. This is provided to you upon provisioning your service with one of our account managers.
api_keyStringYour secret api key. This is provided to you upon provisioning your service with one of our account managers.
service_idStringIdentification of the product/service on the payment partner. This is provided to you upon provisioning your service with one of our account managers.
referenceStringYour specified reference identification of this transaction
returnURL

Notifications

You also need to implement the API where HTTP POSTs would be sent whenever there is a successful billing on the subscriber. It is a standard HTTP form post, that contains parameters:

ParameterDescription
event“BILLED” if successful
msisdn(Optional) The MSISDN of the user if it could be retrieved

User Flow on 3G/4G

First screen the user will see when you redirect them to the HTTP URL received is:

www.mobivate.com_docs_img_pfi-3g-init.jpg

If the user accepts, the next screen will be:

www.mobivate.com_docs_img_pfi-3g-confirm.jpg

And if the user accepts again, he will get subscribed and the next screen will be:

User Flow on WiFi

First screen the user will see when you redirect them to the HTTP URL received is:

When the user enters his or her mobile number, the next screen will ask them to confirm a PIN message

At the same time the user will receive the following message:

www.mobivate.com_docs_img_pfi-sms-pin.jpg

Unsubscribe

It is also possible to programmaticaly unsubscribe from the list.

use endpoint https://gateway.mobivate.com/pfi/unsubscribe/ using POST params:

ParameterFormatDescription
account_idStringYour account identification. This is provided to you upon provisioning your service with one of our account managers.
api_keyStringYour secret api key. This is provided to you upon provisioning your service with one of our account managers.
service_idStringIdentification of the product/service on the payment partner. This is provided to you upon provisioning your service with one of our account managers.
msisdnNumberthe msisdn to unsubscribe
transaction_idNumberthe original tId/group that was sent upon subscription

If you have successfully unsubscribed the user the response will be:

{“ok”:true}

If the request was unsuccessful then you will receive:

{“ok”:false}