{ "openapi": "3.0.3", "info": { "title": "Swagger Simbrella FirstAdvance - OpenAPI 3.0", "description": "This is a Simbrella FirstAdvance Backend Server with the OpenAPI 3.0 specification. \n\n\nSome useful links:\n- [Web Simulated Demo Page](https://digifi-salaryloan.chiefsoft.net/)\n- [Web Management Support Portal](https://digifi-office.chiefsoft.net/auth/login)", "termsOfService": "http://swagger.io/terms/", "contact": { "email": "support@chiefsoft.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.0.11" }, "servers": [ { "url": "https://devcore.digifi.chiefsoft.net/v1/api/salary" } ], "tags": [ { "name": "EligibilityCheck", "description": "Eligibility Check Request", "externalDocs": { "description": "Find out more", "url": "https://www.simbrellang.net" } }, { "name": "SelectOffer", "description": "This method is used the send the offer the customer selected to Simbrella.", "externalDocs": { "description": "Find out more", "url": "https://www.simbrellang.net" } }, { "name": "ProvideLoan", "description": "Provide Loan Request.", "externalDocs": { "description": "Find out more", "url": "https://www.simbrellang.net" } }, { "name": "LoanInformation", "description": "Loan Information Request.", "externalDocs": { "description": "Find out more", "url": "https://www.simbrellang.net" } }, { "name": "Repayment", "description": "Repayment Request.", "externalDocs": { "description": "Find out more", "url": "https://www.simbrellang.net" } }, { "name": "CustomerConsent", "description": "CustomerConsent Request.", "externalDocs": { "description": "Find out more", "url": "https://www.simbrellang.net" } }, { "name": "NotificationCallback", "description": "This new feature will be used for informing Simbrella about status of the transactions that FBN have processed.", "externalDocs": { "description": "Find out more", "url": "https://www.simbrellang.net" } }, { "name": "RACCheck", "description": "Risk Acceptance Criteria Request", "externalDocs": { "description": "Find out more", "url": "https://www.simbrellang.net" } }, { "name": "Disbursement", "description": "Loan Disbursement Request", "externalDocs": { "description": "Find out more", "url": "https://www.simbrellang.net" } }, { "name": "CollectLoan", "description": "Collect Loan Request", "externalDocs": { "description": "Find out more", "url": "https://www.simbrellang.net" } }, { "name": "TransactionVerify", "description": "Transaction Verify Request", "externalDocs": { "description": "Find out more", "url": "https://www.simbrellang.net" } }, { "name": "PenalCharge", "description": "Penal Charge Request", "externalDocs": { "description": "Find out more", "url": "https://www.simbrellang.net" } }, { "name": "RevokeEnableConsent", "description": "Revoke Enable Consent Request", "externalDocs": { "description": "Find out more", "url": "https://www.simbrellang.net" } }, { "name": "TokenValidation", "description": "Token Validation", "externalDocs": { "description": "Find out more", "url": "https://www.simbrellang.net" } }, { "name": "LienCheck", "description": "Lien Check", "externalDocs": { "description": "Find out more", "url": "https://www.simbrellang.net" } }, { "name": "NewTransactionCheck", "description": "New Transaction Check", "externalDocs": { "description": "Find out more", "url": "https://www.simbrellang.net" } }, { "name": "SMS", "description": "SMSRequest", "externalDocs": { "description": "Find out more", "url": "https://www.simbrellang.net" } }, { "name": "BulkSMS", "description": "Bulk SMS Request", "externalDocs": { "description": "Find out more", "url": "https://www.simbrellang.net" } } ], "paths": { "/EligibilityCheck": { "post": { "tags": [ "EligibilityCheck" ], "summary": "Start the process - initiate steps to eligibility RAC Checks ", "description": "Initiate Eligibility Check Request", "operationId": "startEligibilityCheck", "requestBody": { "description": "Post JSON to conduct eligibility tests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EligibilityCheckRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EligibilityCheckRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/EligibilityCheckRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EligibilityCheckResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EligibilityCheckResponse" } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Pet not found" }, "422": { "description": "Validation exception" } }, "security": [ { "petstore_auth": [ "write:pets", "read:pets" ] } ] } }, "/SelectOffer": { "post": { "tags": [ "SelectOffer" ], "summary": "This method is used the send the offer the customer selected to Simbrella ", "description": "This method is used the send the offer the customer selected to Simbrella", "operationId": "startEligibilityCheck", "requestBody": { "description": "Post JSON to conduct eligibility tests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectOffersRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SelectOffersRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SelectOffersRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectOffersResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SelectOffersResponse" } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Offers not found" }, "422": { "description": "Validation exception" } }, "security": [ { "petstore_auth": [ "write:pets", "read:pets" ] } ] } }, "/ProvideLoan": { "post": { "tags": [ "ProvideLoan" ], "summary": "Provide Loan Request ", "description": "Provide Loan Request", "operationId": "startEligibilityCheck", "requestBody": { "description": "Post JSON to conduct eligibility tests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EligibilityCheckRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EligibilityCheckRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/EligibilityCheckRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EligibilityCheckResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EligibilityCheckResponse" } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Pet not found" }, "422": { "description": "Validation exception" } }, "security": [ { "petstore_auth": [ "write:pets", "read:pets" ] } ] } }, "/LoanInformation": { "get": { "tags": [ "LoanInformation" ], "summary": "Loan Information Request ", "description": "Loan Information Request", "operationId": "startEligibilityCheck", "requestBody": { "description": "Post JSON to conduct eligibility tests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoanInformationRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LoanInformationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/LoanInformationRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoanInformationResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LoanInformationResponse" } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Loan not found" }, "422": { "description": "Validation exception" } }, "security": [ { "petstore_auth": [ "write:pets", "read:pets" ] } ] } }, "/Repayment": { "post": { "tags": [ "Repayment" ], "summary": "Repayment Request", "description": "Repayment Request", "operationId": "Repayment", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepaymentRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RepaymentRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RepaymentRequest" } } } }, "responses": { "200": { "description": "Repayment Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepaymentResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RepaymentResponse" } } } }, "400": { "description": "Invalid request" }, "500": { "description": "Internal server error" } } } }, "/CustomerConsent": { "post": { "tags": [ "CustomerConsent" ], "summary": "Customer Consent Request", "description": "Customer Consent Request", "operationId": "CustomerConsent", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerConsentRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomerConsentRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomerConsentRequest" } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerConsentResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomerConsentResponse" } } } }, "400": { "description": "Invalid request" }, "500": { "description": "Internal server error" } } } }, "/NotificationCallback": { "post": { "tags": [ "NotificationCallback" ], "summary": "Loan Information Request ", "description": "Loan Information Request", "operationId": "startEligibilityCheck", "requestBody": { "description": "Post JSON to conduct eligibility tests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoanInformationRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LoanInformationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/LoanInformationRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoanInformationResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LoanInformationResponse" } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Loan not found" }, "422": { "description": "Validation exception" } }, "security": [ { "petstore_auth": [ "write:pets", "read:pets" ] } ] } }, "/RACCheck": { "post": { "tags": [ "RACCheck" ], "summary": "Risk Acceptance Criteria Check", "description": "Check if a customer passes the Risk Acceptance Criteria defined by the bank", "operationId": "racCheck", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RACCheckRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RACCheckRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RACCheckRequest" } } } }, "responses": { "200": { "description": "RAC Check Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RACCheckResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RACCheckResponse" } } } }, "400": { "description": "Invalid request" }, "500": { "description": "Internal server error" } } } }, "/Disbursement": { "post": { "tags": [ "Disbursement" ], "summary": "Disbursement Request", "description": "Disbursement Request", "operationId": "Disbursement", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisbursementRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DisbursementRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DisbursementRequest" } } } }, "responses": { "200": { "description": "Disbursement Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisbursementResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DisbursementResponse" } } } }, "400": { "description": "Invalid request" }, "500": { "description": "Internal server error" } } } }, "/CollectLoan": { "post": { "tags": [ "CollectLoan" ], "summary": "Collect Loan Request", "description": "Collect Loan Request", "operationId": "CollectLoan", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectLoanRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CollectLoanRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CollectLoanRequest" } } } }, "responses": { "200": { "description": "CollectLoan Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectLoanResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CollectLoanResponse" } } } }, "400": { "description": "Invalid request" }, "500": { "description": "Internal server error" } } } }, "/TransactionVerify": { "post": { "tags": [ "TransactionVerify" ], "summary": "Transaction Verify Request", "description": "Transaction Verify Request", "operationId": "TransactionVerify", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionVerifyRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TransactionVerifyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TransactionVerifyRequest" } } } }, "responses": { "200": { "description": "TransactionVerify Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionVerifyResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TransactionVerifyResponse" } } } }, "400": { "description": "Invalid request" }, "500": { "description": "Internal server error" } } } }, "/PenalCharge": { "post": { "tags": [ "PenalCharge" ], "summary": "Penal Charge Request", "description": "Penal Charge Request", "operationId": "PenalCharge", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PenalChargeRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PenalChargeRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PenalChargeRequest" } } } }, "responses": { "200": { "description": "PenalCharge Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PenalChargeResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PenalChargeResponse" } } } }, "400": { "description": "Invalid request" }, "500": { "description": "Internal server error" } } } }, "/RevokeEnableConsent": { "post": { "tags": [ "RevokeEnableConsent" ], "summary": "Revoke Enable Consent Request", "description": "Revoke Enable Consent Request", "operationId": "RevokeEnableConsent", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeEnableConsentRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RevokeEnableConsentRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RevokeEnableConsentRequest" } } } }, "responses": { "200": { "description": "RevokeEnableConsent Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeEnableConsentResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/RevokeEnableConsentResponse" } } } }, "400": { "description": "Invalid request" }, "500": { "description": "Internal server error" } } } }, "/TokenValidation": { "post": { "tags": [ "TokenValidation" ], "summary": "Token Validation Request", "description": "Token Validation Request", "operationId": "TokenValidation", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenValidationRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TokenValidationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TokenValidationRequest" } } } }, "responses": { "200": { "description": "TokenValidation Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenValidationResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/TokenValidationResponse" } } } }, "400": { "description": "Invalid request" }, "500": { "description": "Internal server error" } } } }, "/LienCheck": { "post": { "tags": [ "LienCheck" ], "summary": "Lien Check Request", "description": "Lien Check Request", "operationId": "LienCheck", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LienCheckRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LienCheckRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/LienCheckRequest" } } } }, "responses": { "200": { "description": "LienCheck Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LienCheckResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LienCheckResponse" } } } }, "400": { "description": "Invalid request" }, "500": { "description": "Internal server error" } } } }, "/NewTransactionCheck": { "post": { "tags": [ "NewTransactionCheck" ], "summary": "New Transaction Check Request", "description": "New Transaction Check Request", "operationId": "NewTransactionCheck", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTransactionCheckRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NewTransactionCheckRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/NewTransactionCheckRequest" } } } }, "responses": { "200": { "description": "NewTransactionCheck Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTransactionCheckResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NewTransactionCheckResponse" } } } }, "400": { "description": "Invalid request" }, "500": { "description": "Internal server error" } } } }, "/SMS": { "post": { "tags": [ "SMS" ], "summary": "SMS Request", "description": "SMS Request", "operationId": "SMS", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SMSRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SMSRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SMSRequest" } } } }, "responses": { "200": { "description": "SMS Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SMSResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SMSResponse" } } } }, "400": { "description": "Invalid request" }, "500": { "description": "Internal server error" } } } }, "/BulkSMS": { "post": { "tags": [ "BulkSMS" ], "summary": "BulkSMS Request", "description": "BulkSMS Request", "operationId": "BulkSMS", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkSMSRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BulkSMSRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/BulkSMSRequest" } } } }, "responses": { "200": { "description": "BulkSMS Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkSMSResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BulkSMSResponse" } } } }, "400": { "description": "Invalid request" }, "500": { "description": "Internal server error" } } } } }, "components": { "schemas": { "EligibilityCheckRequest": { "type": "object", "properties": { "lienAmount": { "type": "number", "format": "double", "example": 500.01 }, "transactionId": { "type": "string", "example": "Tr201712RK9232P115" }, "countryCode": { "type": "string", "example": "NGR" }, "customerId": { "type": "string", "example": "CN621868" }, "msisdn": { "type": "string", "example": "3451342" }, "channel": { "type": "string", "example": "USSD" }, "accountId": { "type": "string", "example": "ACN8263457" } }, "xml": { "name": "EligibilityCheckRequest" } }, "EligibilityCheckResponse": { "type": "object", "properties": { "eligibleOffers": { "type": "string", "example": "OFFERS ARRAY HERE" }, "resultDescription": { "type": "string", "example": "Successful" }, "customerId": { "type": "string", "example": "CN621868" }, "msisdn": { "type": "string", "example": "3451342" }, "resultCode": { "type": "string", "example": "00" }, "accountId": { "type": "string", "example": "ACN8263457" } }, "xml": { "name": "EligibilityCheckResponse" } }, "SelectOffersRequest": { "type": "object", "properties": { "requestId": { "type": "string", "example": "202111170001371256908" }, "transactionId": { "type": "string", "example": "1231231321232" }, "customerId": { "type": "string", "example": "CN621868" }, "msisdn": { "type": "string", "example": "123456789" }, "requestedAmount": { "type": "number", "format": "double", "example": 10000.55 }, "accountId": { "type": "string", "example": "ACN8263457" }, "productid": { "type": "string", "example": "101" }, "channel": { "type": "string", "example": "USSD" } }, "xml": { "name": "SelectOffersRequest" } }, "SelectOffersResponse": { "type": "object", "properties": { "requestId": { "type": "string", "example": "202111170001371256908" }, "transactionId": { "type": "string", "example": "1231231321232" }, "customerId": { "type": "string", "example": "CN621868" }, "accountId": { "type": "string", "example": "ACN8263457" }, "offers": { "type": "string", "example": "ARRAY of Offers" }, "resultCode": { "type": "string", "example": "00" }, "resultDescription": { "type": "string", "example": "Successful" } }, "xml": { "name": "SelectOffersResponse" } }, "LoanInformationRequest": { "type": "object", "properties": { "transactionId": { "type": "string", "example": "Tr201712RK9232P115" }, "resultDescription": { "type": "string", "example": "Successful" }, "customerId": { "type": "string", "example": "CN621868" }, "msisdn": { "type": "string", "example": "3451342" }, "channel": { "type": "string", "example": "USSD" } }, "xml": { "name": "LoanInformationRequest" } }, "LoanInformationResponse": { "type": "object", "properties": { "transactionId": { "type": "string", "example": "Tr201712RK9232P115" }, "resultDescription": { "type": "string", "example": "Successful" }, "resultCode": { "type": "string", "example": "00" }, "customerId": { "type": "string", "example": "CN621868" }, "loan": { "type": "string", "example": "Arrray of loans" } }, "xml": { "name": "LoanInformationResponse" } }, "RepaymentRequest": { "type": "object", "properties": { "$type": { "type": "string", "example": "RepaymentRequest" }, "msisdn": { "type": "string", "example": "3451342" }, "debtId": { "type": "string", "example": "273194670" }, "productId": { "type": "string", "example": "101" }, "transactionId": { "type": "string", "example": "20171209232115" }, "customerId": { "type": "string", "example": "CN621868" }, "channel": { "type": "string", "example": "USSD" } }, "required": [ "$type", "msisdn", "debtId", "productId", "transactionId", "customerId", "channel" ] }, "RepaymentResponse": { "type": "object", "properties": { "customerId": { "type": "string", "example": "CN621868" }, "productId": { "type": "string", "example": "101" }, "debtId": { "type": "string", "example": "273194670" }, "resultCode": { "type": "string", "example": "00" }, "resultDescription": { "type": "string", "example": "Successful" } }, "required": [ "customerId", "productId", "debtId", "resultCode", "resultDescription" ] }, "RACCheckRequest": { "type": "object", "properties": { "transactionId": { "type": "string", "example": "T001" }, "fbnTransactionId": { "type": "string", "example": "Tr201712RK9232P115" }, "customerId": { "type": "string", "example": "CN621868" }, "accountId": { "type": "string", "example": "2017821799" }, "RAC_Array": { "type": "string", "example": "XXX" } }, "xml": { "name": "RACCheckRequest" } }, "RACCheckResponse": { "type": "object", "properties": { "resultCode": { "type": "string", "example": "00" }, "RACResponse": { "type": "object", "properties": { "Salary account": { "type": "string", "example": "1" }, "BVN": { "type": "string", "example": "1" }, "BVNAttachedtoAccount": { "type": "string", "example": "1" }, "CRMS": { "type": "string", "example": "1" }, "CRC": { "type": "string", "example": "1" }, "AccountStatus": { "type": "string", "example": "1" }, "Lien": { "type": "string", "example": "1" }, "NoBouncedCheck": { "type": "string", "example": "1" }, "Whitelist": { "type": "string", "example": "1" }, "NoPastDueSalaryLoan": { "type": "string", "example": "1" }, "NoPastDueOtherLoan": { "type": "string", "example": "1" } } }, "resultDescription": { "type": "string", "example": "RAC Check Successful" } }, "xml": { "name": "RACCheckResponse" } }, "CustomerConsentRequest": { "type": "object", "properties": { "$type": { "type": "string", "example": "CustomerConsentRequest" }, "transactionId": { "type": "string", "example": "20171209232177" }, "customerId": { "type": "string", "example": "CN621868" }, "accountId": { "type": "string", "example": "ACN8263457" }, "requestTime": { "type": "string", "format": "date-time", "example": "2019-10-18 14:26:21.063" }, "consentType": { "type": "string", "example": "Revoke" }, "channel": { "type": "string", "example": "USSD" } }, "required": [ "$type", "transactionId", "customerId", "accountId", "requestTime", "consentType", "channel" ] }, "CustomerConsentResponse": { "type": "object", "properties": { "resultCode": { "type": "string", "example": "00" }, "resultDescription": { "type": "string", "example": "Request is received" } }, "required": [ "resultCode", "resultDescription" ] }, "DisbursementRequest": { "type": "object", "properties": { "transactionId": { "type": "string", "example": "T001" }, "TransactionId": { "type": "string", "example": "Tr201712RK9232P115" }, "debtId": { "type": "string", "example": "273194670" }, "customerId": { "type": "string", "example": "CN621868" }, "accountId": { "type": "string", "example": "2017821799" }, "productId": { "type": "string", "example": "101" }, "provideAmount": { "type": "number", "format": "double", "example": 100000.0 }, "collectAmountInterest": { "type": "number", "format": "double", "example": 5000.0 }, "collectAmountMgtFee": { "type": "number", "format": "double", "example": 1000.0 }, "collectAmountInsurance": { "type": "number", "format": "double", "example": 1000.0 }, "collectAmountVAT": { "type": "number", "format": "double", "example": 75.0 }, "countryId": { "type": "string", "example": "01" }, "comment": { "type": "string", "example": "Testing LoanRequest" } }, "required": [ "transactionId", "TransactionId", "debtId", "customerId", "accountId", "productId", "provideAmount", "collectAmountInterest", "collectAmountMgtFee", "collectAmountInsurance", "collectAmountVAT", "countryId", "comment" ] }, "DisbursementResponse": { "type": "object", "properties": { "transactionId": { "type": "string", "example": "T001" }, "TransactionId": { "type": "string", "example": "Tr201712RK9232P115" }, "debtId": { "type": "string", "example": "273194670" }, "customerId": { "type": "string", "example": "CN621868" }, "accountId": { "type": "string", "example": "2017821799" }, "productId": { "type": "string", "example": "101" }, "provideAmount": { "type": "number", "format": "double", "example": 100000.0 }, "collectAmountInterest": { "type": "number", "format": "double", "example": 5000.0 }, "collectAmountMgtFee": { "type": "number", "format": "double", "example": 1000.0 }, "collectAmountInsurance": { "type": "number", "format": "double", "example": 1000.0 }, "collectAmountVAT": { "type": "number", "format": "double", "example": 75.0 }, "countryId": { "type": "string", "example": "01" }, "resultCode": { "type": "string", "example": "00" }, "resultDescription": { "type": "string", "example": "Loan Request Completed Successfully!" } }, "required": [ "transactionId", "TransactionId", "debtId", "customerId", "accountId", "productId", "provideAmount", "collectAmountInterest", "collectAmountMgtFee", "collectAmountInsurance", "collectAmountVAT", "countryId", "resultCode", "resultDescription" ] }, "CollectLoanRequest": { "type": "object", "properties": { "transactionId": { "type": "string", "example": "T002" }, "debtId": { "type": "string", "example": "273194670" }, "customerId": { "type": "string", "example": "CN621868" }, "accountId": { "type": "string", "example": "2017821799" }, "productId": { "type": "string", "example": "101" }, "collectAmount": { "type": "number", "format": "double", "example": 80000.0 }, "penalCharge": { "type": "number", "format": "double", "example": 0.0 }, "collectionMethod": { "type": "integer", "example": 1 }, "lienAmount": { "type": "number", "format": "double", "example": 80000.0 }, "countryId": { "type": "string", "example": "01" }, "comment": { "type": "string", "example": "Testing CollectionLoanRequest" } }, "required": [ "transactionId", "debtId", "customerId", "accountId", "productId", "collectAmount", "penalCharge", "collectionMethod", "lienAmount", "countryId", "comment" ] }, "CollectLoanResponse": { "type": "object", "properties": { "transactionId": { "type": "string", "example": "T002" }, "debtId": { "type": "string", "example": "273194670" }, "customerId": { "type": "string", "example": "CN621868" }, "accountId": { "type": "string", "example": "2017821799" }, "productId": { "type": "string", "example": "101" }, "collectAmount": { "type": "number", "format": "double", "example": 60000.0 }, "penalCharge": { "type": "number", "format": "double", "example": 0.0 }, "lienAmount": { "type": "number", "format": "double", "example": 20000.0 }, "countryId": { "type": "string", "example": "01" }, "comment": { "type": "string", "example": "Testing CollectionLoanRequest" }, "resultCode": { "type": "string", "example": "00" }, "resultDescription": { "type": "string", "example": "Loan Collection Successful" } }, "required": [ "transactionId", "debtId", "customerId", "accountId", "productId", "collectAmount", "penalCharge", "lienAmount", "countryId", "comment", "resultCode", "resultDescription" ] }, "TransactionVerifyRequest": { "type": "object", "properties": { "counter": { "type": "string" }, "TransactionId": { "type": "string" }, "RequestId": { "type": "string" }, "customerId": { "type": "string" }, "accountId": { "type": "string" }, "countryId": { "type": "string" }, "transactionType": { "type": "string" } }, "required": ["counter", "TransactionId", "RequestId", "customerId", "accountId", "countryId", "transactionType"] }, "TransactionVerifyResponse": { "type": "object", "properties": { "$type": { "type": "string" }, "nativeId": { "type": "string" }, "customerId": { "type": "string" }, "accountId": { "type": "string" }, "providedAmount": { "type": "number" }, "collectedAmount": { "type": "number" }, "resultCode": { "type": "string" }, "resultDescription": { "type": "string" } }, "required": ["$type", "nativeId", "customerId", "accountId", "providedAmount", "collectedAmount", "resultCode", "resultDescription"] }, "PenalChargeRequest": { "type": "object", "properties": { "transactionId": { "type": "string" }, "fbnTransactionId": { "type": "string" }, "debtId": { "type": "string" }, "customerId": { "type": "string" }, "accountId": { "type": "string" }, "penalCharge": { "type": "number" }, "lienAmount": { "type": "number" }, "countryId": { "type": "string" }, "comment": { "type": "string" } }, "required": ["transactionId", "fbnTransactionId", "debtId", "customerId", "accountId", "penalCharge", "lienAmount", "countryId", "comment"] }, "PenalChargeResponse": { "type": "object", "properties": { "resultCode": { "type": "string" }, "resultDescription": { "type": "string" } }, "required": ["resultCode", "resultDescription"] }, "ApiResponse": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "message": { "type": "string" } }, "xml": { "name": "##default" } } }, "securitySchemes": { "petstore_auth": { "type": "oauth2", "flows": { "implicit": { "authorizationUrl": "https://petstore3.swagger.io/oauth/authorize", "scopes": { "write:pets": "modify pets in your account", "read:pets": "read your pets" } } } }, "api_key": { "type": "apiKey", "name": "api_key", "in": "header" } } } }