v1

latestOpenAPI 3.0.02026-07-242035712.0 MB

Tokenization customer service

Account Holder Messaging

Allows issuer to display customized messages per token within the Apple Pay wallet, below the digitized image of the card.

post/pws/customerservice/v2/token/account_holder_messaging

Request body

api_call_unique_identifierstring required

Unique number that must be passed at each API request. Identifier to make each API request unique

client_idinteger required

Unique identifier for the client which Paymentology will provide at outset

issuerApplicationMessageDisplayboolean required

This is the indicator if the message can be viewed in the Issuer Application using the MessageIdentifier.

messageExpirationstring required

Date and time after which the message is no longer valid. Maximum value of 30 days in the future. ISO 8601 format.

messageIdentifierstring required

This is the message identifier. This could be used for linking into the issuer application.

messageLanguageCodestring required

The language of the message. Only messages with the requested language code will be presented to the account holder. ISO 639-1 format

messageTextstring required

This is the message which will be displayed to the cardholder.

tokeninteger required

Paymentology Public Token.

tokenUniqueReferencestring required

Unique reference of the token to be updated.

user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "messageExpiration": "2020-06-18T18:04:35+03:00",
  "messageIdentifier": "6598123486451346764616431064",
  "messageLanguageCode": "en",
  "messageText": "Hello World",
  "token": 311012081,
  "tokenUniqueReference": "DNITHEgx1ZI57H5eVHZpoFptyWpay10"
}

Response

Successful Response

responseIdstring

Response ID

tokenUniqueReferencestring

Unique reference to the digital token

Example response

{
  "responseId": "1234"
}