...

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'sHost clients will simply charge a fee to the calling app, and share it with the provider, OnePipe and ISO.

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 app.

Settlement & fees model

Depending on the provider implementation, this service supports any of the 3 modelsThis service can only support one mode.

Process flows

Sequence of calls

1. Getting consent

   1. App calls /transact with the

   right

   1. relevant auth details

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

   3. App calls /transact/validate to supply OTP

   if needed

   2. Provider responds with any of the completion codes Successful or Failed.

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

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

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

1. 1. If successful, provider also has to respond with a provider_token

2. Placing a hold

   1. App calls /transact with auth.type set to provider_token and passing a prior received token.

   2. Provider responds with any of the completion codes Successful or Failed.

Interface specification - (App → OnePipe)

...

{
  "request_ref":"{{request-ref}}", 
  "request_type":"collecthold_funds",
  "auth": {
    "type": "bank.account", 
    "secure": "4if1oYEoHx5Kp+PZj6RibJlXbx8zIKkPencrypted(bank.account;bankcode)",
    "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}}",
    	"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": null
  }
}

...