...
| Gliffy | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
INTERFACE SPECIFICATION (APP → ONEPIPE)
Request (Transact)
| Code Block | ||
|---|---|---|
| ||
{
"request_ref":"{{request_ref}}",
"request_type":"list_branches",
"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": null
}
} |
...
| Code Block | ||
|---|---|---|
| ||
{
"status": "Successful",
"message": "Transaction processed successfully",
"data": {
"provider_response_code": "00",
"provider": "Beeceptor",
"errors": null,
"error": null,
"provider_response": {
"branches": [
{
"branchebranch_code": "Ikeja Branch355",
"locationbranch_name": "3,BRD AllenSTR AvenueBRANCH",
}, "branch_address1": "51/55 BROAD STREET, ",
{
"name"branch_address2": "Yaba BranchLAGOS",
"locationbranch_address3": "5, HerbertLAGOS Macaulay"
},
] {
} }
} |
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 list_branches
...
auth.type
...
string
...
N/A
...
This can be set to null
...
auth.secure
...
string
...
N/A
...
This can be set to null
...
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
...
"branch_code": "364",
"branch_name": "KIRIKASA BRANCH",
"branch_address1": "1, KIRIKASSAMA ROAD ",
"branch_address2": "MAIDUGURI",
"branch_address3": "BORNO"
}
]
}
}
} |
Request Payload Description
Field | Type | Requirement | Description | |
|---|---|---|---|---|
request_ref | string | compulsory | Identifier for customer | transaction.customer.firstnameTakes unique value for every request made to OnePipe |
request_type | 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 | 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 | |
transactionauth.transaction_refprovider | 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 |
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)
...
| language | json |
|---|
...
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 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 |
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 |
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)
| 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":"list_branches", "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": 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" ], "nameprimary_color": "TrustPay#b37038", "idsecondary_color": null"#b37038", "bankprimary_cbnbutton_codecolor": null"#b37038", "bankmodal_background_namecolor": null "linear-gradient(147.44deg, #d8903c 26.99%, #e69921 74.1%)", "consolepayment_option_urlcolor": null"rgba(76, 61, 47, 0.08)", "jspayment_option_backgroundactive_imagecolor": null"rgba(31, 31, "css_url": null31, 0.25)", "logoapp_urlcolor": "https://trustpay.onepipe.io/img/trustpay_logo_console.png","#b37038" }, "footerapp_textinfo": "Brought{ to you by <strong>SunTrust Bank</strong>", "name": "Victor Motors", "optionsid": ["5cdab3332b7d4100015f0db4", "BANK.TRANSFER", "beneficiary_account_no": "0001137069", "extras": {/*this will contain an "CARD"array of provider override settings*/} ],} } } |
Successful Response
| Code Block |
|---|
{ "primary_colorstatus": "#b37038Successful", "secondary_color"message": "#b37038Transaction processed successfully", "primary_button_colordata": "#b37038",{ "modalprovider_backgroundresponse_colorcode": "linear-gradient(147.44deg, #d8903c 26.99%, #e69921 74.1%)00", "payment_option_colorprovider": "rgba(76, 61, 47, 0.08) "Beeceptor", "payment_option_active_colorerrors": "rgba(31, 31, 31, 0.25)"null, "error": null, "appprovider_colorresponse": "#b37038"{ }, "app_infobranches": { [ "name": "Victor Motors", "id": "5cdab3332b7d4100015f0db4", { "beneficiary_account_no": "0001137069", "extras": {/*this will contain an array of provider override settings*/} "branch_code": "355", } } } |
Successful Response
| Code Block |
|---|
{ "status": "Successful", "messagebranch_name": "TransactionBRD processedSTR successfullyBRANCH", "data": { "provider_response_code": "00",branch_address1": "51/55 BROAD STREET, ", "provider": "Beeceptor", "errorsbranch_address2": null"LAGOS", "error": null, "providerbranch_responseaddress3": { " LAGOS " "branches": [ }, { "branchebranch_code": "Ikeja Branch"364", "locationbranch_name": "3, Allen Avenue"KIRIKASA BRANCH", }, "branch_address1": "1, KIRIKASSAMA ROAD ", { "namebranch_address2": "Yaba BranchMAIDUGURI", "locationbranch_address3": "5, Herbert MacaulayBORNO" } ] } } } |
Failed Response
...