Generate Token [bulk]

post/cardless-service/api/v1/cardless-services/batch-token

Request

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

Headers

Content-Typestring
Authorizationstring

Request body

subscriberIdstring required

Customer ID. E.g. 2348012233220

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

amountstring

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.

oneTimePinstring

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

securestring

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

transactionRefstring

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

channelstring

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

pinBlockstring required

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

macDatastring required

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

referenceIdstring required

Unique reference id. To be used as unique identifier to each bulk token generation request

beneficiaryNumberstring required

Mobile number of token beneficiary

batchSizestring required

This shows the total number of token intended to generate. NB. Only a maximum of 10 token can be generated at a time.

paymentMethodIdentifierstring required
defaultOneTimePinstring required
currencystring

Response

200

Changes

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