...
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. Parties that share the fees are:
...
OnePipe
...
Host client
...
Provider
...
Settlement & fees model
Model | How it works |
|---|---|
Invoice | The host client will invoice the calling app periodically for all calls to the endpoint, debit the beneficiary account of the app for service used and share with OnePipe, host, provider and ISO |
...
INTERFACE SPECIFICATION (APP → ONEPIPE)
Request (Transact)
| Code Block | ||
|---|---|---|
| ||
{
"request_ref":"{{request_ref}}",
"request_type":"get_accounts_max",
"auth": {
"type": "bank.account | card | wallet | null",
"secure": "{{encrypted_secure}}",
"auth_provider": "Beeceptor",
"route_mode": null
},
"transaction": {
"mock_mode": "live",
"transaction_ref": "{{transaction_ref}}",
"transaction_desc": "A random transaction",
"transaction_ref_parent": null,
"amount": 0,
"customer":{
"customer_ref": "{{customer_id}}", //the customer ref to lookup
"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
}
} |
Response (when otp_override = false)
| Code Block | ||
|---|---|---|
| ||
{
"status": "WaitingForOTP",
"message": "Please enter the OTP sent to 2348022****08",
"data": {
"provider_response_code": "900T0",
"provider": "Beeceptor",
"errors": null,
"error": null,
"provider_response": null
}
} |
Response (when otp_override = true)
| Code Block | ||
|---|---|---|
| ||
{
"status": "Successful",
"message": "Transaction processed successfully",
"data": {
"provider_response_code": "00",
"provider": "Beeceptor",
"errors": null,
"error": null,
"provider_response": {
"accounts": [
{
"account_number": "00999999000",
"account_name": "Ola Waheed",
"bank_name": "FBN",
"bank_code": "011",
"extended_data{
"a_key": "a_value
}
},
{
"account_number": "0099999000",
"account_name": "Ola Waheed",
"bank_name": "FBN",
"bank_code": "011",
"extended_data{
"a_key": "a_value
}
}
],
"meta": null
}
}
} |
Request (validate with otp)
| Code Block | ||
|---|---|---|
| ||
{
"request_ref":"{{request_ref}}",
"request_type":"get_accounts_max",
"auth": {
"secure": "{{encrypted_otp}}",
"auth_provider": "Beeceptor"
},
"transaction": {
"transaction_ref": "70713093460718"
}
} |
Request Payload Description
...
Field
...
Type
...
Requirement
...
Description
...
request_ref
...
string
...
compulsory
...
Takes unique value for every request made to OnePipe
...
request_type
...
string
...
compulsory
...
This should be set to the service get_accounts_min
...
auth.type
...
string
...
compulsory | optional
...
This can be set to card, wallet, bank.account . It applies only if the source is a card (or other sensitive info).
...
auth.secure
...
string
...
compulsory | optional
...
Depending on the provider & sensitivity of data. This is the encrypted value of the source. It can be either card details, token or wallet details. See details on how to encrypt the secure field.
...
auth.provider
...
string
...
compulsory
...
This should be set to the name of the Provider
...
auth.route_mode
...
string
...
N/A
...
This can be set to null
...
transaction.mock_mode
...
string
...
optional
...
This can be set to either live or inspect. If left as null, value will fall back to the state of the service set on the console.
...
transaction.transaction_desc
...
string
...
optional
...
Description of your transaction
...
transaction.transaction_ref_parent
...
string
...
optional
...
Takes value of a (parent) transaction reference
...
transaction.customer.customer_ref
...
string
...
compulsory
...
Identifier for customer
...
transaction.customer.firstname
...
string
...
optional
...
First name of customer
...
transaction.customer.surname
...
string
...
optional
...
Surname of customer
...
transaction.customer.email
...
string
...
optional
...
Email address of customer
...
transaction.customer.mobile_no
...
string
...
optional
...
Phone number of customer
...
transaction.amount
...
big int
...
compulsory
...
This can be set to 0
...
transaction.transaction_ref
...
string
...
compulsory
...
Takes unique value for every transaction call to OnePipe.
...
transaction.meta
...
object
...
optional
...
Json object of your arbitrary transaction parameters
...
transaction.details
...
object
...
compulsory
...
Holds defined fields peculiar to this service
Breakdown of the details object
For this service, the details object is expected to be null. Any provider specific nuances can be embedded in the meta object
Possible status response codes
For this service, these are the possible responses a client can receive
...
Status
...
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.
INTERFACE SPECIFICATION (ONEPIPE → PROVIDER MICRO SERVICE)
| Info |
|---|
Request payload from OnePipe to the provider microservice comes encrypted, using the Triple DES Algorithm. See details. |
Request (Transact)
| Code Block | ||
|---|---|---|
| ||
{
"request_mode":"transact",
"request_ref":"{{request_ref}}",
"request_type":"get_accounts_max",
"auth": {
"type": "bank.account | card | wallet | null",
"secure": "{{encrypted_secure}}",
"auth_provider": "Beeceptor",
"route_mode": null
},
"transaction": {
"mock_mode": "live",
"transaction_ref": "{{transaction_ref}}",
"transaction_desc": "A random transaction",
"transaction_ref_parent": null,
"amount": 0,
"customer":{
"customer_ref": "{{customer_id}}",
"firstname": "Uju",
"surname": "Usmanu",
"email": "ujuusmanu@gmail.com",
"mobile_no": "234802343132"
},
"meta":{
"a_key":"a_meta_value_1",
"b_key":"a_meta_value_2"
},
"details": null,
"client_info": {
"name": "TrustPay",
"id": null,
"bank_cbn_code": null,
"bank_name": null,
"console_url": null,
"js_background_image": null,
"css_url": null,
"logo_url": "https://trustpay.onepipe.io/img/trustpay_logo_console.png",
"footer_text": "Brought to you by <strong>SunTrust Bank</strong>",
"options": [
"BANK.TRANSFER",
"CARD"
],
"primary_color": "#b37038",
"secondary_color": "#b37038",
"primary_button_color": "#b37038",
"modal_background_color": "linear-gradient(147.44deg, #d8903c 26.99%, #e69921 74.1%)",
"payment_option_color": "rgba(76, 61, 47, 0.08)",
"payment_option_active_color": "rgba(31, 31, 31, 0.25)",
"app_color": "#b37038"
},
"app_info": {
"name": "Victor Motors",
"id": "5cdab3332b7d4100015f0db4",
"beneficiary_account_no": "0001137069",
"extras": {/*this will contain an array of provider override settings*/}
}
}
} |
Response (when otp_override = false)
Set provider_response_code to 900T0
| Code Block | ||
|---|---|---|
| ||
{
"status": "WaitingForOTP",
"message": "Please enter the OTP sent to 2348022****08",
"data": {
"provider_response_code": "10",
"provider": "Beeceptor",
"errors": null,
"error": null,
"provider_response": null
}
} |
Response (when otp_override = true)
| Code Block |
|---|
{
"status": "Successful",
"message": "Transaction processed successfully",
"data": {
"provider_response_code": "00",
"provider": "Beeceptor",
"errors": null,
"error": null,
"provider_response": {
"accounts": [
{
"account_number": "0090000000",
"account_name": "Ola Waheed",
"bank_name": "FBN",
"bank_code": "011",
"extended_data{
"a_key": "a_value
}
},
{
"account_number": "0099999000",
"account_name": "Ola Waheed",
"bank_name": "FBN",
"bank_code": "011",
"extended_data{
"a_key": "a_value
}
}
]
}
}
} |
Request (validate with otp)
| Code Block | ||
|---|---|---|
| ||
{
"request_mode":"validate",
"request_ref":"{{request_ref}}",
"request_type":"get_accounts_mid",
"auth": {
"type": null,
"secure": "{{otp}}",
"auth_provider": "Beeceptor"
},
"transaction": {
"mock_mode": null,
"transaction_ref": "{{transaction_ref}}",
"transaction_desc": null,
"transaction_ref_parent": null,
"amount": 0,
"customer":null,
"meta":null,
"details": null
}
} |
Failed Response
In the case of failure or error, the provider should return failure message in this format (encrypted).
...
Breakdown of the details object
For this service, the details object is expected to be null. Any provider specific nuances can be embedded in the meta object.
Acceptable values for auth.type
card
bank.account
wallet
null
Possible status response codes
For this service, these are the possible responses a client can receive
Status | 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 |
INTERFACE SPECIFICATION (ONEPIPE → PROVIDER MICRO SERVICE)
Read this closely.
Special notes for OTP override
...