Overview
With this service, the calling apps can instruct a provider via OnePipe to validate an OTP supplied by a customer. The added benefit here is that in the event that a provider needs authorization details of the account to debit for the value of the SMS or whatever the transport protocol is (bank account, wallet, etc) this can be supplied to the provider.
| Info |
|---|
Before you proceed: Please read this. |
...
The Provider needs to send a share of income to the settlement account at the host; which will then be shared with OnePipe, host and ISO. Parties that share the fees are:
OnePipe
Host client
ISO
Settlement & fees model
Model | How it works |
|---|---|
Invoice | The host client will invoice the calling app periodically for all calls to the endpoint. |
...
| Gliffy | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
INTERFACE SPECIFICATION (APP → ONEPIPE)
Request (Transact)
| Code Block | ||
|---|---|---|
| ||
{
"request_ref":"{{request_ref}}",
"request_type":"validate_otp",
"auth": {
"type": "bank.account | card | wallet | msisdn",
"secure": "{{encrypted(bank account number | card details | wallet | msisdn)}}", //if payment should be collected realtime, it would be charged here
"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",
"another_key":"a_meta_value_2"
},
"details": {
"reference": "1234567890",
"otp": "123456"
}
}
} |
Response
| Code Block | ||
|---|---|---|
| ||
{
"status": "Successful",
"message": "TransactionOTP processedvalidated successfullycorrectly",
"data": {
"provider_response_code": "00",
"provider": "Beeceptor",
"errors": null,
"error": null,
"provider_response": {
"referencecost": "506176447170071200",
"costreference": "000022200225154318222333334432",
"1200meta":{
} }
} |
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_balance
...
auth.type
...
string
...
compulsory
...
Depending on the source of fund. This can be set to either bank.account, card, token or wallet
...
auth.secure
...
string
...
compulsory
...
This is the encrypted value of the source account. Depending on the auth type, this can be either bank account, 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 is the amount (kobo) to be transferred
...
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
"field_key":"field_value",
"field_key":"field_value"
}
}
}
} |
Breakdown of the details object
For this service, the details object will contain
reference: That must be the reference given by the Provider from a prior
send_otpcallotp: Being the OTP supplied by the user
Acceptable values for auth.type
Value | Description |
|---|---|
card | Takes card details. |
bank.account | Takes bank account. |
wallet | Takes a wallet ID for debit. |
Possible status response codes
For this service, these are the possible responses a client can receive
...
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_ref":"{{request_ref}}",
"request_type":"validate_otp",
"auth": {
"type": "bank.account | card | wallet",
"secure": "{{bank account number | card details | wallet}}",
"auth_provider": "Beeceptor"
},
"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",
"another_key":"a_meta_value_2"
},
"details": {
"reference": "1234567890",
"otp": "123456"
},
"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
| Code Block |
|---|
{
"status": "Successful",
"message": "Transaction processed successfully",
"data": {
"provider_response_code": "00",
"provider": "Beeceptor",
"errors": null,
"error": null,
"provider_response": {
"reference": "50617644717007",
"cost": "1200"
}
}
} |
Failed Response
In the case of failure or error, the provider should return failure message in this format (encrypted).
...
Read this closely.