e. Debit Lien<\/h3>\n\n\n\n

This describes the request and response for the debit lien. It will be good to explain that the amount in the debit lien request can be different from the amount that was placed on lien.<\/p>\n\n\n\n

This means that there are 3 main cases here;<\/p>\n\n\n\n

1. where the debit lien amount is equal to the amount placed on lien<\/li>
2. where the debit lien amount is greater than the amount placed on lien<\/li>
3. where the debit lien amount is lesser than the amount placed on lien<\/li><\/ol>\n\n\n\n

   Each of these cases are handled differently as explained below;<\/p>\n\n\n\n

   1. when the debit lien amount is equal to the amount placed on lien, then the amount is just debited.<\/li>
   2. when the debit lien amount is greater than the amount that was placed on lien, in this case the customer’s total balance (balance + amount placed on lien) is computed and if this total balance is greater than or equal to the debit lien amount, then the amount is debited and a success response code is returned. But if this total balance is less than the debit lien amount, then an insufficient fund response is returned.<\/li>
   3. when the debit lien amount is less than the amount that was placed on lien, in this case the debit lien amount is just debited from the placed lien and the remaining lien amount returned to the customer’s balance. A special case to this can be when the debit lien amount is 0, this is also very possible and in fact is how the placed lien is reverted. In the case of a 0 amount, the placed lien is just removed and the place lien amount added back to the customer’s balance.  <\/li><\/ol>\n\n\n\n

      Request<\/strong><\/p>\n\n\n\n

      POST \/lien\/debit<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\n Request attributes<\/h4>\n\n\n\n Attribute<\/th> Type<\/th> Description<\/th> Required<\/th><\/tr><\/thead> requestId<\/td> String<\/td> A unique id for every request sent across. Very necessary for the mac<\/td> True<\/td><\/tr> walletId<\/td> String<\/td> The wallet id of the wallet to debit lien on<\/td> True<\/td><\/tr> amount<\/td> Long<\/td> The actual amount to be debited, in minor. Amount can also be 0, in which case the lien is removed and no value is debited.<\/td> True<\/td><\/tr> transactionReference<\/td> String<\/td> The reference that can be used to retrieve the transaction. The transaction reference is the same as the transaction reference of the request that places the lien.<\/td> True<\/td><\/tr> mac<\/td> String<\/td> The hash included in every request that is used to make sure the request is fromthe actual source, and has not been tampered with<\/td> True<\/td><\/tr> transactionDateTime<\/td> LocalDateTime<\/td> This is the date and time the transaction occurred<\/td> False<\/td><\/tr> terminalId<\/td> String<\/td> This is an identifier for the terminal the transaction came from<\/td> True<\/td><\/tr> terminalType<\/td> String<\/td> A 2 digit string that defines the type of terminal.<\/td> True<\/td><\/tr> merchantId<\/td> String<\/td> The merchant that accepted the card<\/td> True<\/td><\/tr> acquiringInstitutionId<\/td> String<\/td> An id to identify the institution that acquired the transaction<\/td> False<\/td><\/tr> currencyCode<\/td> String<\/td> A code that identifies the currency the transaction was done on<\/td> True<\/td><\/tr> cardAcceptorNameLocation<\/td> String<\/td> The name and location of the card acceptor<\/td> True<\/td><\/tr> rrn<\/td> String<\/td> This is the Retrieval Ref Number<\/td> True<\/td><\/tr> stan<\/td> String<\/td> This is the System Trace Audit Number<\/td> True<\/td><\/tr><\/tbody><\/table>\n\n\n\n Request Mac<\/h5>\n\n\n\n The request mac is generated by concatenating the following attributes in the order which they occur, generate a HMAC using the shared private key and get the hex string of the result. More details about the MAC in section 1.0<\/p>\n\n\n\n transactionReference<\/em><\/p>\n\n\n\n requestId<\/em><\/p>\n\n\n\n walletId<\/em><\/p>\n\n\n\n rrn<\/em><\/p>\n\n\n\n stan<\/em><\/p>\n\n\n\n amount<\/em><\/p>\n\n\n\n currencyCode<\/em><\/p>\n\n\n\n Response atrributes<\/h4>\n\n\n\n Attribute<\/th> Type<\/th> Description<\/th> Required<\/th><\/tr><\/thead> requestId<\/td> String<\/td> The request id that came with the request.<\/td> True<\/td><\/tr> responseCode<\/td> String<\/td> The code that signifies the status of the operation.<\/td> True<\/td><\/tr> amount<\/td> Long<\/td> The amount that came with the request.<\/td> True<\/td><\/tr> transactionReference<\/td> String<\/td> The reference that came with the request<\/td> True<\/td><\/tr> mac<\/td> String<\/td> The hash included in every response that is used to make sure the request is fromthe actual source it should be and has not been tampered with<\/td> True<\/td><\/tr><\/tbody><\/table>\n\n\n\n Response Mac<\/h5>\n\n\n\n The response mac is generated by concatenating the following attributes in the order which they occur, generate a HMAC using the shared private key and get the hex string of the result. More details about the MAC in section 1.0<\/p>\n\n\n\n transactionReference<\/em><\/p>\n\n\n\n requestId<\/em><\/p>\n\n\n\n responseCode<\/em><\/p>\n\n\n\n Sample requests<\/h4>\n\n\n\n The sample requests for the debit only covers for 3 scenarios. It should be noted that the difference with a response from the other is just the response code. The response code table in section 4.0 can be used to know the response code that can be used for other scenarios that might not be covered in the sample requests.<\/p>\n\n\n\n Successful<\/h5>\n\n\n\n Request<\/strong><\/p>\n\n\n\n {\"requestId\":\u00a0\"1fds5d6f7g8hijokmojih6f5d\",<\/code> \"walletId\":\u00a0\"1234567894\",\"amount\":\u00a0100,<\/code> \"transactionReference\":\u00a0\"11123456789\",<\/code> \"mac\":\u00a0\"hexdigest\",<\/code> \"transactionDateTime\":\u00a0\"2020-05-15T13:32:09\",<\/code> \"terminalId\":\u00a0\"3IWPDVNA\",\"terminalType\":\u00a0\"21\",<\/code> \"merchantId\":\u00a0\"WEBPAYDIRECTVNA\",<\/code> \"acquiringInstitutionId\":\u00a0\"428051043\",<\/code> \"currencyCode\":\u00a0\"566\",<\/code> \"cardAcceptorNameLocation\":\u00a0\"MATRIX ENERGY LIMITE\u00a0\u00a0 LA\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 LANG\",<\/code> \"rrn\"<\/code>\u00a0:\u00a0\"000111000111\",<\/code> \"stan\"<\/code>\u00a0:\u00a0\"000018\"}<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\n Response<\/strong><\/p>\n\n\n\n {<\/code>\"amount\"<\/code>: <\/code>100<\/code>,<\/code>\"responseCode\"<\/code>: <\/code>\"00\"<\/code>,<\/code>\"transactionReference\"<\/code>: <\/code>\"11123456789\"<\/code>,<\/code>\"requestId\"<\/code>: <\/code>\"1\"<\/code>,<\/code>\"mac\"<\/code>: <\/code>\"hexdigest\"<\/code>}<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\n Invalid mac<\/h5>\n\n\n\n Request<\/strong><\/p>\n\n\n\n {\"requestId\": \"1fds5d6f7g8hijokmojih6f5d\",<\/code> \"walletId\": \"1234567894\",\"amount\": 1000,\"transactionReference\": \"11123456789\",<\/code> \"mac\": \"hexdigest\",<\/code> \"transactionDateTime\": \"2020-05-15T13:32:09\",<\/code> \"terminalId\": \"3IWPDVNA\",\"terminalType\": \"21\",<\/code> \"merchantId\": \"WEBPAYDIRECTVNA\",<\/code> \"acquiringInstitutionId\": \"428051043\",<\/code> \"currencyCode\": \"566\",<\/code> \"cardAcceptorNameLocation\": \"MATRIX ENERGY LIMITE   LA           LANG\",\"rrn\"<\/code> : \"000111000111\",<\/code> \"stan\"<\/code> : \"000018\"}<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\n Response<\/strong><\/p>\n\n\n\n {<\/code>\"amount\"<\/code>: <\/code>1000<\/code>,<\/code>\"responseCode\"<\/code>: <\/code>\"12\"<\/code>,<\/code>\"transactionReference\"<\/code>: <\/code>\"11123456789\"<\/code>,<\/code>\"requestId\"<\/code>: <\/code>\"1\"<\/code>,<\/code>\"mac\"<\/code>: <\/code>\"hexdigest\"<\/code>}<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\n Insufficient funds<\/h5>\n\n\n\n Request<\/strong><\/p>\n\n\n\n {\"requestId\":\u00a0\"1fds5d6f7g8hijokmojih6f5d\",\"walletId\":\u00a0\"1234567894\",\"amount\":\u00a01000,\"transactionReference\":\u00a0\"11123456789\",<\/code> \"mac\":\u00a0\"hexdigest\",\"transactionDateTime\":\u00a0\"2020-05-15T13:32:9\",<\/code> \"terminalId\":\u00a0\"3IWPDVNA\",\"terminalType\":\u00a0\"21\",<\/code> \"merchantId\":\u00a0\"WEBPAYDIRECTVNA\",<\/code> \"acquiringInstitutionId\":\u00a0\"428051043\",<\/code> \"currencyCode\":\u00a0\"566\",<\/code> \"cardAcceptorNameLocation\":\u00a0\"MATRIX ENERGY LIMITE\u00a0\u00a0 LA\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 LANG\",\"rrn\"<\/code>\u00a0:\u00a0\"000111000111\",<\/code> \"stan\"<\/code>\u00a0:\u00a0\"000018\"}<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\n Response<\/strong><\/p>\n\n\n\n {<\/code>\"amount\"<\/code>: <\/code>1000<\/code>,<\/code>\"responseCode\"<\/code>: <\/code>\"51\"<\/code>,<\/code>\"transactionReference\"<\/code>: <\/code>\"11123456789\"<\/code>,<\/code>\"requestId\"<\/code>: <\/code>\"1\"<\/code>,<\/code>\"mac\"<\/code>: <\/code>\"hexdigest\"<\/code>}<\/code><\/td><\/tr><\/tbody><\/table>\n","protected":false},"author":228,"featured_media":0,"parent":4162,"menu_order":4,"comment_status":"open","ping_status":"closed","template":"","meta":{"spay_email":""},"doc_tag":[],"_links":{"self":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/4175"}],"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\/228"}],"replies":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/comments?post=4175"}],"version-history":[{"count":4,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/4175\/revisions"}],"predecessor-version":[{"id":4299,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/4175\/revisions\/4299"}],"up":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/4162"}],"prev":[{"title":"Place Lien","link":"https:\/\/sandbox.interswitchng.com\/docbase\/docs\/fintech-card-processing-spec-document\/api-specification\/place-lien\/","href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/4172"}],"wp:attachment":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/media?parent=4175"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/doc_tag?post=4175"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}