Versions Compared

Key

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

...

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

INTERFACE SPECIFICATION (APP → ONEPIPE)

Endpoints

Operation

Value

Transact

https://api.dev.onepipe.io/v2/transact
https://api.staging.onepipe.io/v2/transact
https://api.onepipe.io/v2/transact

Validate OTP

https://api.dev.onepipe.io/v2/transact/validate
https://api.staging.onepipe.io/v2/transact/validate
https://api.onepipe.io/v2/transact/validate

...

Code Block
languagejson
{
    "status": "Successful",
    "message": "Transaction processed successfully",
    "data": {
        "provider_response_code": "00",
        "provider": "Beeceptor",
        "errors": null,
        "error": null,
        "provider_response": {
            "bvn": "22333055555",
            "first_name": "John",
            "middle_name": "Jane",
            "last_name": "Doe",
            "date_of_birth": "09-Dec-1990",
            "phone_number_1": "07037608648",
            "phone_number_2": "",
            "registration_date": "12-Sep-2015",
            "enrollment_bank": "011",
            "enrollment_branch": "MATORI",
            "email": "john.doe@gmail.com",
            "gender": "Male",
        }
    }
}

Request (

...

validate with otp)

Code Block
languagejson
{
  "request_ref":"{{request_ref}}", 
  "request_type":"lookup_bvn_min",
	"auth": {
        "secure": "{{encrypted_otp}}",
        "auth_provider": "Beeceptor" 
    },
    "transaction": {
        "transaction_ref": "70713093460718"
    }
}

...

Code Block
{
    "status": "Successful",
    "message": "Operation was successful",
    "data": {
    	"provider_responde_code":"00",
    	"provider": "Polaris",
        "errors": null,
        "error": null,
        "provider_response": {
	        "bvn": "22211234561",
	        "first_name": "BOYEBEST",
	        "middle_name": "ADEOYE",
	        "last_name": "ISRAEL",
	        "enrollment_bank": null,
            "dob": "21-Mar-1981",
            "registration_date": "18-Mar-2015",
            "enrolment_branch": null,
            "email": "boyebest@yahoo.com",
			"gender": "Male",
			"level_of_account": "Level 2 - Medium Level Accounts",
			"lga_of_origin": "Olorunda",
			"lga_of_residence": "Ido",
			"marital_status": "Married",
			"nin": "*",
			"name_on_card": "Boyebest Adeoye Israel",
			"nationality": "Nigeria",
			"phone_number1": "08073123456",
			"phone_number2": "08158498992",
			"residential_address": "1, Boyebest Lane, Oko Awo",
			"state_of_origin": "Osun State",
			"state_of_residence": "Oyo State",
			"watch_listed": "NO",
			"base64_image": "/9j/4AAQSkZJRgABAgAAAQABAAD/==",
			"response_code": "00",
			"response_message": "Success",
			"user_message": "Success"
        }
    }
}

Request (Validate)

Code Block
languagejson
{
  "request_mode":"validate",
  "request_ref":"{{request_ref}}", 
  "request_type":"lookup_bvn_min",
  "auth": {
    "type": null, 
    "secure": "{{otp}}",
    "auth_provider": "Beeceptor"
  },
  "transaction": {
    "mock_mode": null, 
    "transaction_ref": "{{transaction_ref}}", 
    "transaction_desc": null, 
    "transaction_ref_parent": null, 
    "amount": 0,
    "customer":null,
    "meta":null,
    "details": null
  }
}

...