Versions Compared

Key

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

...

  1. App calls /transact with the right auth details

  2. Provider responds with WaitingForOTP or PendingValidation as may be required

  3. App calls /transact/validate to supply OTP if needed

  4. Provider responds with any of the completion codes Successful or Failed.

  5. To query the status of a transaction, the app can call /transact/query

  6. Where the provider supports it, the app can call /transact/reverse to request a reversal

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

INTERFACE SPECIFICATION (APP → ONEPIPE)

...

Code Block
languagejson
{
  "request_ref":"{{request_ref}}", 
  "request_type":"lookup_wallet_max",
  "auth": {
    "type": "bank.account | card", 
    "secure": "{{encrypted_secure}}",
    "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",
    	"another_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": {
            "customer_id": "007935125",
            "account_currency": "NGN",
            "account_number": "1020123456",
            "account_name": "BOLA SALAMI",
            "last_name": "SALAMI",
            "middle_name": "-",
            "first_name": "BOLA",
            "gender": "Male",
            "dob": "1971-03-12T00:00:00",
            "account_branch": "101",
            "scheme_code": "SAV",
            "bvn": "22211055555",
            "account_status": "ACCOUNT OPEN",
            "ledger_balance": 2524.59,
            "available_balance": 2524.59,
            "kyc_level": "3",
            "name_enquiry_id": "0000028301",
            "address1": "9 LIGALI STREET",
            "address2": ".",
            "address3": "IBADAN",
            "email": "BOLASALAMI@yahoo.com",
            "mobile_number": "080913333333",
            "account_type": "CURRENT",
            "reference": "000022200225154318222333334432",
            "meta":{
              "field_key":"field_value",
              "field_key": {"field_value"
            }
        }
    }
}

Request (validate with otp)

...