With this service, the calling apps can check corresponding Cards that belongs to the CUSTOMER REF provided in the payload. In effect, take a customer ref and try to fetch all card attached to it. OnePipe will forward to the provider’s dedicated implementation. Providers will either use the CUSTOMER REF sent to fetch the corresponding card belonging to customer.

Before you proceed: Please read this.

Commercial model

At agreed settlement cycles, the host will debit the configured beneficiary account of the app for the use of this API and share that fee with all participants. Fees will be determined by the provider.

Settlement & fees model

Model	How it works
Invoice	The host client will invoice the calling app periodically for all calls to the endpoint.

Special configuration notes

This service does not need an OTP implementation as it’s a low risk lookup. A card lookup service.

Process flows

Sequence of calls

App calls /transact with the account number they want to lookup in the details object. auth.type is expected to be null.
Provider responds with any of the completion codes Successful or Failed.

INTERFACE SPECIFICATION (APP → ONEPIPE)

Request

{
  "request_ref":"{{request_ref}}", 
  "request_type":"lookup_cards",
  "auth": {
    "type": null,
    "secure": null,
    "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}}", // Major Parameter to be used on the provider
    	"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": {
    	"account_number":"3065570057"
    }
  }
}

Response

{
    "status": "Successful",
    "message": "Transaction processed successfully",
    "data": {
        "provider_response_code": "00",
        "provider": "Beeceptor",
        "errors": null,
        "error": null,
        "provider_response": {
            "cards": [
                {
                  "brand": "MASTERCARD",
                  "expiry": "0521",
                  "fundingMethod": "DEBIT",
                  "issuer": "FISERV SOLUTIONS, LLC",
                  "number": "511111xxxxxx1118",
                  "scheme": "MASTERCARD"
                },
            ],
            "reference": "000022200225154318222333334432",
            "meta":{
              "field_key":"field_value",
              "field_key":"field_value"
            }
        }
    }
}

Breakdown of the details object

For this service, the details object will have the following:

Field	Type	Requirement	Description
account_number	string	optional	The account number to lookup.

Possible status response codes

For this service, these are the possible responses a client can receive

Status	Meaning
Successful	Standard success code
Failed	Standard failure code

Acceptable values for auth.type

This would be null.

INTERFACE SPECIFICATION (ONEPIPE → PROVIDER MICRO SERVICE)

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

Read this closely.

Lookup Cards