{
  "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

• Once it's card, it should be: TripleDES.encrypt("{card.Pan};{card.Cvv};{card.Expdate};{card.Pin}",secretKey)

• Once it's bank.account , it shd be: TripleDES.encrypt("{accountNumber};{bankCBNCode}",secretKey)

• Once it's wallet , it shd be: TripleDES.encrypt("{walletNumber};{providerCode}",secretKey)

• Once it's airtime , it shd be: TripleDES.encrypt("{phoneNumber};{telcoCode}",secretKey)

• Once it's voucher , it shd be: TripleDES.encrypt("{voucherCode};{providerCode}",secretKey)

• Once it's bvn , it shd be: TripleDES.encrypt("{bvn}",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",
  "auth": {
    	"a_keytype":"a_value",
   "bank.account | card | wallet", 
    "a_keysecure":"a_value"
    }
  }
}

{
    "originator_kyc_levelstatus": "1Successful",
    "message": "Transaction processed successfully",
    "narrationdata": "My narration",
{
            "transactionprovider_finalresponse_amountcode": 1000"00",
        "provider": "Beeceptor",
   "meta":{     "errors": null,
        "fee_flaterror": 0null,
   
          "feeprovider_percentresponse": 0,
 {
            "commission_flatreference": 0"000022200225154318222333334432",
              "commissiondestination_institution_percentcode": 0"000016",

             "fieldbeneficiary_account_keyname":"field_value "JOHN DOE JAMES",
            "beneficiary_account_number": "3056433222",
            "fieldbeneficiary_kyc_keylevel": "field_value3",
            }
 "originator_account_name": "James Jane",
      }     }
}

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": "{{encrypted_otp_orPIN_orOtherInput}}",
        "auth_provider": "Beeceptor" 
    },
    "transaction": {
        "transaction_ref": "70713093460718"
    }
}

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

{
  "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}}",
	"transaction":{
		"transaction_ref": "12978251696483"
	}
}

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