Get Purchase Intent

Retrieve a Purchase Intent by ID.

Request

curl -X GET \
  https://api.basistheory.ai/tenants/your-tenant-id/purchase-intent/46c029d2-485a-4928-83b5-4326c4866722 \
  -H 'Authorization: Bearer your-api-key'

URL Parameters

Parameter	Required	Type	Default	Description
`tenantId`	true	string	`null`	The tenant ID.
`id`	true	string	`null`	The purchase intent ID.

Response

{
  "id": "46c029d2-485a-4928-83b5-4326c4866722",
  "entityId": "94c94330-94fd-4832-a106-e8474a274fe4",
  "credentialType": "network-token",
  "status": "active",
  "token": {
    "number": "2222030198005808",
    "expirationMonth": "07",
    "expirationYear": "2028",
    "cryptogram": "AAnSCQ9UvB3WAA4IVFwEAAADFA=="
  },
  "createdAt": "2025-06-16T14:00:00Z",
  "expiresAt": "2025-06-13T18:42:01Z"
}

Response Properties

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	Perform additional authentication steps
`unavailable`	Credential type not available	Try different credential type

Error Handling

{
  "error": {
    "status": 401,
    "type": "unauthorized",
    "title": "Unauthorized",
    "message": "Missing or invalid API key was provided."
  }
}