{
  "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",
        "beneficiary_kyc_levelsurname": "3Usmanu",
    	"email": "ujuusmanu@gmail.com",
      	"originatormobile_account_nameno": "James Jane234802343132",
    },
    "meta":{
    	"originatora_account_numberkey": "0001131256"a_meta_value_1",
    	"another_key":"a_meta_value_2"
    },
  "originator_kyc_level  "details": "1",{
            "narration	"a_key": "My narration"a_value",
            "transactiona_final_amountkey": 1000,
            "meta":{"a_value"
    }
  }
}

{
     "field_keystatus": "field_valueSuccessful",
    "message": "Transaction processed   successfully",
    "field_keydata":"field_value" {
           }"provider_response_code": "00",
        "provider": "Beeceptor",
        "errors": null,
        }"error": null,
       }
}

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" 
    },
    "metatransaction": {
    	"a_key":"a_meta_value_1",
    	"anothertransaction_keyref":"a_meta_value_2 "70713093460718"
    },
    "details": {
    	"a_key":"a_key",
        "a_key":"a_key"
    },
    "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
}

{
	"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",
        "secondary_colorsurname": "#b37038Usmanu",
        "primary_button_color	"email": "#b37038ujuusmanu@gmail.com",
        "modal_background_color	"mobile_no": "linear-gradient(147.44deg, #d8903c 26.99%, #e69921 74.1%)"234802343132"
    },
    "meta":{
    	"paymenta_option_colorkey": "rgba(76, 61, 47, 0.08)"a_meta_value_1",
        "payment_option_active_color": "rgba(31, 31, 31, 0.25)",
   	"another_key":"a_meta_value_2"
    },
    "app_colordetails": "#b37038"{
    },
    "app_info": {	"a_key":"a_value",
        "namea_key": "a_value"Victor
Motors",       "id": "5cdab3332b7d4100015f0db4",
      "beneficiary_account_no": "0001137069",
      "extras": {/*this will contain an array of provider override settings*/}
    }
  }
}

{
    "request_ref": "{{request_ref}}",
    "request_type": "{{request type}",
    "request_mode": "fulfil",
    "transaction": {
        "amount": "18000",
        "transaction_ref": "{{transaction_ref}}",
        "transaction_desc": "{{transaction_desc}}",
        "transaction_ref_parent": "{{parent_transaction_ref}}",
        "details": {...}
    }
}

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

Request payload from OnePipe to the provider microservice comes encrypted, using the Triple DES Algorithm. See details.

{
  "request_mode":"{{request_ref}}", 
  "request_ref":"{{request_ref}}", 
  "request_type":"transfer_funds",
  "auth": {
    "type": "bank.account | card | wallet", 
    "secure": "decrypted({{bank account details | card details | wallet}})",
    "auth_provider": "Beeceptor"
  },
  "transaction": {
    "mock_mode": "live", 
    "transaction_ref": "{{transaction_ref}}", 
    "transaction_desc": "A random transaction", 
    "transaction_finalref_amountparent": 1000null, 
    "amount": 1000,
     "metacustomer":{
              "field_key":"field_value	"customer_ref": "{{customer_id}}",
    	"firstname": "Uju",
        "field_keysurname": "field_valueUsmanu",
        	"email": "ujuusmanu@gmail.com",
   }    	"mobile_no": "234802343132"
    },
    }
}