Create Purchase API for In-App/API Flow (Step 1)

post http://{domain}/v1/api/purchase/article

To purchase article use this endpoint to initiate the purchase flow, this API can be accessed with Client Access Token obtained from the response of the Client Access Token API.

How to use:

Fill in Authorization header: Bearer C1234abcde-1234-abcd-1234-abcd1234abcd (Replace with access_token that starts with letter C obtained from response of Client Access Token API request)
(OPTIONAL) Add marketingCampaign details(conversionId, agency, medium...etc) to be relayed back in later notifications and stored in the purchase details.
Fill in the rest of the parameters as per guidelines.

Upon success, You'll receive Purchase Token in the response and OTP will be sent to the user.

Body Params

marketingCampaign

object

Markering campaign information used for the acquisition.

msisdn

string

Defaults to 12341234

Customer's Mobile number.

partnerTransactionId

string

Defaults to test-test-00005

Transaction ID that you want to receive in notification for correlating the request with notification.

paymentType

string

Defaults to DCB

Type of payment, this has to be 'DCB' (case sensitive) always.

price

string

Defaults to 1

Amount that you are trying to charge the customer. This amount is in main currency.

productCategory

string

Defaults to Hago

Category of the product configured for your product, please contact your account manager to receive it.

productDescription

string

Defaults to Hago

Product description configured for your product, please contact your account manager to receive it.

productId

string

Defaults to Hago

Product ID configured for your product, please contact your account manager to receive it.

providerServiceId

string

Defaults to Hago

Service ID configured for your product, please contact your account manager to receive it.

Headers

string

Defaults to application/json

!DO NOT CHANGE OR REMOVE!

Content-Type

string

Defaults to application/json

!DO NOT CHANGE OR REMOVE!

Authorization

string

Defaults to Bearer C570e8d5c-cbbb-4912-b83f-0a0e4aac571

This field is mandatory and should follow the format: Bearer then single space then Client Access Token that starts with letter C (obtained from response of Client Access Token API.)

Responses

Language

Credentials

OAuth2

URL


xxxxxxxxxx
25
1
curl --request POST \
2
     --url http://domain/v1/api/purchase/article \
3
     --header 'Authorization: Bearer C570e8d5c-cbbb-4912-b83f-0a0e4aac571' \
4
     --header 'Content-Type: application/json' \
5
     --header 'accept: application/json' \
6
     --data '
7
{
8
  "marketingCampaign": {
9
    "agency": "agencyName",
10
    "campaignId": "campaignId",
11
    "conversionId": "conversionId",
12
    "medium": "medium",
13
    "name": "name",
14
    "source": "source"
15
  },
16
  "msisdn": "12341234",
17
  "partnerTransactionId": "test-test-00005",
18
  "paymentType": "DCB",
19
  "price": "1",
20
  "productCategory": "Hago",
21
  "productDescription": "Hago",
22
  "productId": "Hago",
23
  "providerServiceId": "Hago"
24
}
25
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

How to use:

200200

401401