A bulk Token batch status message is a request to inquire about the status of the bulk token already generated. Please request the context URL from Interswitch.<\/p>\n

7.1 Bulk Token Batch Status Request (Sent from Third-party)<\/strong>
\nThe following describes the important element required to be sent for a Cancel Token request.<\/p>\n\n\n\n\n\n

S\/N<\/strong><\/td>\n	Data Element (DE)<\/strong><\/td>\n	\u00a0<\/strong><\/td>\n	Description<\/strong><\/td>\n<\/tr>\n
1<\/td>\n	referenceId<\/td>\n	Mandatory<\/td>\n	Original Transaction Ref used in token generation call. E.g. 324555<\/td>\n<\/tr>\n
2<\/td>\n	frontEndPartner<\/td>\n	Mandatory<\/td>\n	Front End Partner ID sent in token generation call<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n  <\/p>\n Sample Request<\/strong><\/p>\n\n\n\n GET \u00a0{context}\/pwm\/bulk\/tokens\/comprehensive\/status?referenceId=1234566&frontEndPartner=455<\/p>\n Content-Type: application\/json<\/p>\n [Other HTTP headers]\u2026<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n  <\/p>\n 7.2 Bulk Token Batch Status Response (Sent from Interswitch)<\/strong><\/p>\n The following describes the important data element required for a Bulk Token Batch Status response.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n S\/N<\/strong><\/td>\n Data Element (DE)<\/strong><\/td>\n Description<\/strong><\/td>\n<\/tr>\n 1<\/td>\n summary<\/td>\n Parent element for batchReference, numberOfsuccessful,numberOfFailed,amountOfFailed,amountOfSuccessful<\/td>\n<\/tr>\n 2<\/td>\n batchReference<\/td>\n This is the unique referenceId used in the bulk token request message.<\/td>\n<\/tr>\n 3<\/td>\n numberOfSuccessful<\/td>\n This shows the number of tokens successfully generated<\/td>\n<\/tr>\n 4<\/td>\n numberOfFailed<\/td>\n This shows the number of tokens that failed during generation<\/td>\n<\/tr>\n 5<\/td>\n amountOfFailed<\/td>\n This sums up the amount in the failed tokens<\/td>\n<\/tr>\n 6<\/td>\n amountOfSuccessful<\/td>\n This sums up the amount in the successful tokens<\/td>\n<\/tr>\n 7<\/td>\n successful<\/td>\n This is the parent element to surcharge, amount, beneficiaryNumber, oneTimePin of the successful tokens<\/td>\n<\/tr>\n 8<\/td>\n Failed<\/td>\n This is the parent element to surcharge, amount, beneficiaryNumber, oneTimePin of the failed tokens<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n  <\/p>\n Successful Response<\/p>\n\n\n\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 HTTP Status Code:\u00a0 200<\/p>\n  <\/p>\n {<\/p>\n “summary”: {<\/p>\n “batchReference”: “123456”,<\/p>\n “numberOfSuccessful”: “10”,<\/p>\n “numberOfFailed”: “0”,<\/p>\n “amountOfFailed”: “0”,<\/p>\n “amountOfSuccessful”: “4300000”<\/p>\n },<\/p>\n “successful”: [<\/p>\n {<\/p>\n “surcharge”: “”,<\/p>\n “amount”: “400000”,<\/p>\n “beneficiaryNumber”: “08021111111”,<\/p>\n “oneTimePin”: “4321”<\/p>\n },<\/p>\n {<\/p>\n “surcharge”: “”,<\/p>\n “amount”: “300000”,<\/p>\n “beneficiaryNumber”: “08021111112”,<\/p>\n “oneTimePin”: “1234”<\/p>\n },<\/p>\n {<\/p>\n “surcharge”: “”,<\/p>\n “amount”: “500000”,<\/p>\n “beneficiaryNumber”: “08021111113”,<\/p>\n “oneTimePin”: “1234”<\/p>\n },<\/p>\n {<\/p>\n “surcharge”: “”,<\/p>\n “amount”: “400000”,<\/p>\n “beneficiaryNumber”: “08021111114”,<\/p>\n “oneTimePin”: “1234”<\/p>\n },<\/p>\n {<\/p>\n “surcharge”: “”,<\/p>\n “amount”: “300000”,<\/p>\n “beneficiaryNumber”: “08021111115”,<\/p>\n “oneTimePin”: “1234”<\/p>\n },<\/p>\n {<\/p>\n “surcharge”: “”,<\/p>\n “amount”: “500000”,<\/p>\n “beneficiaryNumber”: “08021111116”,<\/p>\n “oneTimePin”: “1234”<\/p>\n },<\/p>\n {<\/p>\n “surcharge”: “”,<\/p>\n “amount”: “500000”,<\/p>\n “beneficiaryNumber”: “08021111117”,<\/p>\n “oneTimePin”: “1234”<\/p>\n },<\/p>\n {<\/p>\n “surcharge”: “”,<\/p>\n “amount”: “400000”,<\/p>\n “beneficiaryNumber”: “08021111118”,<\/p>\n “oneTimePin”: “1234”<\/p>\n },<\/p>\n {<\/p>\n “surcharge”: “”,<\/p>\n “amount”: “500000”,<\/p>\n “beneficiaryNumber”: “08021111119”,<\/p>\n “oneTimePin”: “1234”<\/p>\n },<\/p>\n {<\/p>\n “surcharge”: “”,<\/p>\n “amount”: “500000”,<\/p>\n “beneficiaryNumber”: “08021111110”,<\/p>\n “oneTimePin”: “1234”<\/p>\n }<\/p>\n ]<\/p>\n }<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n  <\/p>\n Unsuccessful Response<\/p>\n\n\n\n HTTP Status Code: 401<\/p>\n  <\/p>\n {<\/p>\n “errors”: [<\/p>\n {<\/p>\n “code”: “10904”,<\/p>\n “message”: “No record of batch with provided reference Id – 123456778 for the front end partner – 455”<\/p>\n }<\/p>\n ],<\/p>\n “error”: {<\/p>\n “code”: “10904”,<\/p>\n “message”: “No record of batch with provided reference Id – 123456778 for the front end partner – 455”<\/p>\n }<\/p>\n }<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n  <\/p>\n  <\/p>\n  <\/p>\n  <\/p>\n  <\/p>\n  <\/p>\n  <\/p>\n  <\/p>\n  <\/p>\n  <\/p>\n  <\/p>\n  <\/p>\n  <\/p>\n  <\/p>\n  <\/p>\n  <\/p>\n  <\/p>\n","protected":false},"author":169,"featured_media":0,"parent":554,"menu_order":2,"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\/582"}],"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=582"}],"version-history":[{"count":2,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/582\/revisions"}],"predecessor-version":[{"id":585,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/582\/revisions\/585"}],"up":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/554"}],"next":[{"title":"Bulk Token Batch Cancel","link":"https:\/\/sandbox.interswitchng.com\/docbase\/docs\/paycode\/bulk-paycode\/bulk-token-batch-cancel\/","href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/583"}],"prev":[{"title":"BULK PAYCODE - API","link":"https:\/\/sandbox.interswitchng.com\/docbase\/docs\/paycode\/bulk-paycode\/bulk-paycode-api\/","href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/557"}],"wp:attachment":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/media?parent=582"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/doc_tag?post=582"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}