Object

The table below lists the response objects received for the different Tokens APIs.

Token API
Generate Card Token	Card Token Object
Generate Cryptogram	Cryptogram Object
Get Customer Token	Customer Token Object
Delete Token	Delete Token Object

Card Token Object

Shown below is a sample response returned through our Generate Card Token API.

{
  "token_id": "token-v1-0811030624-aa-RBDgpR",
  "customer_id": "cust-786cdrexrt",
  "merchant_token_reference": "ec71b52e-c21f-4ac5-8624-385d6b6bdccc",
  "status": "ACTIVE",
  "created_at": "2024-10-04T13:11:29.645657Z",
  "updated_at": "2024-10-04T13:11:29.645657Z"
}

The table below lists the various parameters returned in the Generate Card Token API response.

Parameter	Type	Description
token_id	`string`	Unique identifier of the token in the Plural database. Maximum length: 50 characters. Example: `token-v1-0811030624-aa-RBDgpR`
customer_id	`string`	Unique identifier of the customer in the Plural database. Maximum length: 50 characters. Example: `cust-v1-0811030624-aa-RBDgpR`
merchant_token_reference	`string`	Unique identifier entered while creating a token. Minimum length: 1 character. Maximum length: 50 characters. Example: `82d57572-057c-4826-5775-385a52150554`
status	`string`	Token status. Possible values: `Initiated`: It's a token's initial state, indicating that Plural is working with token service providers to generate it. `Active`: It's a token's active state, achieved when the service_provider_token status is marked as active by the network token service providers. `Suspended`: The token status changes to suspended when it is not active for any token service provider or is marked as suspended by network token service providers. `Failed`: The token status changes to failed if it is marked as failed by all service providers. `Deactivated`: The status will be deactivated if it is neither active nor suspended for all token service providers or if the token is deactivated by network token service providers.
created_at	`string`	The ISO 8601 UTC Timestamp, when the create token was received by Plural. Example: `2024-10-04T13:11:29.655592Z`
updated_at	`string`	The ISO 8601 UTC Timestamp, when the token is updated. Example: `2024-10-04T13:11:29.645657Z`

Cryptogram

Shown below is a sample response returned through our Generate Cryptogram API.

{
  "token_id": "token-v1-0811030624-aa-RBDgpR",
  "merchant_token_reference": "ec71b52e-c21f-4ac5-8624-385d6b6bdccc",
  "service_provider_token_id": "tp-v1-0811030624-aa-RBDgpR",
  "token_data": {
    "cryptogram": "/wAAAAAAl9SX1HsAmWKSgqwAAAA=",
    "token_reference": "sas7wqaoidasdfssdjjk",
    "payment_account_reference": "8324ssdas7wqaoidassdjjk",
    "token_expiry_month": 5,
    "token_expiry_year": 2030
  }
}

The table below lists the various parameters returned in the Generate Cryptogram API response.

Parameter	Type	Description
token_id	`string`	Unique identifier of the token in the Plural database. Maximum length: 50 characters. Example: `token-v1-0811030624-aa-RBDgpR`
merchant_token_reference	`string`	Unique identifier entered while creating a token. Minimum length: 1 character. Maximum length: 50 characters. Example: `82d57572-057c-4826-5775-385a52150554`
service_provider_token_id	`string`	Unique service provider reference in the Plural database. Maximum length: 50 characters. Example: `tp-v1-0811030624-aa-RBDgpR`
token_data	`object`	An object that contains the token details. Learn more about the `token_data` child object.

Token Data [Child Object]

The table below lists the various parameters in the token_data child object. This is part of the cryptogram response object.

Parameter	Type	Description
cryptogram	`string`	Dynamically generated encrypted value to authenticate and protect card-not-present (CNP) transactions. Example: `AFV5JWsTN01sAAPKVx01AAADFA==`
token_reference	`string`	Unique identifier entered while creating a token. Minimum length: 1 character. Maximum length: 50 characters. Example: `82d57572-057c-4826-5775-385a52150554`
payment_account_reference	`string`	Unique identifier of a payment account which is independent of the card number. Example: `500167T12CBJM1WXT8C7WSENYDYSY`
token_expiry_month	`string`	The month when the payment token expires. Example: `02`
token_expiry_year	`string`	The year when the payment token expires. Example: `2025`

Customer Token

Shown below are the sample response returned through our customer token APIs.

{
  "customer_id": "cust-v1-0811030624-aa-RBDgpR",
  "tokens": [
    {
      "token_id": "token-v1-0811030624-aa-RBDgpR",
      "merchant_token_reference": "",
      "status": "ACTIVE",
      "payment_method": "CARD",
      "expired_at": "2024-10-04T13:11:29.645591Z",
      "created_at": "2024-10-04T13:11:29.645591Z",
      "updated_at": "2024-10-04T13:11:29.645657Z",
      "status_reason": null,
      "merchant_metadata": {
        "key1": "XX",
        "key2": "DOF"
      },
      "card_data": {
        "last4_digit": "2363",
        "card_type": "CREDIT",
        "network_name": "VISA",
        "issuer_name": "HDFC",
        "card_category": "Consumer",
        "country_code": "IND",
        "international": false,
        "emi": true,
        "cvv_required": false
      },
      "is_compliant": true
    }
  ]
}

