Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Gliffy
imageAttachmentIdatt256213382
macroId0442e593-a066-4951-9a50-5a2566a249e1
baseUrlhttps://onepipe.atlassian.net/wiki
macroId0442e593-a066-4951-9a50-5a2566a249e1
nameOnePipe 2.0 - Bill payment
diagramAttachmentIdatt255983916
containerId255951176
timestamp1585229595580

...

Code Block
languagejson
{
  "request_ref":"{{request-ref}}", 
  "request_type":"buy_data",
  "auth": {
    "type": "bank.account | card | wallet | airtime | token", 
    "secure": "{{encrypted secure}}",
    "auth_provider": "Beeceptor",
    "route_mode":"provider | options | null"
  },
  "transaction": {
    "mock_mode": "live", 
    "transaction_ref": "{{transaction-ref}}", 
    "transaction_desc": "A random transaction", 
    "transaction_ref_parent": "", 
    "amount": 10000,
    "customer":{
    	"customer_ref": "{{customer id}}", //the unique payment ref with the biller or telco
    	"firstname": "Uju",
   		     "surname": "Usmanu",
    	"email": "ujuusmanu@gmail.com",
    	"mobile_no": "234802343132"
    },
    "meta":{
    	"a_key":"a_meta_value_1",
    	"another_key":"a_meta_value_2"
    },
    "details": {
      "biller_id": "{{code representing the biller}}",
      "biller_item_id": "{{code representing the biller's specific product}}",
      "order_reference": "101638163628490752",//can be null during the options call but mandatory during the /transact
    }
  }
}

...

Code Block
languagejson
{
  "status": "SuccessfulOptionsDelivered",
  "message": "Transaction processed successfully",
  "data": {
    "provider_response_code": "00",
    "provider": "Beeceptor",
    "errors": null,
    "error": null,
    "provider_response": {
      "products": [
        {
          "order_reference": "101638163628490752",
          "biller_item_id": "101638163628490752",          
          "biller_item_code": "RAC01",
          "biller_item_name": "40GB Daily",
          "biller_item_description": "This is 40GB Daily bundle. So lovely",
          "biller_item_image_url": "{{url to an image}}",
          "biller_item_prompt": "Please enter your phone number",
          "customer_name": "Kola Uju Abubakar Premium",
          "biller_item_meta": {}
          "amount": "500000",
          "currency": "566",
          "terms": "{{some HTML content}}",
          "terms_url": "{{some url}}"
        },
        {
          "order_reference": "101638163628490752",
          "biller_item_id": "101638163628490752",
          "biller_item_code": "RAC01",
          "biller_item_name": "40GB Daily",
          "biller_item_description": "This is 40GB Daily bundle. So lovely",
          "biller_item_image_url": "{{url to an image}}",
          "biller_item_prompt": "Please enter your phone number",
          "customer_name": "Kola Uju Abubakar Premium",
          "biller_item_meta": {}
          "amount": "500000",
          "currency": "566",
          "terms": "{{some HTML content}}",
          "terms_url": "{{some url}}"
        }
      ],
      "reference": "000022200225154318222333334432",
      "meta":{
        "field_key":"field_value",
        "field_key":"field_value"
      }
    }
  }
}

Response (/transact)

Code Block
languagejson
{
  "status": "Successful",
  "message": "Transaction processed successfully",
  "data": {
    "provider_response_code": "00",
    "provider": "Beeceptor",
    "errors": null,
    "error": null,
    "provider_response": {
      "reference": "000022200225154318222333334432",
      "payment_status": Successful | Failed | Processing",
      "fulfillment_status": "Succesful | Failed | Processing",
      "transaction_final_amount": 20000,//in kobo
      "transaction_fee": 5000,//in kobo
      "narration": "My narration",
      "reference": "000022200225154318222333334432",
      "meta":{
        "field_key":"field_value",
        "field_key":"field_value"
      }
    }
  }
}

Acceptable values for auth.type

...

Response code

Meaning

Successful

Standard success code

Failed

Standard failure code

WaitingForOTP

To signify that this provider has requested an OTP from the customer and it should be supplied.

PendingValidation

To signify that this provider needs some extra information to be provided. The response.message will contain the prompt.

OptionsDelivered

To determine that options have been delivered on the first call. This should be the response of /transact/options

Breakdown of the details object

...

Interface specification - (OnePipe → Provider)

Read this closely.

Supported Billers

Billers

Onepipe Biller Id

Glo

GLO

MTN

MTN

Airtel

Airtel

9Mobile

9Mobile

IPNX

IPNX

Coolink

Coolink

Tizeti

Tizeti

Smile

Smile

Swift

Swift

Spectranet

Spectranet

Ntel

Ntel