...
| 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",
"lastaccount_namenumber": "SALAMI1780161243",
"middlelast_name": "-SALAMI",
"first_name": "BOLA",
"middle_name": "-",
} } } |
Request (validate with otp)
| Code Block | ||
|---|---|---|
| ||
{ "request_refgender":"{{request_ref}} "Female", "request_type":"lookup_bvn_max", "auth": { "secureaccount_currency": "{{encrypted_otp}}NGN", "auth_provider "dob": "Beeceptor1993-04-18T00:00:00" }, } "transaction": { } } |
Request (validate with otp)
| Code Block | ||
|---|---|---|
| ||
{ "request_ref":"{{request_ref}}", "transactionrequest_reftype":"lookup_bvn_max", "70713093460718"auth": { } } |
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 lookup_account_min
...
auth.type
...
string
...
compulsory
...
"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 | compulsory | This can be set to |
auth.secure | string | compulsory | This is the encrypted value of the source of fund. 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 |
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 |
...
Request (Transact)
| Code Block | |||||
|---|---|---|---|---|---|
| {
| ||||
{ "request_mode":"transact", "request_ref":"{{request_ref}}", "request_type":"lookup_account_min", "auth": { "type": "bank.account | card", "secure": "{{decrypted_secure}}", "auth_provider": "Beeceptor", "requestroute_mode":"transact" null }, "request_reftransaction":"{{request_ref}}", { "requestmock_typemode": "lookup_account_minlive", "authtransaction_ref": "{{transaction_ref}}", "typetransaction_desc": "bank.accountA |random cardtransaction", "securetransaction_ref_parent": "{{decrypted_secure}}",null, "auth_provideramount": "Beeceptor"0, "route_modecustomer": null { }, "transactioncustomer_ref": "{{customer_id}}", "mock_modefirstname": "liveUju", "transaction_ref "surname": "{{transaction_ref}}Usmanu", "transaction_descemail": "A random transactionujuusmanu@gmail.com", "transactionmobile_ref_parentno": null,"234802343132" "amount": 0}, "customermeta":{ "customera_refkey": "{{customer_id}}"a_meta_value_1", "firstnameb_key": "Uju","a_meta_value_2" "surname": "Usmanu" }, "emaildetails": "ujuusmanu@gmail.com",{ "mobileotp_nooverride": "234802343132"true }, "metaclient_info": { "a_key "name":"a_meta_value_1 "TrustPay", "b_keyid":"a_meta_value_2" null, }, "detailsbank_cbn_code": null, { "otpbank_overridename": truenull, }, "clientconsole_infourl": {null, "namejs_background_image": "TrustPay"null, "idcss_url": null, "banklogo_cbn_codeurl": null"https://trustpay.onepipe.io/img/trustpay_logo_console.png", "bank_name": nullfooter_text": "Brought to you by <strong>SunTrust Bank</strong>", "console_urloptions": [ null, "js_background_image": null,BANK.ACCOUNT", "css_url": null, "CARD" "logo_url": "https://trustpay.onepipe.io/img/trustpay_logo_console.png" ], "footerprimary_textcolor": "Brought to you by <strong>SunTrust Bank</strong>#b37038", "optionssecondary_color": ["#b37038", "BANK.ACCOUNT"primary_button_color": "#b37038", "CARD" ]"modal_background_color": "linear-gradient(147.44deg, #d8903c 26.99%, #e69921 74.1%)", "primarypayment_option_color": "#b37038rgba(76, 61, 47, 0.08)", "secondarypayment_option_active_color": "#b37038rgba(31, 31, 31, 0.25)", "primary_buttonapp_color": "#b37038", }, "modalapp_background_colorinfo": "linear-gradient(147.44deg, #d8903c 26.99%, #e69921 74.1%)", { "name": "Victor Motors", "payment_option_colorid": "rgba(76, 61, 47, 0.08)", "5cdab3332b7d4100015f0db4", "paymentbeneficiary_optionaccount_active_colorno": "rgba(31, 31, 31, 0.25)0001137069", "app_colorextras": "#b37038" }, {/*this will contain an array of provider override settings*/} "app_info": {} } } |
Response (when otp_override = false)
Set provider_response_code to 900T0
| Code Block | ||
|---|---|---|
| ||
{ "namestatus": "Victor MotorsWaitingForOTP", "idmessage": "5cdab3332b7d4100015f0db4",Please enter the OTP "beneficiary_account_no": "0001137069", sent to 2348022****08", "extrasdata": {/*this will contain an array of provider override settings*/} } } } |
Response (when otp_override = false)
...
"provider_response_code |
...
| Code Block | ||
|---|---|---|
| ||
{": "900T0", "statusprovider": "WaitingForOTPBeeceptor", "messageerrors": "Pleasenull, enter the OTP sent to 2348022****08", "dataerror": {null, "provider_response_code": "900T0", ": null } } |
Response (when otp_override = true)
| Code Block |
|---|
{ "providerstatus": "BeeceptorSuccessful", "errorsmessage": null,"Transaction processed successfully", "errordata": null,{ "provider_response_code": null "00", } } |
Response (when otp_override = true)
| Code Block |
|---|
{ "statusprovider": "SuccessfulBeeceptor", "messageerrors": null, "Transaction processed successfully", "dataerror": {null, "provider_response_code": "00", { "providercustomer_id": "Beeceptor007935125", "errors": null, "account_name": "BOLA SALAMI", "erroraccount_number": null,"1780161243", "providerlast_responsename": {"SALAMI", "customerfirst_idname": "007935125BOLA", "accountmiddle_name": "BOLA SALAMI-", "last_namegender": "SALAMIFemale", "middleaccount_namecurrency": "-NGN", "first_namedob": "BOLA1993-04-18T00:00:00" } } } |
Failed Response
In the case of failure or error, the provider should return failure message in this format (encrypted).
...