# Get scheme token

Request to get a scheme token and its status

Endpoint: GET /token-vault/{ownerType}/{ownerId}/vaults/scheme-tokens/{schemeTokenId}
Version: 1.0.0

## Path parameters:

  - `ownerId` (string, required)
    The unique identifier of the entity owning the token (e.g., Referrer, Merchant Group, Merchant, Site).
    Example: "MERCHANT-GROUP-1"

  - `ownerType` (string, required)
    The type of entity owning the token (e.g., Referrer, MerchantGroup, Merchant or Site).
    Enum: "Referrer", "MerchantGroup", "Merchant", "Site"

  - `schemeTokenId` (string, required)
    The scheme token ID.
    Example: "7f46c09d-d1d1-4f94-9a88-6e8ac32e6341"

## Response 200 fields (application/json):

  - `schemeTokenId` (string)
    The unique scheme token ID generated by PXP. It is used as a reference to extract the schemeTokenNumber.

  - `schemeTokenProvider` (string)
    The name of the scheme token provider.

  - `schemeTokenProcurementState` (string)
    The procurement state of the scheme token.

  - `externalSchemeTokenId` (string,null)
    A unique identifier token provided by the external payment scheme. This token allows merchants to process payments through different payment service providers (PSPs) or transaction service providers (TSPs). The token facilitates interoperability between different PSPs, enabling merchants to seamlessly integrate with and use various payment processing services.

  - `status` (string,null)
    The status of the scheme token.

  - `paymentAccountReference` (string,null)
    The payment account reference associated with the scheme token.

  - `schemeTokenNumber` (string,null)
    The scheme token number represents a scheme token issued by Visa or Mastercard, used for subsequent transaction processing. This token enhances security and facilitates recurring transactions, providing a secure and efficient alternative to sharing sensitive card details.

  - `expiryMonth` (string,null)
    The expiry month of the card, as a number from 1 to 12. Typically zero-padded to two digits (for example, 03).
    Example: "03"

  - `expiryYear` (string,null)
    The expiry year of the card (YYYY).
    Example: "2025"

## Response 400 fields (application/json):

  - `correlationId` (string)
    The unique identifier for this error response. Include it when contacting PXP support.
    Example: "81f32b80-2ba0-4430-8ecd-0b559274ba9c"

  - `details` (array)
    Additional details about the error.

  - `errorCode` (string)
    The error code returned for the operation.
    Example: "INVALID_REQUEST"

  - `errorReason` (string)
    The error reason returned for the operation.
    Example: "The request parameters are invalid."