# 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 or 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 unique scheme token ID generated by PXP. It is used as a reference to extract the schemeTokenNumber.
    Example: "f47ac10b-58cc-4372-a567-0e02b2c3d479"

## 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 utilize 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)
    This is the expiry year [YYYY] of the card.

  - `expiryYear` (string,null)
    This is the expiry month [MM] of the card.

## Response 400 fields (application/json):

  - `correlationId` (string)
    A unique identifier generated by PXP, serving as a critical tool for tracing and diagnosing transaction errors. This Id allows for the precise location of transactional issues, facilitating swift investigation and resolution by correlating specific transaction attempts or processes with error logs. Essential for support and operational teams, the correlationId enhances PXP's ability to maintain high-quality service and transaction reliability.
    Example: "81f32b80-2ba0-4430-8ecd-0b559274ba9c"

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

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

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

## Response 401 fields (application/json):

  - `correlationId` (string)
    A unique identifier generated by PXP, serving as a critical tool for tracing and diagnosing transaction errors. This Id allows for the precise location of transactional issues, facilitating swift investigation and resolution by correlating specific transaction attempts or processes with error logs. Essential for support and operational teams, the correlationId enhances PXP's ability to maintain high-quality service and transaction reliability.
    Example: "81f32b80-2ba0-4430-8ecd-0b559274ba9c"

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

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

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

## Response 403 fields (application/json):

  - `correlationId` (string)
    A unique identifier generated by PXP, serving as a critical tool for tracing and diagnosing transaction errors. This Id allows for the precise location of transactional issues, facilitating swift investigation and resolution by correlating specific transaction attempts or processes with error logs. Essential for support and operational teams, the correlationId enhances PXP's ability to maintain high-quality service and transaction reliability.
    Example: "81f32b80-2ba0-4430-8ecd-0b559274ba9c"

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

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

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

## Response 404 fields (application/json):

  - `correlationId` (string)
    A unique identifier generated by PXP, serving as a critical tool for tracing and diagnosing transaction errors. This Id allows for the precise location of transactional issues, facilitating swift investigation and resolution by correlating specific transaction attempts or processes with error logs. Essential for support and operational teams, the correlationId enhances PXP's ability to maintain high-quality service and transaction reliability.
    Example: "81f32b80-2ba0-4430-8ecd-0b559274ba9c"

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

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

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

## Response 413 fields (application/json):

  - `correlationId` (string)
    A unique identifier generated by PXP, serving as a critical tool for tracing and diagnosing transaction errors. This Id allows for the precise location of transactional issues, facilitating swift investigation and resolution by correlating specific transaction attempts or processes with error logs. Essential for support and operational teams, the correlationId enhances PXP's ability to maintain high-quality service and transaction reliability.
    Example: "81f32b80-2ba0-4430-8ecd-0b559274ba9c"

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

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

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

## Response 422 fields (application/json):

  - `correlationId` (string)
    A unique identifier generated by PXP, serving as a critical tool for tracing and diagnosing transaction errors. This Id allows for the precise location of transactional issues, facilitating swift investigation and resolution by correlating specific transaction attempts or processes with error logs. Essential for support and operational teams, the correlationId enhances PXP's ability to maintain high-quality service and transaction reliability.
    Example: "81f32b80-2ba0-4430-8ecd-0b559274ba9c"

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

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

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

## Response 500 fields (application/json):

  - `correlationId` (string)
    A unique identifier generated by PXP, serving as a critical tool for tracing and diagnosing transaction errors. This Id allows for the precise location of transactional issues, facilitating swift investigation and resolution by correlating specific transaction attempts or processes with error logs. Essential for support and operational teams, the correlationId enhances PXP's ability to maintain high-quality service and transaction reliability.
    Example: "81f32b80-2ba0-4430-8ecd-0b559274ba9c"

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

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

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