...
Type | Description |
|---|---|
card | Takes card details for debithold. |
bank.account | Takes bank account details for debithold. |
cash | Will simply flag the transaction, as awaiting |
customwallet | Takes a unique transaction ref. This mode is for when OnePipe.js or some other UI processes the payment and passes in a ref for validation of the payment. |
voucher | Takes a voucher code for debit. |
airtime | Takes MSISDN and debits the airtime on it. |
wallet | Takes a wallet ID for debit. |
bank.transfer | Simply instructs the provider to generate bank transfer instructions.wallet ID for hold. |
provider_token | A token representing prior consent given to hold funds |
Possible response codes
For this service, these are the possible responses a client can receive
...
Interface specification - (OnePipe → Provider)
Request - Consent Request
| Code Block | ||
|---|---|---|
| ||
| ||
{ "request_ref":"{{request-ref}}", "request_type":"hold_funds", "request_mode":"transact", "auth": { "type": "{card | bank.account | wallet | provider_token}", "secure": "{decrypted}", "auth_provider": "Beeceptor" }, "transaction": { "mock_mode": "live", "transaction_ref": "{{transaction-ref}}", "transaction_desc": "A random transaction", "transaction_ref_parent": "", "amount": 10000, "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" ], "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": "VictorMotors", "id": "5cdab3332b7d4100015f0db4", "beneficiary_account_no": "0001137069", "secureextras": "4if1oYEoHx5Kp+PZj6RibJlXbx8zIKkP", "auth_provider": "Beeceptor" {/*this will contain an array of provider override settings*/} }, "transaction": } } |
Request - Validate Consent Request
| Code Block | ||
|---|---|---|
| ||
{
"mockrequest_mode": "livevalidate",
"transactionrequest_ref": "{{transaction-request_ref}}",
"transactionrequest_desctype": "A random transaction"hold_funds",
"transaction_ref_parentauth": "", {
"amounttype": 10000null,
"customer":{
"customer_refsecure": "{{customer idotp}}",
"firstnameauth_provider": "UjuBeeceptor"
},
"surnametransaction": "Usmanu",{
"emailmock_mode": "ujuusmanu@gmail.com"null,
"mobiletransaction_noref": "234802343132"
},{{transaction_ref}}",
"metatransaction_desc":{ null,
"a_key":"a_meta_value_1",transaction_ref_parent": null,
"another_key":"a_meta_value_2"amount": 0,
}"customer":null,
"detailsmeta": null,
"client_infodetails": {null
}
} |
Request - Hold
| Code Block |
|---|
{ "namerequest_ref": "TrustPay", "{{request-ref}}", "idrequest_type": null, "hold_funds", "bankrequest_cbn_codemode": null"transact", "auth": { "bank_nametype": null, "console_url": null, "provider_token", "secure": "js_background_image": null, {decrypted_token}", "cssauth_urlprovider": null "Beeceptor" }, "transaction": { "logomock_urlmode": "https://trustpay.onepipe.io/img/trustpay_logo_console.png", live", "footertransaction_textref": "Brought to you by <strong>SunTrust Bank</strong>", "{{transaction-ref}}", "transaction_desc": "A random transaction", "optionstransaction_ref_parent": ["", "amount": 10000, "BANK.TRANSFER", customer":{ "CARD" "customer_ref": "{{customer id}}", ] "firstname": "Uju", "surname": "Usmanu", "primary_coloremail": "#b37038ujuusmanu@gmail.com", "mobile_no": "234802343132" "secondary_color": "#b37038", }, "meta":{ "primarya_button_colorkey": "#b37038"a_meta_value_1", "modal_background_color": "linear-gradient(147.44deg, #d8903c 26.99%, #e69921 74.1%)", "another_key":"a_meta_value_2" }, "details": null "paymentclient_option_colorinfo": "rgba(76, 61, 47, 0.08) { "name": "TrustPay", "payment_option_active_colorid": "rgba(31, 31, 31, 0.25)"null, "bank_cbn_code": null, "appbank_colorname": "#b37038" null, }, "appconsole_infourl": null, { "namejs_background_image": "VictorMotors"null, "idcss_url": "5cdab3332b7d4100015f0db4",null, "beneficiarylogo_account_nourl": "0001137069https://trustpay.onepipe.io/img/trustpay_logo_console.png", "extrasfooter_text": {/*this will contain an array of provider override settings*/} "Brought to you by <strong>SunTrust Bank</strong>", "options": [ } } } |
Response
| Code Block |
|---|
{ "status": "SuccessfulBANK.TRANSFER", "message": "Transaction processed successfully", "dataCARD": { "provider_response_code": "00" ], "provider "primary_color": "Beeceptor#b37038", "errorssecondary_color": null"#b37038", "error": null, "providerprimary_button_responsecolor": {"#b37038", "referencemodal_background_color": "000022200225154318222333334432","linear-gradient(147.44deg, #d8903c 26.99%, #e69921 74.1%)", "payment_option_idcolor": "136FTTP200590171"rgba(76, 61, 47, 0.08)", "destination_institution_code": "000016", "beneficiarypayment_option_accountactive_namecolor": "JOHN DOE JAMES",rgba(31, 31, 31, 0.25)", "beneficiaryapp_account_numbercolor": "3056433222#b37038", }, "beneficiaryapp_kyc_levelinfo": "3",{ "originator_account_name": "James JaneVictorMotors", "originator_account_numberid": "00011312565cdab3332b7d4100015f0db4", "originatorbeneficiary_kycaccount_levelno": "10001137069", "narrationextras": "My narration", "transaction_final_amount": 1000 //amount in kobo{/*this will contain an array of provider override settings*/} } } } |
Special notes for providers
...