A Generate Token message is a request to generate a one-time access code also known as token for a Paycode transaction at a merchant location. Please request the context URL from Interswitch.<\/p>\n

Generate Token Request (Sent from Third-party)<\/strong><\/h4>\n

The following describes the important element required to be sent for a Generate Token request.<\/p>\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	paymentMethodTypeCode<\/td>\n	Mandatory<\/td>\n	The type of payment instrument e.g. MMO, QTA, VMP. See \u201cPayment Method Type Codes\u201d in Appendix B for more.<\/td>\n<\/tr>\n
3<\/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
4<\/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
5<\/td>\n	tokenLifeTimeInMinutes<\/td>\n	Optional<\/td>\n	The time this Paycode token should expire<\/td>\n<\/tr>\n
6<\/td>\n	payWithMobileChannel<\/td>\n	Mandatory<\/td>\n	Paycode channel. This can either be ATM, \u00a0POS, Agent and WEB. See Paycode Channels in Appendix B<\/td>\n<\/tr>\n
7<\/td>\n	providerToken<\/td>\n	+Conditional<\/td>\n	Mobile Money Transaction Authentication Token<\/td>\n<\/tr>\n
8<\/td>\n	amount<\/td>\n	Conditional<\/td>\n	Transaction amount. \u00a0If 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
9<\/td>\n	ttid<\/td>\n	Mandatory<\/td>\n	Terminal Transaction ID. A unique generated id sent from the client application.<\/td>\n<\/tr>\n
10<\/td>\n	codeGenerationChannelProvider<\/td>\n	Optional<\/td>\n	The Service Provider for the Code Generation Channel. If this value is not sent, the Front End Partner will be assumed to be the Code Generation Channel Provider. A value should be sent if the Code Generation Channel provider is different from the From End Partner.<\/td>\n<\/tr>\n
11<\/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
12<\/td>\n	accountNo<\/td>\n	Conditional<\/td>\n	This is the account no of the subscriber. This value is Mandatory if subscriber will be auto-enrolled if not existing. This is only for clients who wish to auto-enroll on Interswitch mPin platform during Paycode generation.<\/td>\n<\/tr>\n
13<\/td>\n	accountType<\/td>\n	Conditional<\/td>\n	This is the account type of the subscriber. This value is Mandatory if subscriber will be auto-enrolled if not existing. This is only for clients who wish to auto-enroll on Interswitch mPin platform during Paycode generation. See account type codes in Appendix B.<\/td>\n<\/tr>\n
14<\/td>\n	codeGenerationChannel<\/td>\n	Mandatory<\/td>\n	This is used to indicate the channel where Paycode will be generated. See Appendix \u201cPaycode Code Generation Channels\u201d for valid channels.<\/td>\n<\/tr>\n
15<\/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
16<\/td>\n	pinData<\/td>\n	Conditional<\/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
17<\/td>\n	macData<\/td>\n	Conditional<\/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
18<\/td>\n	autoEnroll<\/td>\n	Conditional<\/td>\n	This holds a true or false value. \u201cTrue\u201d if an account holder is to be auto-enrolled if no mPin card is found, and \u201cfalse\u201d if the account holder is not to be auto-enrolled. This field defaults to \u201cfalse\u201d if no value is sent<\/td>\n<\/tr>\n
19<\/td>\n	transactionRef<\/td>\n	Conditional<\/td>\n	Unique transaction reference. To be used as unique identifier in call to cancel token.<\/td>\n<\/tr>\n
20<\/td>\n	beneficiaryNumber<\/td>\n	Conditional<\/td>\n	Mobile number of token beneficiary<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n  <\/p>\n + – If the Payment Method Issuer decides to use an OTP for authorization, the OTP value is sent in this field (ProviderToken).<\/strong><\/p>\n NB: We recommend that the ttid and transactionRef have the same value.<\/strong><\/p>\n Sample Request<\/strong><\/h5>\n\n\n\n POST https:\/\/sandbox.interswitchng.com\/api\/v1\/pwm\/subscribers\/{subscriberId}\/tokens<\/p>\n Content-Type: application\/json<\/p>\n [Other Interswitch security headers]\u2026 Click on this link<\/a><\/p>\n frontEndPartnerId: WEMA<\/p>\n  <\/p>\n {<\/p>\n “ttid”: “12345”,<\/p>\n “paymentMethodTypeCode”: “MMO”,<\/p>\n “paymentMethodCode”: “WEMA”,<\/p>\n “payWithMobileChannel”: “ATM”,<\/p>\n “tokenLifeTimeInMinutes”: “60”,<\/p>\n “amount”: “50000”,<\/p>\n \u201coneTimePin\u201d:\u201d1234\u201d,<\/p>\n “codeGenerationChannel”: “INTERNET_BANKING”,<\/p>\n “codeGenerationChannelProvider”: “WEMA”,<\/p>\n “accountNo”: “1234567890”,<\/p>\n “accountType”: “10”,<\/p>\n \u201cautoEnroll\u201d : \u201ctrue\u201d,<\/p>\n \u201ctransactionRef\u201d:\u201d12345\u201d<\/p>\n }<\/p>\n  <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n  <\/p>\n Generate Token Response (Sent from Interswitch)<\/strong><\/h4>\n The following describes the important data element required for a Generate Token response.<\/p>\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 subscriberId<\/td>\n Customer ID. E.g. 2348012233220<\/td>\n<\/tr>\n 2<\/td>\n payWithMobileToken<\/td>\n This is the Paycode token.<\/td>\n<\/tr>\n 3<\/td>\n tokenLifeTimeInMinutes<\/td>\n The time this Paycode token will expire<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n  <\/p>\n Successful Response<\/p>\n\n\n\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \u00a0HTTP Status Code:\u00a0 200<\/p>\n {<\/p>\n “subscriberId”: “2348012233220”,<\/p>\n “payWithMobileToken”: “57889026616”,<\/p>\n “tokenLifeTimeInMinutes”: “60”<\/p>\n }<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n  <\/p>\n Unsuccessful Response<\/p>\n\n\n\n HTTP Status Code: 400<\/p>\n  <\/p>\n {<\/p>\n “errors”: [<\/p>\n {<\/p>\n “code”: “10400”,<\/p>\n “message”: “Bad request”<\/p>\n }<\/p>\n ],<\/p>\n “error”: {<\/p>\n “code”: “10400”,<\/p>\n “message”: “Bad request”<\/p>\n }<\/p>\n }<\/p>\n  <\/p>\n  <\/p>\n  <\/p>\n HTTP Status Code:\u00a0 403<\/p>\n  <\/p>\n {<\/p>\n “error”: {<\/p>\n “code”: “E24”,<\/p>\n “message”: “Invalid authentication credentials: Timestamp out of window”<\/p>\n },<\/p>\n “errors”: [<\/p>\n {<\/p>\n “code”: “E24”,<\/p>\n “message”: “Invalid authentication credentials: Timestamp out of window”<\/p>\n }<\/p>\n ]<\/p>\n }<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"author":169,"featured_media":0,"parent":553,"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\/569"}],"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=569"}],"version-history":[{"count":7,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/569\/revisions"}],"predecessor-version":[{"id":1099,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/569\/revisions\/1099"}],"up":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/553"}],"next":[{"title":"Cancel Token","link":"https:\/\/sandbox.interswitchng.com\/docbase\/docs\/paycode\/single-paycode\/cancel-token\/","href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/570"}],"wp:attachment":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/media?parent=569"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/doc_tag?post=569"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}