...
| Gliffy | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
INTERFACE SPECIFICATION (APP → ONEPIPE)
Request (Transact)
| Code Block | ||
|---|---|---|
| ||
{
"request_ref":"{{request_ref}}",
"request_type":"lookup_account_min",
"auth": {
"type": null,
"secure": null,
"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": {
"account_number":"23632626327",
"otp_override": true
}
}
} |
Response (when otp_override = false)
| 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": {
"customer_id": "007935125",
"account_name": "BOLA SALAMI",
"last_name": "SALAMI",
"middle_name": "-",
"first_name": "BOLA"
}
}
} |
Request (validate with otp)
| Code Block | ||
|---|---|---|
| ||
{
"request_ref":"{{request_ref}}",
"request_type":"lookup_bvn_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 |
auth.type | string | N/A | This can be set to |
auth.secure | string | N/A | This can be set to |
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 |
transaction.mock_mode | string | optional | This can be set to either |
transaction.transaction_desc | string | optional | Description of your transaction |
transaction.transaction_ref_parent | string | optional | Takes the 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 | The email address of the customer |
transaction.customer.mobile_no | string | optional | Phone number of customer |
transaction.amount | big int | compulsory | This can be set to |
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 will have the following:
Field | Type | Requirement | Description |
|---|---|---|---|
account_number | string | compulsory | Customer account number to lookup |
otp_override | boolean | optional | Defaults to |
Possible status response codes
For this service, these are the possible responses a client can receive
...
| 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":"lookup_account_min",
"auth": {
"type": null,
"secure": null,
"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": {
"account_number":"23632626327",
"otp_override": true
},
"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.ACCOUNT",
"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": {
"customer_id": "007935125",
"account_name": "BOLA SALAMI",
"last_name": "SALAMI",
"middle_name": "-",
"first_name": "BOLA"
}
}
} |
Failed Response
In the case of failure or error, the provider should return failure message in this format (encrypted).
...