...
| Gliffy | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Interface specification - (App → OnePipe)
Request (/transact/options)
| Code Block | ||
|---|---|---|
| ||
{
"request_ref":"{{request-ref}}",
"request_type":"fund_wallet",
"auth": {
"type": "bank.account | card | wallet | airtime | token",
"secure": "{{encrypted secure}}",
"auth_provider": "Beeceptor",
"route_mode":"provider | options | null"
},
"transaction": {
"mock_mode": "live",
"transaction_ref": "{{transaction-ref}}",
"transaction_desc": "A random transaction",
"transaction_ref_parent": "",
"amount": 10000,
"customer":{
"customer_ref": "{{customer id}}", //the wallet number to top up
"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": {
"service_code": "{{code representing the wallet service}}"
}
}
} |
Response (/transact/options)
| Code Block | ||
|---|---|---|
| ||
{
"status": "SuccessfulOptionsDelivered",
"message": "Transaction processed successfully",
"data": {
"options": null,
"provider_response_code": "00",
"provider": "Beeceptor",
"errors": null,
"error": null,
"provider_response": {
"options": [
{
"service_code": "option 1",
"name": "A random Option"
},
{
"service_code": "option 1",
"name": "A random Option"
}
],
"meta": {
"field_key": "field_value"
}
},
"client_info": {
"name": null,
"id": null,
"bank_cbn_code": null,
"bank_name": null,
"console_url": null,
"js_background_image": null,
"css_url": null,
"logo_url": null,
"footer_text": null,
"show_options_icon": false,
"reference": "000022200225154318222333334432", "paginate": false,
"paginate_count": 0,
"options": null,
"merchant": null,
"colors": null,
"meta": null
}
}
} |
Request (/transact)
| Code Block | ||
|---|---|---|
| ||
{
"request_ref":"{{request-ref}}",
"request_type":"fund_wallet",
"auth": {
"type": "bank.account | card | wallet | airtime | token",
"secure": "{{encrypted secure}}",
"auth_provider": "Beeceptor",
"route_mode":"provider | options | null"
},
"transaction": {
"mock_mode": "live",
"transaction_ref": "{{transaction-ref}}",
"transaction_desc": "A random transaction",
"transaction_ref_parent": "",
"amount": 10000,
"customer":{
"customer_ref": "{{customer id}}", //the wallet number to top up
"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": {
"service_code": "{{code representing the wallet service}}"
}
}
} |
Response (/transact)
| Code Block | ||
|---|---|---|
| ||
{ "status": "Successful", "message": "Transaction processed successfully", "data": { "provider_response_code": "00", "provider": "Beeceptor", "errors": null, "error": null, "provider_response": { "payment_status": Successful | Failed | Processing", "fulfillment_status": "Succesful | Failed | Processing", "transaction_final_amount": 20000,//in kobo "transaction_fee": 5000,//in kobo "narration": "My narration", "reference": "000022200225154318222333334432", "meta":{ "field_key":"field_value", "field_key": {"field_value" } } } } |
Acceptable values for auth.type
...