{
  "request_ref":"{{request_ref}}", //a unique ref
  "request_type":"transfer_funds", //what service are you trying to execute
  "auth": {...}, //security details and what provider to forward the request to
  "transaction": {...} //details required to complete every call. Varies per service type
}

All calls to OnePipe support for authorization details to be passed in where required in the auth.secure element.

A note on the secure element

• When auth.type is ‘card’, it should be: TripleDES.encrypt("{card.Pan};{card.Cvv};{card.Expdate};{card.Pin}",secretKey)

• When auth.type is ‘bank.account’ , it shd be: TripleDES.encrypt("{accountNumber};{bankCBNCode}",secretKey)

• When auth.type is ‘wallet’ , it shd be: TripleDES.encrypt("{walletNumber};{providerCode}",secretKey)

• When auth.type is ‘airtime’ , it shd be: TripleDES.encrypt("{phoneNumber};{telcoCode}",secretKey)

• When auth.type is ‘voucher’ , it shd be: TripleDES.encrypt("{voucherCode};{providerCode}",secretKey)

• When auth.type is ‘bvn’, it shd be: TripleDES.encrypt("{bvn}",secretKey)

• When auth.type is ‘basic’ , it shd be: TripleDES.encrypt("{userName};{password}",secretKey)

• When auth.type is 'custom' (masterpass specifically) , it shd be: TripleDES.encrypt("{user_id};{card_id};{pin}",secretKey)

• When auth.type is ‘custom’ (anything else) , it shd be: TripleDES.encrypt("{ref}",secretKey)

For details on encryption using the Triple DES Algorithm, read this.

NOTE: While it’s such that some providers will need a PIN for their auth Type, others will likely not. But the interfaces are standardized not to request this value (except in the case of cards). If a provider needs it, they should respond with PendingValidation and request for the PIN.

{
  "request_ref":"{{request_ref}}", 
  "request_type":"transfer_funds",
  "request_mode":"transact | validate | query | reverse",
  "auth": {
    "type": "bank.account | card | wallet", 
    "secure": "{{encrypted(bank account details | card details | wallet)}}",
    "auth_provider": "Beeceptor",
    "route_mode": null
  },
  "transaction": {
    "mock_mode": "live", 
    "transaction_ref": "{{transaction_ref}}", 
    "transaction_desc": "A random transaction", 
    "transaction_ref_parent": null, 
    "amount": 1000,
    "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": {
    	"a_key":"a_value",
        "a_key":"a_value"
    }
  }
}

{
    "status": "Successful",
    "message": "Transaction processed successfully",
    "data": {
        "provider_response_code": "00",
        "provider": "Beeceptor",
        "surnameerrors": "Usmanu"null,
     	   "emailerror": "ujuusmanu@gmail.com",null,
        	"mobileprovider_noresponse": "234802343132"{
       },     "metareference":{ "000022200225154318222333334432",
            	"adestination_institution_keycode":"a_meta_value_1 "000016",
    	"another_key":"a_meta_value_2"
    },        "beneficiary_account_name": "JOHN DOE JAMES",
       "details": {     	"abeneficiary_account_keynumber": "a_value3056433222",
         "a_key   "beneficiary_kyc_level": "a_value3",
    }   } }

NOTE: For a successfully completed transaction the response.data.provider_response.metaobject should at a minimum contain 4 fields:

• fee_flat: Any flat fee that was charged to the calling client

• fee_percent: Any percentage-based fee that was charged to the calling client

• commission_flat: Any flat amount commission paid to the calling client

• commission_percent: Any percentage-based commission paid to the calling client

{
  "request_ref":"{{request_ref}}", 
  "request_type":"lookup_bvn_max",
	"auth": {
        "secure": "fee_flat": 0{{encrypted_otp_orPIN_orOtherInput}}",
              "fee_percent"auth_provider": 0,"Beeceptor" 
    },
        "commission_flat"transaction": 0,
   {
          "commissiontransaction_percentref": 0,
    "70713093460718"
    }
}

{
   "field_key":"field_value",
              "field_key":"field_value"
            }
        }
    }
}

{
  "request_ref":"{{request_ref}}", 
  "request_type":"transfer_funds",
  "auth": {
    "type": "bank.account | card | wallet", 
    "secure": "{{encrypted(bank account details | card details | wallet)}}",
    "auth_provider": "Beeceptor",
    "route_mode": null
  },
  "transaction": {
    "mock_mode": "live", 
    "transaction_ref": "{{transaction_ref}}", 
    "transaction_desc": "A random transaction", 
    "transaction_ref_parent": null, 
    "amount": 1000,
    "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": {
    	"a_key":"a_value",
        "a_key":"a_value"
    }
  }
}

{
    "request_ref": "{{request_ref}}",
    "request_type": "{{request type}",
    "request_mode": "fulfil",
    "transaction": {
        "amount": 1000"18000",
    "customer":{     	"customertransaction_ref": "{{customertransaction_idref}}",
    	"firstname": "Uju",         "surname"transaction_desc": "Usmanu{{transaction_desc}}",
    	"email": "ujuusmanu@gmail.com",      	"mobiletransaction_ref_noparent": "234802343132"{{parent_transaction_ref}}",
    },     "metadetails": {...}
      	"a_key":"a_meta_value_1",
    	"another_key":"a_meta_value_2"
    },
    "details": {
    	"a_key":"a_value",
        "a_key":"a_value"
    }
  }
}}
}

{
	"request_ref":"{{request-ref}}",
	"request_type":"{{request_type}}",
	"transaction":{
		"transaction_ref": "12978251696483"
	}
}