Documentations for API
| Name | Type | Values | Description |
|---|---|---|---|
| clientSecret | TEXT | Access-Token | Auth2.0 verification |
| Accept | JSON | application/json | application/json |
| Content-Type | JSON | application/json | application/json |
| clientId | TEXT | ************* | ************* |
| organizationId | TEXT | 223 | Authenticate organization |
| Name | Description | Required | Parameter Type | Length | Sample Value |
|---|
{
"loginAgentReq": {
"PIN": "6tBH5Et3C3b9p7Xzr1YVIQ==",
"UID": "1063857",
"APPV": "2.0.10.43",
"OS": "Android",
"OSVERSION": "11",
"MODEL": "SM-A505F",
"VENDOR": "samsung",
"NETWORK": "Ufone",
"UDID": "b227ee26ac146393"
}
}
| Name | Description | Parameter Type | Length | Sample Value |
|---|
{
"loginAgentRes": {
"id": "33",
"ATYPE": "3",
"AMOB": "03324779796",
"SENDER_IBAN": null,
"VIDEOLINK": "http:\/\/www.androidbegin.com\/tutorial\/AndroidCommercial.3gp",
"USTY": "3",
"LNAME": "AMEN",
"BALF": "0.00",
"APPV": "2.0.9.9",
"AGENT_AREA_NAME": "Punjab",
"BAL": "0.0",
"ADTYPE": "1",
"IS_SET_MPIN_LATER": null,
"FNAME": "AMEN",
"IMPCR": "0",
"IPCR": "0",
"APUL": "1",
"BVSE": "0",
"IS_MIGRATED": "0",
"TSTR": "Dear Agent! Welcome to Branchless Banking",
"CNIC": "3380213794351",
"IS_CNIC_EXPIRY_REQUIRED": "0"
}
}
{
"loginAgentRes": {
"id": "33",
"ATYPE": "3",
"AMOB": "03324779796",
"SENDER_IBAN": null,
"VIDEOLINK": "http:\/\/www.androidbegin.com\/tutorial\/AndroidCommercial.3gp",
"USTY": "3",
"LNAME": "AMEN",
"BALF": "0.00",
"APPV": "2.0.9.9",
"AGENT_AREA_NAME": "Punjab",
"BAL": "0.0",
"ADTYPE": "1",
"IS_SET_MPIN_LATER": null,
"FNAME": "AMEN",
"IMPCR": "0",
"IPCR": "0",
"APUL": "1",
"BVSE": "0",
"IS_MIGRATED": "0",
"TSTR": "Dear Agent! Welcome to Branchless Banking",
"CNIC": "3380213794351",
"IS_CNIC_EXPIRY_REQUIRED": "0"
}
}
{
"messages": "Bad Request - Invalid Access Token",
"errorcode": "4001"
}
{
"messages": "Bad Request - Invalid Request Payload",
"errorcode": "4002"
}
{
"messages": "Bad Request - Invalid Authorization Header",
"errorcode": "4003"
}
{
"messages": "Something Went Wrong",
"errorcode": "4004"
}
{
"messages": "Record Not Found",
"errorcode": "4005"
}
{
"messages": "Invalid Client Id\/Secret",
"errorcode": "4006"
}
{
"messages": "Bad Request - Invalid Access Token",
"errorcode": "4007"
}
| Name | Values | Description |
|---|---|---|
| Content-Type | application/json | Content Type application/json is supported |
| Accept | application/json | Content Type application/json is supported |
| organizationId | xyz | You will make a call to the auth-blb api and give it your client ID. You should add the client secret and organisation ID it returns here. |
| clientId | Enter your verified Client Id | |
| clientSecret | Enter Your Verified Client Secret |