Get Purchase Intent

The getPurchaseIntent MCP tool gets a Purchase Intent to retrieve a credential (virtual card, network token, etc.) enabling a purchase to be completed on behalf of the consumer.

Parameters

Parameter	Type	Required	Description
`purchaseIntentId`	string	Yes	Id of the Purchase Intent

Return Value

Returns an MCP tool result containing a purchase intent object:

{
  "content": [
    {
      "type": "text",
      "json": {
        "id": "0b1ac700-c1a7-46b0-a166-809e5aac4dc3",
        "entityId": "94c94330-94fd-4832-a106-e8474a274fe4",
        "credentialType": "virtual-card",
        "status": "active",
        "card": {
          "number": "2222030198005808",
          "expirationMonth": "07",
          "expirationYear": "2028",
          "cvc": "211"
        },
        "createdAt": "2025-06-16T14:00:00Z",
        "expiresAt": "2025-06-13T18:42:01Z"
      }
    }
  ]
}

Response Properties

Property	Type	Description
`content`	array	array of content returned.

Purchase Intent

Property	Type	Description
`id`	string	The purchase intent id.
`entityId`	string	The ID for the entity that owns the purchase intent.
`credentialType`	string	The purchase intent credential type.
`status`	string	The purchase intent status: `active`, `verify` or `unavailable`.
`card`	Card Object	Details for a `"virtual-card"` type credential.
`token`	Token Object	Details for a `"network-token"` type credential.
`createdAt`	datetime	The purchase intent credential created date.
`expiresAt`	datetime	The purchase intent expiration date for the credential.

Virtual Card Object

Property	Type	Description
`number`	string	The card PAN.
`expirationMonth`	string	Card expiration month in `MM` format.
`expirationYear`	string	Card expiration year in `YYYY` format.
`cvc`	string	Card security code.

Token Object

Property	Type	Description
`number`	string	The token number.
`expirationMonth`	string	Token expiration month in `MM` format.
`expirationYear`	string	Token expiration year in `YYYY` format.
`cryptogram`	string	The token cryptogram.

Status Meanings

Status	Description	Action Required
`active`	Credential is ready for immediate use	None - use credential for transactions
`verify`	Additional verification required	Use Verify Purchase Intent SDK
`unavailable`	Credential type not available	Try different credential type