Settlement & fees model
The app will need bla bla bla…Polaris will transfer to the account of the app, less the agreed fees. Polaris will then credit the settlement account of the host client with the collected fees. At settlement, the Host client will debit the agreed fee from the settlement account and split with all relevant parties.
Model | How it works |
|---|---|
Amount | The provider removes a percentage or flat fee from the amount as fee and settles the difference to the app owner (via the client). |
Commission | The provider surcharges the payer with an extra fee and pays a share of that surcharge to the app owner, OnePipe and Client |
Invoice | The client will invoice the calling app periodically for all calls to the endpoint. |
Process flows
Sequence of calls
App of JS calls
/transactwith the right auth detailsProvider responds with
WaitingForOTPorPendingValidationas may be required if not overriddenApp calls
/transact/validateto supply OTP if neededProvider responds with any of the completion codes
SuccessfulorFailed.To query the status of a transaction, the app can call
/transact/queryWhere the provider supports it, the app can call
/transact/reverseto request a reversalTo receive available options for this service, apps can call
/transact/options.
| Gliffy | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| imageAttachmentId | att32243723 | baseUrl | https://onepipe.atlassian.net/wiki|||||||||
|
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 |
custom | Takes a unique transaction ref. This mode is for when OnePipe.js or some other UI processes the payment and passes in a ref for validation of the payment. | ||
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. |
...
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 |
Special notes
This should be seen as a standard payments service. All providers are required to execute settlement per agreed contracts to the account designated by the client bankis effectively Polaris bank forcing an NIP (or local transfer) out of the customer’s account into the app owner’s account. At the same time, the provider fires a second transaction to put the fees into the settlement account of Polaris.