MiPaymentChoice API: Card Tokenization

General

The MiPaymentChoice ReST API provides the ability to tokenize card data.

Token Formats

The PhoeniXGate ReST API provides secure payment data tokenization for cards. There are three formats for tokens available:

Token Type	Description	Sample Value
Uid	The token is a string representing a form of unique identifier.	301359b0c145622244a992d562d351c859ea
Integer	The token is an integer value.	15435
CardFormat	The token is formatted to resemble a credit card value.	4532957487500159

Routes

Route	Description
POST /merchants/{merchantKey}/tokens/cards	Creates a token from card payment data.
GET /merchants/{merchantKey}/tokens/cards/{token}	Returns the specified card payment data token's properties. Payment data is masked.
PATCH /merchants/{merchantKey}/tokens/cards/{token}	Updates one or more properties of the specified card payment data token.
PUT /merchants/{merchantKey}/tokens/cards/{token}	Replaces the specified card payment data token with the properties provided in the request.
DELETE /merchants/{merchantKey}/tokens/cards/{tokens}	Deletes the specified card payment data tokens. Accepts a comma-separated list of tokens.

Request Headers

Header	Value
Authentication	Bearer [authentication (JWT) token]
Content-Type	application/json

Request Body

{
    "CardNumber": "string",
    "ExpirationDate": "string",
    "NameOnCard": "string",
    "StreetAddress": "string",
    "PostalCode": "string",
    "TokenFormat": "Uid"
}

Parameter Details

Property	Required	Data	Additional Information
CustomerKey	No	Numeric	Indicates if the token is also associated with a Customer account.
CardNumber	Yes	String
ExpirationDate		String	MM/YY format.
NameOnCard		String
StreetAddress		String
PostalCode		String
TokenFormat		Enumeration	'Uid', 'Integer', 'CardFormat'.

Response Body

{
  "MerchantKey": 0,
  "CustomerKey": 0,
  "CardNumber": "string",
  "ExpirationDate": "string",
  "CardType": "string",
  "NameOnCard": "string",
  "StreetAddress": "string",
  "PostalCode": "string",
  "Token": "string"
}