The table below lists the various parameters returned in the orders response objects.

Parameter	Type	Description
customer_id	`string`	Unique identifier of the customer in the Plural database. Maximum length: 50 characters. Example: `cust-v1-0811030624-aa-RBDgpR`
tokens	`array of objects`	An array of object that contains the token information details. Learn more about the `tokens` child object.

Tokens [Child Object]

The table below lists the various parameters in the tokens child object. This is part of the tokens response object.

Parameter	Type	Description
token_id	`string`	Unique identifier of the token in the Plural database. Maximum length: 50 characters. Example: `token-v1-0811030624-aa-RBDgpR`
merchant_token_reference	`string`	Unique identifier entered while creating a token. Minimum length: 1 character. Maximum length: 50 characters. Example: `82d57572-057c-4826-5775-385a52150554`
status	`string`	Token status. Possible values: `Initiated`: It's a token's initial state, indicating that Plural is working with token service providers to generate it. `Active`: It's a token's active state, achieved when the service_provider_token status is marked as active by the network token service providers. `Suspended`: The token status changes to suspended when it is not active for any token service provider or is marked as suspended by network token service providers. `Failed`: The token status changes to failed if it is marked as failed by all service providers. `Deactivated`: The status will be deactivated if it is neither active nor suspended for all token service providers or if the token is deactivated by network token service providers.
payment_method	`string`	Type of payment method. Accepted values: `CARD` `UPI` `POINTS` Example: `CARD`
expired_at	`string`	The ISO 8601 UTC Timestamp, when the token get expired. Example: `2024-10-04T13:11:29.645591Z`
created_at	`string`	The ISO 8601 UTC Timestamp, when the create token was received by Plural. Example: `2024-10-04T13:11:29.655592Z`
updated_at	`string`	The ISO 8601 UTC Timestamp, when the token is updated. Example: `2024-10-04T13:11:29.645657Z`
status_reason	`string`	Reason corresponding to the payment token status. Example: `payment token expired`
merchant_metadata	`object`	An object of key-value pair that can be used to store additional information. Example: "key1": "DD"
card_data	`object`	An object that contains the card details. Learn more about the `card_data` child object.
is_compliant	`boolean`	Status of the token compliant as per Reserve Bank Of India (RBI) regulations. Example: `true`

Card Data [Child Object]

The table below lists the various parameters in the card_data child object. This is part of the tokens object.

Parameter	Type	Description
last4_digit	`string`	The last four digits of your card number. Has to be 4 digits. Example: `1234` Supported characters: `0-9`
card_type	`string`	Type of card. Possible values: `DEBIT` `CREDIT` Example: `CREDIT`
network_name	`string`	Card network providers. Example: `VISA`
issuer_name	`string`	Card issuer entity. Example: `HDFC`
card_category	`string`	The card category type. Possible values: `CONSUMER` `COMMERCIAL` `PREMIUM` `SUPER_PREMIUM` `PLATINUM` `OTHER` `BUSINESS` `GOVERNMENT_NOTES` `PAYOUTS` `ELITE` `STANDARD` Example: `CONSUMER`
country_code	`string`	Card issuers Country. Example: `IND`
international	`boolean`	International transaction support status. Possible values: `true`: Supports international transaction. `false`: Do not support international transactions.
emi	`boolean`	EMI Transaction support status. Possible values: `true`: Supports EMI transactions. `false`: Do not support EMI transactions.
cvv_required	`boolean`	Is CVV required for the transaction. Possible values: `true`: CVV is required for the transaction. `false`: CVV is not required for the transaction.

Delete Token

Shown below is a sample response returned through our Delete Token API.

{
  "customer_id": "cust-786cdrexrt",
  "token-id": "ec71b52e-c21f-4ac5-8624-385d6b6bdccc",
  "status": "DELETED",
  "merchant_unique_reference": "dx98b63e-c74g-5ac4-632e-346d6c7bdwka"
}

The table below lists the various parameters returned in the Delete Token API response.

Parameter	Type	Description
token_id	`string`	Unique identifier of the token in the Plural database. Maximum length: 50 characters. Example: `ec71b52e-c21f-4ac5-8624-385d6b6bdccc
customer_id	`string`	Unique identifier of the customer in the Plural database. Maximum length: 50 characters. Example: `cust-v1-0811030624-aa-RBDgpR`
merchant_token_reference	`string`	Unique identifier entered while creating a token. Minimum length: 1 character. Maximum length: 50 characters. Example: `82d57572-057c-4826-5775-385a52150554`
status	`string`	Token status. Possible values: `Initiated`: It's a token's initial state, indicating that Plural is working with token service providers to generate it. `Active`: It's a token's active state, achieved when the service_provider_token status is marked as active by the network token service providers. `Suspended`: The token status changes to suspended when it is not active for any token service provider or is marked as suspended by network token service providers. `Failed`: The token status changes to failed if it is marked as failed by all service providers. `Deactivated`: The status will be deactivated if it is neither active nor suspended for all token service providers or if the token is deactivated by network token service providers.
created_at	`string`	The ISO 8601 UTC Timestamp, when the create token was received by Plural. Example: `2024-10-04T13:11:29.655592Z`
updated_at	`string`	The ISO 8601 UTC Timestamp, when the token is updated. Example: `2024-10-04T13:11:29.645657Z`