Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Model

How it works

Invoice

The host client will invoice the calling app periodically for all calls to the endpoint.

Acceptable values for auth.type

  • bvn

Process flows

Sequence of calls

...

Gliffy
macroId
imageAttachmentIdatt32243723
macroIda9d3d285-2916-4123-9e93-236a130f390f
baseUrlhttps://onepipe.atlassian.net/wiki
a9d3d285-2916-4123-9e93-236a130f390fnameOnePipe 2.0 Collect Service
diagramAttachmentIdatt32210953
containerId32243713
timestamp1581541309221

...

Code Block
languagejson
{
  "request_ref":"{{request_ref}}", 
  "request_type":"lookup_bvn_mid",
  "auth": {
    "type": "bvn", 
    "secure": "{{encrypted_bvn}}",
    "auth_provider": "Beeceptor",
    "route_mode": null
  },
  "transaction": {
    "mock_mode": "live", 
    "transaction_ref": "{{transaction_ref}}", 
    "transaction_desc": "A random transaction", 
    "transaction_ref_parent": null, 
    "amount": 0,
    "customer":{
    	"customer_ref": "{{customer_id}}",
    	"firstname": "Uju",
       		 "surname": "Usmanu",
    	"email": "ujuusmanu@gmail.com",
    	"mobile_no": "234802343132"
    },
    "meta":{
    	"a_key":"a_meta_value_1",
    	"b_key":"a_meta_value_2"
    },
    "details": null
  }
}

...

Code Block
languagejson
{
    "status": "Successful",
    "message": "Transaction processed successfully",
    "data": {
        "provider_response_code": "00",
        "provider": "Beeceptor",
        "errors": null,
        "error": null,
        "provider_response": {
            "reference": "98776665556665",
            "bvn": "22333055555",
            "first_name": "John",
            "middle_name": "Jane",
            "last_name": "Doe",
            "dob": "1990-12-22",
            "phone_number1": "07037608648",
            "phone_number2": "",
            "registration_date": "1990-12-22",
            "email": "john.doe@gmail.com",
            "gender": "Male",
            "level_of_account": "Level 2 - Medium Level Accounts",
            "lga_of_origin": "Owerri West",
            "lga_of_residence": "Ikeja",
            "marital_status": "Single",
            "meta":{}
        }
    }
}

Request (validate with otp)

...