With “With this service, the calling app can request or initiate payment from a customer. Apps will collect authorisation details and forward to OnePipe to execute a debit, OnePipe the underlying provider to generate (and optionally send) an invoice to a customer for a specific payment or service. Apps will pass in the details of the items to be paid for as well as the payer’s details and any authorisation details that may be required. OnePipe will in turn forward to the provider’s dedicated implementation. Providers will support a wide array of payment methods and optionally prompt for any extra auth details specific to their implementationbe required to respond the details of the invoice generated and a link with which the App can access it digitally.

Commercial model

Providers will be required to settle monies collected to a designated account by the client bank, less their fees. The client bank will handle secondary settlement to the apps, less their own fee and OnePipe's.

Special configuration notes

All providers of this service should implement OTP, but support the configuration of otp_override such that based on this configuration, they could be instructed to bypass the OTP requirement for an appcan bill the calling App for every invoice generated.

Settlement & fees model

Depending on the provider implementationAs a result of the commercial model, this service supports any of the 3 modelsonly supports 1 fees model.

...

1. App calls /transact with the right auth details

2. Provider responds with WaitingForOTP or PendingValidation as may be required

3. App calls /transact/validate to supply OTP if needed(or null as the case may be)

4. Provider responds with any of the completion codes Successful or Failed. as may be required

5. To query the status of a transaction, the app can call /transact/query

6. Where the provider supports it, the app can call /transact/reverse to request a reversal

7. To receive available options for this service, apps can call /transact/options.

...

...

Interface specification - (App → OnePipe)

...

{
  "requestre
  quest_ref":"{{request-_ref}}", 
  "request_type":"collectsend_invoice",
  "auth": {
    "type": "bank.accountnull", 
    "secure": "4if1oYEoHx5Kp+PZj6RibJlXbx8zIKkP{{null}}", 
    "auth_provider": "BeeceptorOnePipe",
    "route_mode":"provider | options | null"
  },
  "transaction": {
    "mock_mode": "live", 
    "transaction_ref": "{{transaction-_ref}}", 
    "transaction_desc": "A random transaction", //description that shouldcarry to the invoice
    "transaction_ref_parent": ""null, 
    "amount": 10000,0,//amoun expected to be paid
    "customer":{
    	"customer_ref": "{{customer _id}}",
    	"firstname": "Uju",
        "surname": "Usmanu",
    	"email": "ujuusmanu@gmail.com",//the recipient of the invoice
    	"mobile_no": "234802343132"//the recipient of the invoice
    },
    "meta":{
    	"a_key":"a_meta_value_1",
    	"another_key":"a_meta_value_2"
    },
    "details": {
      "invoice_number": null "00001",//optional. Provider can generate one
  } }

Responses

Successful

{   "statusdue_date": "Successful09-08-2020",
      "messagepage_id": "Transaction{{SMP processedPage successfully",ID}}" //optional.
      "datapayment_items": [
        {
          "provider_responseitem_description": "A big blag bag",
          "item_code": "00ITEM001",
     "provider     "item_amount": 2000000          
        },
        {
          "item_description": "BeeceptorA big blag bag",
      "errors    "item_code": null"ITEM001",
    "error      "item_amount": null 2000000
        }
      ],
      "provider_responsereminders": [
        {
          "provider_auth_token": null,reminder_date": "09-08-2020",
          "reminder_title": "It's been 8 days, pay up!"
          "paymentoptions": []reminder_message": "The quick brown fox jumps over the lazy dog"
        },
        {
          "transactionreminder_final_amountdate": 1000"09-08-2020",
//amount  in kobo       "referencereminder_title": "897465522772655",It's been 8 days, pay up!"
          "metareminder_message": {} "The quick brown fox jumps over the lazy dog"
        }
      ]      
    }
  }
}

...

Responses

{
    "status": "Successful"WaitingForOTP,
| PendingValidation",   "message": "KindlyTransaction enterprocessed thesuccessfully",
OTP sent to 08142*****67",   "data": {
        "provider_response_code": "900TO00",
        "provider": "Beeceptor",
        "errors": null,
        "error": null,
        "provider_response": null {
          } }

Failed

{   "delivery_status": "Failed",delivered | failed | pending",
              "messagecost": "Transaction failed1500",//in kobo
              "datainvoice_number": { "00001",
              "providerdue_response_codedate": "9109-08-2020",
       "provider       "amount_due": "Beeceptor150000",//in kobo
    "errors": null,          "invoice_link": "http://pages.onepipe.io/p/7uL21J"
              "errorreference": null"000022200225154318222333334432",
    "provider_response": null          "meta":{
            }
        }
    }
}

Acceptable values for auth.type

...

Type

...

Description

...

card

...

Takes card details for debit.

...

bank.account

...

Takes bank account details for debit.

...

cash

...

Will simply flag the transaction, as awaiting transaction_notification

...

custom

...

...

voucher

...

Takes a voucher code for debit.

...

airtime

...

Takes MSISDN and debits the airtime on it.

...

wallet

...

Takes a wallet ID for debit.

...

bank.transfer

...

Simply instructs the provider to generate bank transfer instructions.

Possible response codes

For this service, these are the possible responses a client can receive

Breakdown of the details object

For this service, the details object will be set to null

Interface specification - (OnePipe → Provider)

Read this closely.

Special notes for providers

...

.