Generate Token [single]

post

https://sandbox.interswitchng.com/cardless-service/api/v1/cardless-services/tokens

is a request to generate a one-time access code also known as token for a Paycode transaction at a merchant location.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

subscriberId

string

required

Body Params

paymentMethodTypeCode

string

required

Defaults to WEMA

The type of payment instrument e.g. MMO, QTA, VMP. See “Payment Method Type Codes” in Appendix B for more.

paymentMethodCode

string

required

Defaults to WEMA

The unique Identifier of payment instrument issuer e.g. GTMM, FBN

frontEndPartnerId

string

required

Defaults to WEMA

The unique Identifier of the merchant e.g. GTMM

tokenLifeTimeInMinutes

string

Defaults to 60

The time this Paycode token should expire

payWithMobileChannel

string

required

Defaults to ATM

Paycode channel. This can either be ATM, POS, Agent and WEB

amount

string

required

Defaults to 100000

Transaction amount. 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

ttid

string

required

Defaults to 12345

Terminal Transaction ID. A unique generated id sent from the client application.

codeGenerationChannelProvider

string

Defaults to WEMA

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.

oneTimePin

string

Defaults to 1234

The one time PIN to be used to cashout Paycode at ATM. This value is Mandatory for ATM Cashout

accountNo

string

Defaults to 1234567890

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.

accountType

string

Defaults to 10

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

codeGenerationChannel

string

Defaults to INTERNET_BANKING

This is used to indicate the channel where Paycode will be generated. See Appendix “Paycode Code Generation Channels” for valid channels.

autoEnroll

string

Defaults to 12345

This holds a true or false value. “True” if an account holder is to be auto-enrolled if no mPin card is found, and “false” if the account holder is not to be auto-enrolled. This field defaults to “false” if no value is sent

transactionRef

string

Defaults to asdfasdsf

Unique transaction reference. To be used as unique identifier in call to cancel token.

beneficiaryNumber

string

Mobile number of token beneficiary

paymentMethodIdentifier

string

required

Defaults to E7BC82EAB6284C3C88144F00A47C5151

This is the unique identifier of the card in use

macData

string

required

Defaults to 77AA2EB6084ABB30C096FC51D33DC57206CF8699CC62E825F4120AE96D709A38

This contains the MAC of some sensitive data. This field is Mandatory if the payment method is authenticated by PIN.

pinBlock

string

required

Defaults to 87f607d0a0699b49

This contains the encrypted payment method PIN. This field is Mandatory if the payment method is authenticated by PIN.

secure

string

required

Defaults to 3f7b5174474571d662127993d4020f008b6e68a8c2af5be0a0dada31a2ac1d4537c114d3a9bb1dfbdbd9bf9cc9fe568c83cd9960aa2a73681f33af7ab27f044d37beede9fcf9cdfcf0b0b5bcfff14ef3f499c010535c80e4155a1e2ab616fee091e6b1ec452d42f746394e6025528fa4155cc509a1a5f66d1f80c5954c361589a6ce8beeeb39dbf42c57d61c8801b5cdcaadc31fa47ebc238a757f563828a2cea93f6d4c68376635f41eadb65d63d7a8550ed6cef57877eb5bb944840ff099cd3033252032b936941fb64127b3eb884b09e69076ab11456d49b76d2c1fde131c2dc5501f5460848806725ade2ba34a48447cc113b0bdb08b0ed1e2763451aebc

This contains payment method code authorization information. This field is Mandatory if the payment method authenticated by PIN.

subscriberId

string

required

Defaults to 2348169222599

Customer ID. E.g. 2348012233220

providerToken

string

required

Defaults to LEBUCODE

Mobile Money Transaction Authentication Token

transactionType

string

enum

required

The type of transaction

Allowed:

Headers

Content-Type

string

required

Defaults to application/json

Authorization

string

required

Defaults to Bearer eyJhbGciOiJSUzI1NiJ9.eyJmaXJzdE5hbWUiOiJEZWJvcmFoIiwibGFzdE5hbWUiOiJBZHViaWFybyIsImF1ZCI6WyJjYXJkbGVzcy1zZXJ2aWNlIiwicGFzc3BvcnQiLCJwcm9qZWN0LXgtY29uc3VtZXIiXSwidXNlcl9uYW1lIjoiZGFkdWJpYXJvQGludGVyc3dpdGNoLmNvbSIsInNjb3BlIjpbInByb2ZpbGUiXSwibW9iaWxlTm8iOiIyMzQ4MTI0ODg4NDM2IiwiZXhwIjozMDIyOTQxNjU3LCJqdGkiOiIxMGRjNzllZC03NmZiLTRmYTYtYmU5Yy03MjkwZmE5NzMwMTkiLCJlbWFpbCI6ImRhZHViaWFyb0BpbnRlcnN3aXRjaC5jb20iLCJjbGllbnRfaWQiOiJwcm9qZWN0LXgtYXBwIn0.bUG_FlxK2Wiyy6DZnSlVlosj7LfMaqzxXM_NysmOnAelvguWEv9-dE9v_R6eufZ6vCpUWIgK5ESXKVbEANoV6vauwZEps3rTzLmTtvX2_z0sq5dSKqG3Lswc5V6Q14bTKH6sxMuCvgVQ7dz5K23UJFv1Q6Wd2cuiy2pOnTe3Y-c8FD3rmEp7Bo3xsxcsL5_9GEyWvCVvGbo0ZsHoNYjJmRe-7PJl4LKy3ODKtChrgjeow7oYlgTxFezWiDvcD2hFn3JLOzuPisX-HqnZNAsBV5l_xheuQmkFESmmP6t7FgDYWnaKZIjCF__kkxK4e-lXhImYP1jDak1k7ctNm1uhlg

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200200

400400