--- swagger: "2.0" info: x-ibm-name: ubps-rest-service title: BPS REST Service version: 1.0.0 description: "" schemes: - https basePath: /ubps-rest-service consumes: - application/json produces: - application/json securityDefinitions: OAuth-UBPS: type: oauth2 description: "" flow: application scopes: 1LinkApi: "" tokenUrl: https://Sandboxapi.1link.net.pk/uat-1link/sandbox/oauth2/token clientIdHeader: type: apiKey in: header name: X-IBM-Client-Id security: - clientIdHeader: [] OAuth-UBPS: - 1LinkApi x-ibm-configuration: testable: true enforced: true phase: realized paths: /BillPayment: post: responses: 200: description: 200 OK schema: $ref: '#/definitions/BillPaymentResponse' parameters: - name: BillPaymentRequest required: false in: body schema: $ref: '#/definitions/BillPaymentRequest' /BillInquiry: post: responses: 200: description: 200 OK schema: $ref: '#/definitions/BillInquiryResponse' parameters: - name: BillInquiryReq required: false in: body schema: $ref: '#/definitions/BillInquiryRequest' definitions: BillPaymentResponse: properties: ResponseCode: type: string description: Response Code example: "00" ClientID: type: string description: Client ID example: api_123456 ChannelID: type: string description: Channel ID example: "00000000" STAN: type: string description: System Trace Audit Number example: "257999" CompanyCode: type: string description: Company Code example: KESC0001 ConsumerNo: type: string description: Consumer Number example: "1700416100034" AuthID: type: string description: Auth ID example: "425499" RRN: type: string description: Internal retrieval reference number example: "507831100007" ResponseDetail: type: string description: Response Detail example: 1700416100034SYED IFTIKHAR AHMED 1503+000000020202920150330+0000000088373201904210000000016576+0000002500000+0000002500000123456589388******4271 20190411154530000500000 50 998876987609876 10586 998876 2019041220190411 0000 20190411140458520002494791 30245238 Reserved1: type: string example: "" Reserved2: type: string example: "" HASH: type: string description: Hash additionalProperties: false BillPaymentRequest: properties: UserID: type: string description: To authenticate client connecting to UBPS minLength: 1 maxLength: 16 pattern: ^[a-zA-Z0-9_-]+$ example: api_123456 Pwd: type: string description: To authenticate client connecting to UBPS minLength: 1 maxLength: 16 pattern: ^[a-zA-Z0-9_-]+$ example: api_112233 CLientID: type: string description: Client ID minLength: 1 maxLength: 10 pattern: ^[a-zA-Z0-9_-]+$ example: api_123456 ChannelID: type: string description: Channel ID minLength: 1 maxLength: 8 pattern: ^[0-9]+$ example: "00000000" STAN: type: string description: System Trace Audit Number minLength: 1 maxLength: 6 pattern: ^[0-9]+$ example: "257999" CompanyCode: type: string description: Utility company ID that represent a biller. Bill aggregator entity is the issuing authority for the value in this field minLength: 1 maxLength: 8 pattern: ^[a-zA-Z0-9_-]+$ example: KESC0001 ConsumerNo: type: string description: Represents customer of biller. System should return the single record of latest bill available to pay against a consumer number minLength: 1 maxLength: 24 pattern: ^[a-zA-Z0-9_-]+$ example: "1700416100034" AuthorizationID: type: string description: Treated as transaction reference number. Included in keys used to uniquely identify a transaction minLength: 1 maxLength: 6 pattern: ^[0-9]+$ example: "425499" Amount: type: string description: Representation of amount minLength: 1 maxLength: 12 example: "000002500000" TransactionDateTime: type: string description: 'Representation of date and time stamp of transaction. Format: yyyyMMddHHmmss' minLength: 1 pattern: ^[0-9]+$ example: "20190411154530" BranchCode: type: string pattern: ^[0-9]+$ description: If bill is paid from some Bank Branch or other exchange. example: "1234" BranchName: type: string description: Send Branch Name. pattern: ^[a-zA-Z\d\-_\s]+$ example: Sadda Reserved1: type: string description: Reserved for future use example: "" Reserved2: type: string description: Reserved for future use example: "" Reserved3: type: string description: Reserved for future use example: "" Reserved4: type: string description: Reserved for future use example: "" additionalProperties: false required: - UserID - Pwd - CLientID - ChannelID - STAN - CompanyCode - ConsumerNo - AuthorizationID - Amount - TransactionDateTime BillInquiryResponse: properties: ResponseCode: type: string description: Response Code example: "00" ClientID: type: string description: Client ID example: api_123456 ChannelID: type: string description: Channel ID example: "00000000" STAN: type: string description: System Trace Audit Number example: "124785" CompanyCode: type: string description: Company Code example: KESC0001 ConsumerNo: type: string description: Consumer Number example: "1700416100034" CustomerName: type: string description: Customer Name example: AZLAN TAHIR BillStatus: type: string description: Bill Status example: U BillingMonth: type: string description: Billing Month example: "1503" DueDate: type: string description: Due Date example: "190505" AmountWithinDueDate: type: string description: Amount with in due date example: "+0000002500000" AmountAfterDueDate: type: string description: Amount After due date example: "+0000002500000" RRN: type: string description: Internal retrieval reference number example: "541742500003" ResponseDetail: type: string description: Reserved Field Detail for Loan Payment PayerCNIC (13) Numeric City (30) AlphaNumeric Province (20) AlphaNumeric AccountID (28) Numeric example: SYED IFTIKHAR AHMED 1503+0000002500000190505+0000002500000U875800+0000000000000+00000000000001700416100034+0000000202029+000000008837320150330000000001657620190425000002500000 Reserved1: type: string description: Reserved2 example: "" Reserved2: type: string description: Reserved2 example: "" additionalProperties: false BillInquiryRequest: properties: UserID: type: string description: To authenticate client connecting to UBPS minLength: 1 maxLength: 16 pattern: ^[a-zA-Z0-9_-]+$ example: api_123456 Pwd: type: string description: To authenticate client connecting to UBPS minLength: 1 maxLength: 16 pattern: ^[a-zA-Z0-9_-]+$ example: api_112233 CLientID: type: string description: Identification for client institution minLength: 1 maxLength: 10 pattern: ^[a-zA-Z0-9_-]+$ example: api_123456 ChannelID: type: string description: Channel ID minLength: 1 maxLength: 8 pattern: ^[0-9]+$ example: "00000000" STAN: type: string description: System Trace Audit Number minLength: 1 maxLength: 6 pattern: ^[0-9]+$ example: "124785" CompanyCode: type: string description: Utility company ID that represent a biller. Bill aggregator entity is the issuing authority for the value in this field minLength: 1 maxLength: 8 pattern: ^[a-zA-Z0-9_-]+$ example: KESC0001 ConsumerNo: type: string description: Represents customer of biller. System should return the single record of latest bill available to pay against a consumer number minLength: 1 maxLength: 24 pattern: ^[a-zA-Z0-9_-]+$ example: "1700416100034" BranchCode: type: string description: If bill is paid from some Bank Branch or other exchange. pattern: ^[0-9]+$ example: "1234" BranchName: type: string description: Send Branch Name. pattern: ^[a-zA-Z\d\-_\s]+$ example: Sadda Reserved1: type: string description: Reserved for future use example: "" Reserved2: type: string description: Reserved for future use example: "" Reserved3: type: string description: Reserved for future use example: "" Reserved4: type: string description: Reserved for future use example: "" tags: [] x-ibm-endpoints: - endpointUrl: https://Sandboxapi.1link.net.pk/uat-1link/sandbox type: - production - development ...