This method allows Interswitch Bill Payment Platforms to validate third party customer information before a payment is made.<\/p>\n

Note<\/u><\/strong><\/p>\n

\n
1. Interswitch Bill Payment platforms would communicate to third party platforms via HTTP Post<\/strong>.<\/li>\n
2. The data sent via HTTP Post will be xml, hence the content type is text\/xml<\/strong>.<\/li>\n
3. The request message will not be in a parameter but a raw post directly to stream.<\/li>\n
4. In cases where you choose to implement Customer Validation and Payment Notification (see section 2.1), you are expected to provide Interswitch with a single url<\/strong> that accepts both message.<\/li>\n
5. Ensure CamelCase naming convention is used for the field returned in the xml<\/li>\n
6. See Appendix 9.0 for the process flow of Customer Validation<\/li>\n<\/ol>\n

   CustomerInformationRequest Fields<\/strong><\/h3>\n

   This defines the expected xml tags that will be sent to third party systems for Customer Validation. This is a generic system and new tags can be added at any time, do not hard code the structure of the xml requests. Your system should be able to retrieve data from the required fields and ignore others.<\/p>\n\n\n\n\n\t\n\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t

   Field<\/th>	Mandatory\/Optional<\/th>	Length<\/th>	Format<\/th>	Description<\/th>\n<\/tr>\n<\/thead>\n
   ServiceUrl<\/td>	Mandatory<\/td>	ANY<\/td>	Alphanumeric<\/td>	Third party platform service url<\/td>\n<\/tr>\n
   ServiceUsername <\/td>	Optional<\/td>	ANY <\/td>	Alphanumeric <\/td>	Username to access Service at Merchant\u2019s end <\/td>\n<\/tr>\n
   ServicePassword <\/td>	Optional<\/td>	ANY <\/td>	Alphanumeric <\/td>	Password to access Service at Merchant\u2019s end <\/td>\n<\/tr>\n
   FTPUrl<\/td>	Optional<\/td>	ANY<\/td>	Alphanumeric<\/td>	Third Party platform FTP Location<\/td>\n<\/tr>\n
   FTPUsername <\/td>	Optional<\/td>	ANY <\/td>	Alphanumeric <\/td>	Username to access FTP Location at Third Party\u2019s end <\/td>\n<\/tr>\n
   FTPPassword <\/td>	Optional<\/td>	ANY <\/td>	Alphanumeric <\/td>	Password to access FTP Location at Third Party\u2019s end <\/td>\n<\/tr>\n
   MerchantReference <\/td>	Mandatory<\/td>	ANY <\/td>	Alphanumeric <\/td>	Unique ID given by Interswitch to the client using the bill payment solution <\/td>\n<\/tr>\n
   CustReference <\/td>	Mandatory<\/td>	ANY <\/td>	Alphanumeric <\/td>	Unique ID for the paying customer or specific order. Typically provided to the paying customer by the merchant <\/td>\n<\/tr>\n
   PaymentItemCategoryCode<\/td>	Optional<\/td>	10<\/td>	Alphanumeric<\/td>	Agreed code used to group items customers can pay for<\/td>\n<\/tr>\n
   PaymentItemCode <\/td>	Optional<\/td>	10<\/td>	Alphanumeric <\/td>	This is an agreed code indicating the item that the customer has indicated he wants to pay for. <\/td>\n<\/tr>\n
   TerminalId<\/td>	Optional<\/td>	8<\/td>	Alphanumeric<\/td>	Unique identifier for Terminal<\/td>\n<\/tr>\n
   Amount<\/td>	Optional<\/td>	ANY<\/td>	Numeric<\/td>	Amount to be paid, NB: You must return amount has 0, when customers can pay for any amount<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n Sample Customer Validation Request<\/strong><\/h3>\n This shows the sample request message that would be sent to third-party systems to validate a unique customer identified with the CustReference. The PaymentItemCode is the specific item the customer wants to pay for. Note that additional tags can be added at any time, ensure your system does not break due to this.<\/p>\n\n\n\n\n \n Customer Validation Request<\/h5>\n<\/th>\n \n Customer Validation Response without Payment Item<\/h5>\n<\/th>\n<\/tr>\n \n <CustomerInformationRequest>\r\n <ServiceUsername><\/ServiceUsername>\r\n <ServicePassword><\/ServicePassword>\r\n <MerchantReference>6405<\/MerchantReference>\r\n <CustReference>111111117<\/CustReference>\r\n <PaymentItemCode>01<\/PaymentItemCode>\r\n <ThirdPartyCode><\/ThirdPartyCode>\r\n<\/CustomerInformationRequest><\/pre>\n<\/td>\n \n <CustomerInformationResponse>\r\n <MerchantReference>6405<\/MerchantReference>\r\n <Customers>\r\n <Customer>\r\n <Status>0<\/Status>\r\n <CustReference>111111117<\/CustReference>\r\n <CustomerReferenceAlternate><\/CustomerReferenceAlternate>\r\n <FirstName>test test<\/FirstName>\r\n <LastName><\/LastName>\r\n <Email><\/Email>\r\n <Phone><\/Phone>\r\n <ThirdPartyCode><\/ThirdPartyCode>\r\n <Amount>0.00<\/Amount>\r\n <\/Customer>\r\n <\/Customers>\r\n<\/CustomerInformationResponse><\/pre>\n  <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n  <\/p>\n CustomerInformationResponse Fields<\/strong><\/h3>\n This defines the expected xml tags that should be returned by third party systems during Customer Validation. Interswitch Bill Payment platforms use the status to determine if it is a valid customer or not.<\/p>\n\n\n\n\n\t\n\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t Field<\/th> Mandatory\/Optional<\/th> Length<\/th> Format<\/th> Description<\/th>\n<\/tr>\n<\/thead>\n MerchantReference <\/td> Mandatory<\/td> ANY <\/td> Alphanumeric <\/td> Unique ID given by Interswitch to the client using the bill payment solution <\/td>\n<\/tr>\n Customers<\/td> Mandatory<\/td> <\/td> <\/td> Container element for a collection of Customers<\/td>\n<\/tr>\n Customer<\/td> Mandatory<\/td> <\/td> <\/td> Container element for a customer<\/td>\n<\/tr>\n Status<\/td> Mandatory<\/td> ANY<\/td> Numeric<\/td> This is a status returned indicating if the customer is valid or not. \n0 = Valid \n1 = Invalid \n2 = Expired<\/td>\n<\/tr>\n StatusMessage <\/td> Optional<\/td> ANY <\/td> Alphanumeric <\/td> Description of the Status <\/td>\n<\/tr>\n CustReference <\/td> Mandatory<\/td> ANY <\/td> Numeric <\/td> Unique ID for the paying customer or specific order. Typically provided to the paying customer by the merchant <\/td>\n<\/tr>\n CustomerReferenceAlternate <\/td> Optional<\/td> ANY <\/td> Alphanumeric <\/td> This is an alternate ID used to identify the same Customer <\/td>\n<\/tr>\n FirstName <\/td> Mandatory<\/td> ANY <\/td> Alphanumeric <\/td> This is the first name of customer <\/td>\n<\/tr>\n LastName <\/td> Optional<\/td> ANY <\/td> Alphanumeric <\/td> This is the surname of customer <\/td>\n<\/tr>\n OtherName <\/td> Optional<\/td> ANY <\/td> Alphanumeric <\/td> This is the middle name of customer <\/td>\n<\/tr>\n Email <\/td> Optional<\/td> ANY <\/td> Alphanumeric <\/td> This is the email address of the customer <\/td>\n<\/tr>\n Phone Number <\/td> Optional<\/td> ANY <\/td> Alphanumeric <\/td> This is the phone number of the customer <\/td>\n<\/tr>\n ThirdPartyCode <\/td> Optional<\/td> 10<\/td> Alphanumeric <\/td> This is a unique code agreed between both Systems to group the customer in a category. <\/td>\n<\/tr>\n Amount <\/td> Mandatory<\/td> ANY <\/td> Numeric <\/td> This is the amount customer is expected to pay. Value should be in Major denomination \nNB: Amount must be greater than 0<\/td>\n<\/tr>\n PaymentItems <\/td> Optional (Mandatory if returning payment item)<\/td> <\/td> <\/td> Container element for a collection of payment items <\/td>\n<\/tr>\n Item <\/td> Optional (Mandatory if returning payment item)<\/td> <\/td> <\/td> Container element for individual payment item <\/td>\n<\/tr>\n ProductName <\/td> Optional (Mandatory if returning payment item)<\/td> ANY <\/td> Alphanumeric <\/td> This is the name of the item that customer should\/can pay for <\/td>\n<\/tr>\n ProductCode <\/td> Optional (Mandatory if returning payment item)<\/td> ANY <\/td> Alphanumeric <\/td> This is the code of the item that the customer should\/can pay for <\/td>\n<\/tr>\n Quantity <\/td> Optional (Mandatory if returning payment item)<\/td> ANY <\/td> Numeric <\/td> This is the number of item that customer should\/can pay for <\/td>\n<\/tr>\n Price <\/td> Optional (Mandatory if returning payment item)<\/td> ANY <\/td> Numeric <\/td> This is the unit price of the item that the customer should\/can pay for <\/td>\n<\/tr>\n Subtotal <\/td> Optional (Mandatory if returning payment item)<\/td> ANY <\/td> Numeric <\/td> This is the total amount that the customer should\/can pay for LESS tax <\/td>\n<\/tr>\n Tax <\/td> Optional (Mandatory if returning payment item)<\/td> ANY <\/td> Numeric <\/td> This is the additional cost added to the original cost of the item <\/td>\n<\/tr>\n Total <\/td> Optional (Mandatory if returning payment item)<\/td> ANY <\/td> Numeric <\/td> This is the total amount that the customer should\/can pay for. <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n Sample Customer Validation Response<\/strong><\/h3>\n This shows the sample response message that would be returned from third party systems to Interswitch Bill Payment Platforms.<\/p>\n\n\n\n\n \n Customer Validation Response<\/h5>\n NB: Amount is returned as 0. meaning customers will be allowed to pay any amount.<\/th>\n \n Customer Validation Response with Payment Item<\/h5>\n NB: Use response when returned amount is greater than 0.<\/th>\n<\/tr>\n \n <CustomerInformationResponse>\r\n <MerchantReference>639<\/MerchantReference>\r\n <Customers>\r\n <Customer>\r\n <Status>0<\/Status>\r\n <CustReference>23470<\/CustReference>\r\n <CustomerReferenceAlternate><\/CustomerReferenceAlternate>\r\n <FirstName>test test<\/FirstName>\r\n <LastName><\/LastName>\r\n <Email>tester@gmail.com<\/Email>\r\n <Phone><\/Phone>\r\n <ThirdPartyCode><\/ThirdPartyCode>\r\n <Amount>0<\/Amount>\r\n <\/Customer>\r\n <\/Customers>\r\n<\/CustomerInformationResponse><\/pre>\n  <\/td>\n \n <CustomerInformationResponse>\r\n <MerchantReference>639<\/MerchantReference>\r\n <Customers>\r\n <Customer>\r\n <Status>0<\/Status>\r\n <CustReference>23470<\/CustReference>\r\n <CustomerReferenceAlternate><\/CustomerReferenceAlternate>\r\n <FirstName>test test<\/FirstName>\r\n <LastName><\/LastName>\r\n <Email>tester@gmail.com<\/Email>\r\n <Phone><\/Phone>\r\n <ThirdPartyCode><\/ThirdPartyCode>\r\n <Amount>234078<\/Amount>\r\n <PaymentItems>\r\n <Item>\r\n <ProductName>PayAtBank<\/ProductName>\r\n <ProductCode>01<\/ProductCode>\r\n <Quantity>1<\/Quantity>\r\n <Price>234078<\/Price>\r\n <Subtotal>234078<\/Subtotal>\r\n <Tax>0<\/Tax>\r\n <Total>234078<\/Total>\r\n <\/Item>\r\n <\/PaymentItems>\r\n <\/Customer>\r\n <\/Customers>\r\n<\/CustomerInformationResponse><\/pre>\n  <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n  <\/p>\n  <\/p>\n  <\/p>\n  <\/p>\n  <\/p>\n","protected":false},"author":169,"featured_media":0,"parent":884,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"spay_email":""},"doc_tag":[],"_links":{"self":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/897"}],"collection":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/users\/169"}],"replies":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/comments?post=897"}],"version-history":[{"count":37,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/897\/revisions"}],"predecessor-version":[{"id":3195,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/897\/revisions\/3195"}],"up":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/884"}],"next":[{"title":"Payment Notification","link":"https:\/\/sandbox.interswitchng.com\/docbase\/docs\/paydirect\/rest-service-api\/payment-notification\/","href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/898"}],"wp:attachment":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/media?parent=897"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/doc_tag?post=897"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}