...
| Info |
|---|
Before you proceed: Please read this. |
Commercial model
At agreed settlement cycles, the host will debit the configured beneficiary account of the app for the use of this API and share that fee with all participants. Fees will be determined by the provider. A credit notification also implies that a provider already has the monies that belong to the app developer with them and probably need to execute settlement to them at agreed cycles outside of OnePipe.
Special configuration notes
Providers need to support as much configuration as is possible rather that enforce strict payload content.
Settlement & fees model
At the moment, this service only supports one model.
Model | How it works |
|---|---|
Invoice | The client will invoice the calling app periodically for all calls to the endpoint. |
Process flows
Sequence of calls
Setup
All apps that want this services will configure their webhook on OnePipe
A custom webhook designed specifically for the provider is also implemented on OnePipe
Customer presents payments details at a provider’s channel
[optional] Validation
[optional] Provider makes a call to its webhook on OnePipe to pull details of the payment or customer
The provider webhook makes a
transaction_infocall to a OnePipe listener[optional] OnePipe may forward this call above to the app’s webhook in the the form of a
transaction_inforequest
Completion
Provider process the transaction offline
Provider makes a call to its webhook on OnePipe to record the transaction
The provider webhook makes a
payment_fulfillmentcall to a OnePipe listener if this call matches a priortransaction_info. If not, it makes atransaction_notificationcall instead.OnePipe will forward this call above to the app’s webhook in the the form of a
transaction_notificationrequest
| Gliffy | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Interface specification - (Provider Service → OnePipe Listener)
Request (transaction_info)
| Code Block | ||
|---|---|---|
| ||
... |
Response (transaction_info)
| Code Block | ||
|---|---|---|
| ||
... |
Request (payment_fulfilment)
| Code Block | ||
|---|---|---|
| ||
... |
Response (payment_fulfilment)
| Code Block | ||
|---|---|---|
| ||
... |
Request (transaction_notification)
| Code Block | ||
|---|---|---|
| ||
... |
Response (transaction_notification)
| Code Block | ||
|---|---|---|
| ||
... |
Interface specification - (OnePipe Listener → App Webhook)
Request (transaction_info)
| Code Block | ||
|---|---|---|
| ||
... |
Response (transaction_info)
| Code Block | ||
|---|---|---|
| ||
... |
Request (payment_fulfilment)
| Code Block | ||
|---|---|---|
| ||
... |
Response (payment_fulfilment)
| Code Block | ||
|---|---|---|
| ||
... |
Request (transaction_notification)
| Code Block | ||
|---|---|---|
| ||
... |
Response (transaction_notification)
| Code Block | ||
|---|---|---|
| ||
... |
Headers to expect (OnePipe Listener → App Webhook)
Type | Description |
|---|---|
Possible response codes (OnePipe Listener → Provider Service)
For this service, these are the possible responses a provider service can receive
Response code | Meaning |
|---|---|
Special notes for providers
Unlike other services where the app calls OnePipe, in this case, the Provid 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 bank.
...