Generate Bulk Token Request (Sent from Third-party)<\/strong>
\nThe following describes the important element required to be sent for a Bulk Generate Token request.<\/h4>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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	subscriberId<\/td>\n	Mandatory<\/td>\n	Customer ID. E.g. 2348012233220<\/td>\n<\/tr>\n
2<\/td>\n	paymentMethodCode<\/td>\n	Mandatory<\/td>\n	A unique Identifier of payment instrument issuer e.g. GTMM, FBN. See Payment Methods in Appendix B<\/td>\n<\/tr>\n
3<\/td>\n	frontEndPartnerId<\/td>\n	Mandatory<\/td>\n	A unique Identifier of App developer e.g. GTMM. See Front End Partners in Appendix B<\/td>\n<\/tr>\n
4<\/td>\n	tokenLifeTimeInMinutes<\/td>\n	Mandatory<\/td>\n	The time this Paycode token should expire<\/td>\n<\/tr>\n
5<\/td>\n	channel<\/td>\n	Mandatory<\/td>\n	Paycode channel. This can either be ATM, POS, Agent and WEB. See Paycode Channels in Appendix B<\/td>\n<\/tr>\n
6<\/td>\n	amount<\/td>\n	Conditional<\/td>\n	Transaction amount.\u00a0 If payWithMobileChannel is ATM, this is Mandatory, if it is POS the purchase amount (the amount entered during transaction with Paycode) cannot be higher than this value<\/td>\n<\/tr>\n
7<\/td>\n	ttid<\/td>\n	Mandatory<\/td>\n	Terminal Transaction ID. A unique generated id sent from the client application.<\/td>\n<\/tr>\n
8<\/td>\n	oneTimePin<\/td>\n	Conditional<\/td>\n	The one time PIN to be used to cashout Paycode at ATM. This value is\u00a0 Mandatory for ATM Cashout<\/td>\n<\/tr>\n
9<\/td>\n	secure<\/td>\n	Conditional<\/td>\n	This contains payment method code authorization information. This field is Mandatory if the payment method authenticated by PIN.<\/td>\n<\/tr>\n
10<\/td>\n	pinBlock<\/td>\n	Mandatory<\/td>\n	This contains the encrypted payment method PIN. This field is Mandatory if the payment method is authenticated by PIN.<\/td>\n<\/tr>\n
11<\/td>\n	macData<\/td>\n	Mandatory<\/td>\n	This contains the MAC of some sensitive data. This field is Mandatory if the payment method is authenticated by PIN.<\/td>\n<\/tr>\n
12<\/td>\n	referenceId<\/td>\n	Mandatory<\/td>\n	Unique reference id. To be used as unique identifier to each bulk token generation request.<\/td>\n<\/tr>\n
13<\/td>\n	beneficiaryNumber<\/td>\n	Mandatory<\/td>\n	Mobile number of token beneficiary<\/td>\n<\/tr>\n
14<\/td>\n	entries<\/td>\n	Mandatory<\/td>\n	This array contains the amount, beneficiaryNumber and oneTimePin for each token<\/td>\n<\/tr>\n
15<\/td>\n	batchSize<\/td>\n	Mandatory<\/td>\n	This shows the total number of token intended to generate. NB. Only a maximum of 10 token can be generated at a time.<\/td>\n<\/tr>\n
16<\/td>\n	additionalInfo<\/td>\n	Mandatory<\/td>\n	This contains a data field \u201ctype\u201d to specify that the token is a bulk token request message<\/td>\n<\/tr>\n
17<\/td>\n	Type<\/td>\n	Mandatory<\/td>\n	Is a child element to additionalInfo and has a value of bulk.<\/td>\n<\/tr>\n
18<\/td>\n	clientId<\/td>\n	Mandatory<\/td>\n	Please refer to the Interswitch Service Authentication specification document.<\/td>\n<\/tr>\n
19<\/td>\n	signature<\/td>\n	Mandatory<\/td>\n	This is the SHA 512 encryption of clientId, clientSecret, referenceId and transaction date and time (YYMMDD)<\/td>\n<\/tr>\n
20<\/td>\n	sftpAuthData<\/td>\n	Mandatory<\/td>\n	See Appendix on how to calculate sftpAuthData.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n  <\/p>\n Sample Request (API)<\/strong><\/h5>\n\n\n\n POST {context}\/pwm\/bulk\/tokens<\/p>\n Content-Type: application\/json<\/p>\n [Other HTTP headers]\u2026<\/p>\n frontEndPartnerId: 455<\/p>\n  <\/p>\n {<\/p>\n “additionalInfo”: {“type”: “bulk”},<\/p>\n “amount”: “5000000”,<\/p>\n “batchSize”: 10,<\/p>\n “channel”: “ATM”,<\/p>\n “defaultOneTimePin”: “1234”,<\/p>\n “entries”:\u00a0\u00a0 [<\/p>\n {<\/p>\n “amount”: “500000”,<\/p>\n “beneficiaryNumber”: “08021111111”,<\/p>\n “oneTimePin”: “1234”<\/p>\n },<\/p>\n {<\/p>\n “amount”: “500000”,<\/p>\n “beneficiaryNumber”: “08021111112”,<\/p>\n “oneTimePin”: “1234”<\/p>\n },<\/p>\n {<\/p>\n “amount”: “500000”,<\/p>\n “beneficiaryNumber”: “08021111113”,<\/p>\n “oneTimePin”: “1234”<\/p>\n },<\/p>\n {<\/p>\n “amount”: “500000”,<\/p>\n “beneficiaryNumber”: “08021111114”,<\/p>\n “oneTimePin”: “1234”<\/p>\n },<\/p>\n {<\/p>\n “amount”: “500000”,<\/p>\n “beneficiaryNumber”: “08021111115”,<\/p>\n “oneTimePin”: “1234”<\/p>\n },<\/p>\n {<\/p>\n “amount”: “500000”,<\/p>\n “beneficiaryNumber”: “08021111116”,<\/p>\n “oneTimePin”: “1234”<\/p>\n },<\/p>\n {<\/p>\n “amount”: “500000”,<\/p>\n “beneficiaryNumber”: “08021111117”,<\/p>\n “oneTimePin”: “1234”<\/p>\n },<\/p>\n {<\/p>\n “amount”: “500000”,<\/p>\n “beneficiaryNumber”: “08021111118”,<\/p>\n “oneTimePin”: “1234”<\/p>\n },<\/p>\n {<\/p>\n “amount”: “500000”,<\/p>\n “beneficiaryNumber”: “08021111119”,<\/p>\n “oneTimePin”: “1234”<\/p>\n },<\/p>\n {<\/p>\n “amount”: “500000”,<\/p>\n “beneficiaryNumber”: “08021111110”,<\/p>\n “oneTimePin”: “1234”<\/p>\n }<\/p>\n ],<\/p>\n “macData”: “95e8f80c61bfec738894d0589b4909f9bf94070325e5c89f0f4d885f9fa49d77”,<\/p>\n “paymentMethodIdentifier”: “E192F3F3B3BA4596BC9704C44EA801BC”,<\/p>\n “pinBlock”: “2f04079406b19df1”,<\/p>\n “referenceId”: “ga323923o4702”,<\/p>\n “secure”: “79758137bcde04327126b604391649caa5bbe5016aba5bff5553842c646bfc7040c5a310f6d89ceb4d4a0c9545dc3523035a19357c99d28c7ba3cab37939295d5e010c4246534594900f8c1a03fa41215bc554aa1ea09f06d5896200d44d09d347e7042298312088a9a8ed54ed29eecddb2ad750c74713e7591006827f7860faa4419ce9b12693e820d98ffb4394229fa7fbbf7556160cd1508ce3ada3c35aded6a0a0d625a7b86f79adbb1770492c86cf098654eb9ecfb7859130191ae5aaebe210cea3e2b8f41b5023c0da0e18212c84542c4e1e411759fce29f91c8c5f9806a6df3e23e2a86b08b088d3aa1c0f07e92258bc2be1662fda0d8f3704c655ec0”,<\/p>\n “subscriberId”: “2348124888436”,<\/p>\n “tokenLifeTimeInMinutes”: “1440”,<\/p>\n “ttid”: “274”<\/p>\n }<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n  <\/p>\n Sample Request (SFTP)<\/strong><\/h5>\n  <\/p>\n\n\n\n The SFTP request message contains the following in a comma separated file (csv) in the following order.<\/p>\n frontEndPartner,subscriberId,amount,channel,tokenLifeTimeInMinutes,defaultOneTimePin,batchSize,sftpAuthData,referenceId,clientId,signature<\/p>\n 455,2348124888436,4000000,ATM,1440,5214,10,7FB54FFEE55335E615330789B23A9CA9276C8AAF8A188A16DE6F5854B9DCC6471002064A0DEB858F184F9F9FADF89D5580DAF3A45B9B17F57F5B654E4D96C6468E04C96DEE84433AAA6B59EE3ECB161DAEFDFEF112CBBF271227A0896CFB28B75E9561E939AACBC0A750442424C63534,444433322,IKIAEE38C24A363E4FC01DEBFBFE9F8DC1F4BCB2BC48,1968c2282f733e0875e820e37a1e3c0ea0cb3489747faf72836e7849f03f15e7db53cfb6c7473df37332793165d34da30780cdaa00aa9c0b3d2fc1d1ef73a8e8<\/p>\n entries<\/p>\n beneficiaryNumber, oneTimePin, amount<\/p>\n 11111111111, 4321,400000<\/p>\n 22222222222, 1234,300000<\/p>\n 33333333333, 2345,500000<\/p>\n 44444444444, 1234,400000<\/p>\n 55555555555, 4321,300000<\/p>\n 66666666666, 1234,500000<\/p>\n 77777777777, 4321,500000<\/p>\n 88888888888, 1234,100000<\/p>\n 99999999999, 4321,500000<\/p>\n 10000000000, 4321,500000<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n  <\/p>\n 6.2 Generate Bulk Token Response (Sent from Interswitch)<\/strong> \nThe following describes the important data element required for a Generate Token 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 phoneNumber<\/td>\n This is the beneficiaryNumber of the recipient of the paycode. E.g. 08021111111<\/td>\n<\/tr>\n 2<\/td>\n paymentTokens<\/td>\n This contains an array of the phoneNumber, paycode (token), smsStatus, expiry and surcharge for each beneficiaryNumber generated.<\/td>\n<\/tr>\n 3<\/td>\n payCode<\/td>\n This is the one-time access code.<\/td>\n<\/tr>\n 4<\/td>\n smsStatus<\/td>\n This indicates if an sms containing the paycode has been sent to the beneficiaryNumber<\/td>\n<\/tr>\n 5<\/td>\n expiry<\/td>\n This indicates how long the paycode has before it expires. This value is the same as the tokenLifeTimeInMinutes in the bulk token request message<\/td>\n<\/tr>\n 6<\/td>\n surcharge<\/td>\n This is the amount to be charged for each paycode when the paycode is cashed out.<\/td>\n<\/tr>\n 7<\/td>\n numberOfEntries<\/td>\n This is the number of paycodes successfully generated<\/td>\n<\/tr>\n 8<\/td>\n errorDescription<\/td>\n This contains the error message.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n  <\/p>\n Successful Response (API)<\/p>\n\n\n\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 HTTP Status Code:\u00a0 201<\/p>\n  <\/p>\n {<\/p>\n “numberOfEntries”: 10,<\/p>\n “paymentTokens”: [<\/p>\n {<\/p>\n “phoneNumber”: “08021111111”,<\/p>\n “payCode”: “12601555803”,<\/p>\n “smsStatus”: “Not Sent”,<\/p>\n “expiry”: “1440”,<\/p>\n “surcharge”: 10000<\/p>\n },<\/p>\n {<\/p>\n “phoneNumber”: “08021111112”,<\/p>\n “payCode”: “12601531357”,<\/p>\n “smsStatus”: “Not Sent”,<\/p>\n “expiry”: “1440”,<\/p>\n “surcharge”: 10000<\/p>\n },<\/p>\n {<\/p>\n “phoneNumber”: “08021111113”,<\/p>\n “payCode”: “12601382917”,<\/p>\n “smsStatus”: “Not Sent”,<\/p>\n “expiry”: “1440”,<\/p>\n “surcharge”: 10000<\/p>\n },<\/p>\n {<\/p>\n “phoneNumber”: “08021111114”,<\/p>\n “payCode”: “12601216456”,<\/p>\n “smsStatus”: “Not Sent”,<\/p>\n “expiry”: “1440”,<\/p>\n “surcharge”: 10000<\/p>\n },<\/p>\n {<\/p>\n “phoneNumber”: “08021111115”,<\/p>\n “payCode”: “12607585608”,<\/p>\n “smsStatus”: “Not Sent”,<\/p>\n “expiry”: “1440”,<\/p>\n “surcharge”: 10000<\/p>\n },<\/p>\n {<\/p>\n “phoneNumber”: “08021111116”,<\/p>\n “payCode”: “12605587175”,<\/p>\n “smsStatus”: “Not Sent”,<\/p>\n “expiry”: “1440”,<\/p>\n “surcharge”: 10000<\/p>\n },<\/p>\n {<\/p>\n “phoneNumber”: “08021111117”,<\/p>\n “payCode”: “12605531312”,<\/p>\n “smsStatus”: “Not Sent”,<\/p>\n “expiry”: “1440”,<\/p>\n “surcharge”: 10000<\/p>\n },<\/p>\n {<\/p>\n “phoneNumber”: “08021111118”,<\/p>\n “payCode”: “12601247388”,<\/p>\n “smsStatus”: “Not Sent”,<\/p>\n “expiry”: “1440”,<\/p>\n “surcharge”: 10000<\/p>\n },<\/p>\n {<\/p>\n “phoneNumber”: “08021111119”,<\/p>\n “payCode”: “12601009445”,<\/p>\n “smsStatus”: “Not Sent”,<\/p>\n “expiry”: “1440”,<\/p>\n “surcharge”: 10000<\/p>\n },<\/p>\n {<\/p>\n “phoneNumber”: “08021111110”,<\/p>\n “payCode”: “12602530509”,<\/p>\n “smsStatus”: “Not Sent”,<\/p>\n “expiry”: “1440”,<\/p>\n “surcharge”: 10000<\/p>\n }<\/p>\n ]<\/p>\n }<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n  <\/p>\n Successful Response (SFTP)<\/p>\n  <\/p>\n  <\/p>\n  <\/p>\n Unsuccessful Response (API)<\/p>\n\n\n\n HTTP Status Code: 401<\/p>\n  <\/p>\n {<\/p>\n “errors”: [<\/p>\n {<\/p>\n “code”: “E50”,<\/p>\n “message”: “PayCode is Required”<\/p>\n }<\/p>\n ],<\/p>\n “error”: {<\/p>\n “code”: “E50”,<\/p>\n “message”: “PayCode is Required”<\/p>\n }<\/p>\n }<\/p>\n  <\/p>\n HTTP Status Code:\u00a0 401<\/p>\n  <\/p>\n {<\/p>\n “errors”: [<\/p>\n {<\/p>\n “code”: “400503”,<\/p>\n “message”: “The referenced transaction does not exist”<\/p>\n }<\/p>\n ],<\/p>\n “error”: {<\/p>\n “code”: “400503”,<\/p>\n “message”: “The referenced transaction does not exist”<\/p>\n }<\/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  <\/p>\n\n\n\n HTTP Status Code:\u00a0 401<\/p>\n  <\/p>\n {<\/p>\n “errors”: [<\/p>\n {<\/p>\n “code”: “10500”,<\/p>\n “message”: “Cannot Validate Authentication Details”<\/p>\n }<\/p>\n ],<\/p>\n “error”: {<\/p>\n “code”: “10500”,<\/p>\n “message”: “Cannot Validate Authentication Details”<\/p>\n }<\/p>\n }<\/p>\n  <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n  <\/p>\n\n\n\n Comma separated value (.csv) response in the format below:<\/p>\n “batchReference”,”numberOfSuccessful”,”numberOfFailed”,”amountOfSuccessful”,”amountOfFailed”,”totalSurcharge”<\/p>\n “44443332210”,”10″,”0″,”4000000″,”0″,”100000″<\/p>\n “successful”<\/p>\n “beneficiaryNumber”,”amount”,”paycode”,”surcharge”,”expiry”,”entryId”<\/p>\n “11111111111”,”400000″,”12602835748″,”10000″,”1440″,”1″<\/p>\n “22222222222”,”300000″,”12601563843″,”10000″,”1440″,”2″<\/p>\n “33333333333”,”500000″,”12601611857″,”10000″,”1440″,”3″<\/p>\n “44444444444”,”400000″,”12609056048″,”10000″,”1440″,”4″<\/p>\n “55555555555”,”300000″,”12603487190″,”10000″,”1440″,”5″<\/p>\n “66666666666”,”500000″,”12606730320″,”10000″,”1440″,”6″<\/p>\n “77777777777”,”500000″,”12607422938″,”10000″,”1440″,”7″<\/p>\n “88888888888”,”100000″,”12607344666″,”10000″,”1440″,”8″<\/p>\n “99999999999”,”500000″,”12601665820″,”10000″,”1440″,”9″<\/p>\n “10000000000”,”500000″,”12609444075″,”10000″,”1440″,”10″<\/p>\n “failed”<\/p>\n “beneficiaryNumber”,”amount”,”errorDescription”,”entryId”<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n  <\/p>\n Unsuccessful Response (SFTP)<\/p>\n “ERROR MESSAGE”<\/p>\n “Invalid Signature”<\/p>\n","protected":false},"author":169,"featured_media":0,"parent":554,"menu_order":1,"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\/557"}],"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=557"}],"version-history":[{"count":3,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/557\/revisions"}],"predecessor-version":[{"id":1089,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/557\/revisions\/1089"}],"up":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/554"}],"next":[{"title":"Bulk Paycode Batch Status","link":"https:\/\/sandbox.interswitchng.com\/docbase\/docs\/paycode\/bulk-paycode\/bulk-paycode-batch-status\/","href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/582"}],"wp:attachment":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/media?parent=557"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/doc_tag?post=557"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}