Generate Token [single]

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

post/cardless-service/api/v1/cardless-services/tokens

Request

  • Base URL
    https://sandbox.interswitchng.com
  • URL
    https://sandbox.interswitchng.com/cardless-service/api/v1/cardless-services/tokens
  • Auth
    none required

Path parameters

subscriberIdstring required

Headers

Content-Typestring required
Authorizationstring required

Request body

paymentMethodTypeCodestring required

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

paymentMethodCodestring required

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

frontEndPartnerIdstring required

A unique Identifier of App developer e.g. GTMM

tokenLifeTimeInMinutesstring

The time this Paycode token should expire

payWithMobileChannelstring required

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

amountstring required

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

ttidstring required

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

codeGenerationChannelProviderstring

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.

oneTimePinstring

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

accountNostring

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.

accountTypestring

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

codeGenerationChannelstring

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

autoEnrollstring

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

transactionRefstring

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

beneficiaryNumberstring

Mobile number of token beneficiary

paymentMethodIdentifierstring required
macDatastring required
pinBlockstring required
securestring required
subscriberIdstring required
providerTokenstring required
transactionTypestring required

Response

200

Changes

No recorded changes to this operation across all 1 revision of this API.