production
development
https://apigateway.bankalfalah.com/bankalfalah/sb
Paths
/v1
post /v1
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
clientSecretHeader
X-IBM-Client-Secret
(apiKey located in header)
OAuth
OAuth
(oauth2 application)
OAuth Authentication
Token URL
https://apigateway.bankalfalah.com/bankalfalah/sb/oauthproviderapi/oauth2/token
Scopes
GetToken
Request Body
Required in body
object
Content-Type
Optional in header
string
Accept
Optional in header
string
application/json
200
Success
500
Error
Example Request
Example Response
POST https://apigateway.bankalfalah.com/bankalfalah/sb/bafpay-onboarding-wallet-verification/v1
Try this operation
No response. This is a mixed content call. It is not possible to test HTTP APIs from an HTTPS secured Portal site and vice versa.
No response. This is a cross-origin call. Make sure the server accepts requests from this portal. Or if using self-signed SSL certificates then paste the URL above into your browser to accept the certificate before trying again (On Internet Explorer it must be the same browser tab.).
Definitions
{
"type": "object",
"properties": {
"TRN": {
"type": "string",
"description": "ismandatory=true , Description:Unique Number , SpecialCharacter = not allowed"
},
"CNIC": {
"type": "string",
"description": "ismandatory=true , Description: 13 digits numeric value , SpecialCharacter = not allowed"
},
"MobileNo": {
"type": "string",
"description": "ismandatory=true , Description: 11 digits numeric value , SpecialCharacter = not allowed"
},
"Name": {
"type": "string",
"description": "ismandatory=true , Description: Name of customer ,SpecialCharacter = allowed"
},
"IssueDate": {
"type": "string",
"description": "ismandatory=true , Description : CNIC Issuance date , SpecialCharacter = not allowed"
},
"Reserved1": {
"type": "string",
"description": "ismandatory=false , Description : Reserved Field , SpecialCharacter = not allowed"
},
"Reserved2": {
"type": "string",
"description": "ismandatory=false , Description : Reserved Field , SpecialCharacter = not allowed"
},
"Reserved3": {
"type": "string",
"description": "ismandatory=false , Description : Reserved Field , SpecialCharacter = not allowed"
},
"Reserved4": {
"type": "string",
"description": "ismandatory=false , Description : Reserved Field , SpecialCharacter = not allowed"
}
},
"example": {
"TRN": "123",
"CNIC": "4220101598845",
"MobileNo": "03002342163",
"Name": "SYED UZAIR HASSAN WARSI",
"IssueDate": "07-12-2025",
"Reserved1": "",
"Reserved2": "",
"Reserved3": "",
"Reserved4": ""
},
"required": [
"TRN",
"CNIC",
"MobileNo",
"Name",
"IssueDate",
"Reserved1",
"Reserved2",
"Reserved3",
"Reserved4"
],
"additionalProperties": false
}
{
"type": "object",
"properties": {
"ResponseCode": {
"type": "string"
},
"ResponseDesc": {
"type": "string"
},
"MotherName": {
"type": "string"
},
"BirthPlace": {
"type": "string"
}
},
"example": {
"ResponseCode": "00",
"ResponseDesc": "successful",
"MotherName": "KEHKASHAN MALIK",
"BirthPlace": "KARACHI SHARKI"
}
}
{
"type": "object",
"properties": {
"ResponseCode": {
"type": "string"
},
"ResponseDesc": {
"type": "string"
}
},
"example": {
"ResponseCode": "99",
"ResponseDesc": "Failed"
}
}