Skip to main content

Intro

The API allows the developer to acquire products for customers.

Performing product acquire

API permission
Performing acquire operation requires to have `ACQUIRE` permission. If `ACQUIRE` permission wasn't grant to you, please contact Qrios team.

Fetching available products

To list all products, that you can acquire, send request:
GET /v1/acquire/products
Headers:
X-Client-Id: x97uJ23b
X-Client-Secret: [secret]
HTTP: 200 (OK)
[
    {
        "sku": "1001",
        "operator": "mtn",
        "amount": null,
        "description": "MTN Recharge"
    },
    {
        "sku": "3",
        "operator": "glo",
        "amount": 12.00,
        "description": "Glo data bundle 1GB"
    }
]

As a response you should receive products list. Response contains product list, that you can acquire to customer.

Acquire a product to customer

If you want to acquire `N100` `MTN Recharge` for `2340123456789`, send request
POST /v1/acquire
Headers:
  X-Client-Id: x97uJ23b
  X-Client-Secret: [secret]
  Content-Type: application/json

{
  "operationId": "535bdec5-ea1c-4737-b9e2-04a9743d4227",
  "sku": "1001",
  "acquirerMsisdn": "2340123456789",
  "amount": 100
}
HTTP 202 Accepted
"The request has been accepted for processing, but the processing has not been completed."

operationId - unique operation identifier

sku - stock keeping unit is a distinct type of item for sale

acquirerMsisdn - customer's phone number

amount - product amount. Have to be provided, if amount isn't defined in a product.

Product MTN Recharge sku: 1001 request have to have defined amount, because recharge could be done do N200 as well as N500. For other hand Glo data bundle 1GB have constant price N12, so it amount: 12 have no sense in request.

POST /v1/acquire
Headers:
  X-Client-Id: x97uJ23b
  X-Client-Secret: [secret]
  Content-Type: application/json

{
  "operationId": "535bdec5-ea1c-4737-b9e2-04a9743d4227",
  "sku": "3",
  "acquirerMsisdn": "2340123456789",
  "amount": null
}
HTTP 202 Accepted
"The request has been accepted for processing, but the processing has not been completed."

Acquire request have been accepted. Qrios API is going to proceed with your request, and deliver you result in callback asynchronously.

Checking status of acquire

If you want to manually check the status of the acquire operation, send request:
POST /v1/acquire/status
Headers:
  X-Client-Id: x97uJ23b
  X-Client-Secret: [secret]
  Content-Type: application/json

{
  "operationId": "535bdec5-ea1c-4737-b9e2-04a9743d4227",
}
HTTP 200 (OK)
"success"

Acquire API

Acquire operation API swagger can be found here{: button button--outline button--primary div-right}