Description of Parameters

Suggest Edits

19. Description of Parameters

The parameters are listed and defined in the table below.

ParameterTypeDescription
accountIntegerThe unique ID associated with a payment transaction. It is optional. If you omit this parameter, the payment transaction is associated with the default sub-account.
client-idIntegerThe unique ID configured for a merchant on the Velocity POP.
auth-tokenStringA unique token sent to the specified auth-url to authenticate customers when they pay with a stored card and use single sign-on.
operator-idIntegerThe ID of a customer’s mobile network operator. CPD recommends including this parameter in a request to ensure that Velocity interacts with the operator accurately.
country-idIntegerThe CPD-specific country code, which is made available to merchants on request.
emailStringThe email address of a customer.
customer-refStringThe unique reference ID given by a merchant for a customer. Velocity uses this token to identify a user. The customer reference is included in the request to a specified auth-URL to identify customers when they:
  • Pay with a stored card through the mVault
  • Use single sign-on.
Note: Customer-ref can be mandatory or optional, based on the requirement of a merchant or a PSP.
type-idIntegerA type of card.
country-idIntegerThe CPD-specific country code, which is made available to merchants on request.
card-holder-nameStringThe name of a card holder.
card-numberStringThe card number used for transaction.
expiry-monthStringThe date on which a card expires.
expiry-yearStringThe year in which a card expires.
languageStringThe language that Velocity uses as default when translating the payment pages.
Note: Velocity language codes are based upon the ISO- 639-1 standard.
Refer to https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes for details.
versionStringThe version of the API or application that send the request.
card-holder-nameStringThe name of a card holder.
card-numberStringThe card number used for transaction.
expiry-monthStringThe date on which a card expires.

Updated 3 months ago