> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Payment Token

> _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ For payments flows where the provider requires playfab (the fulfiller) to initiate the transaction, but the client completes the rest of the flow. In the Xsolla case, the token returned here will be passed to Xsolla by the client to create a cart. Poll GetPurchase using the returned OrderId once you've completed the payment.

## Error codes

This operation may return the following PlayFab errors:

| Error | Code |
| --- | --- |
| InvalidPaymentProvider | 1063 |
| NoPartnerEnabled | 1192 |
| ProductDisabledForTitle | 1609 |




## OpenAPI

````yaml post /Client/GetPaymentToken
openapi: 3.0.0
info:
  version: '260922'
  title: PlayFab Client API
  description: >-
    APIs which provide the full range of PlayFab features available to the
    client - authentication, account and data management, inventory, friends,
    matchmaking, reporting, and platform-specific functionality
  termsOfService: https://playfab.com/terms/
  contact:
    url: https://community.playfab.com/index.html
  license:
    name: Apache 2.0
    url: https://github.com/PlayFab/API_Specs/blob/master/LICENSE
servers:
  - url: https://{titleId}.playfabapi.com
    description: PlayFab title endpoint
    variables:
      titleId:
        default: your_title_id
        description: Your PlayFab title ID (hex).
security: []
tags:
  - name: Account Management
    description: Account Management APIs
  - name: Advertising
    description: Advertising APIs
  - name: Analytics
    description: Analytics APIs
  - name: Authentication
    description: Authentication APIs
  - name: Character Data
    description: Character Data APIs
  - name: Characters
    description: Characters APIs
  - name: Content
    description: Content Service APIs
  - name: Friend List Management
    description: Friend List Management APIs
  - name: Matchmaking
    description: Matchmaking APIs
  - name: Platform Specific Methods
    description: Platform Specific Methods APIs
  - name: Player Data Management
    description: Player Data Management APIs
  - name: Player Item Management
    description: Player Item Management APIs
  - name: PlayStream
    description: PlayStream Management APIs
  - name: Server-Side Cloud Script
    description: Server-Side Cloud Script APIs
  - name: Shared Group Data
    description: Shared Group Data APIs
  - name: Title-Wide Data Management
    description: Title-Wide Data Management APIs
  - name: Trading
    description: Trading Management APIs
paths:
  /Client/GetPaymentToken:
    post:
      tags:
        - Player Item Management
      summary: Get Payment Token
      description: >
        _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new
        Economy features are being developed only for version 2._ For payments
        flows where the provider requires playfab (the fulfiller) to initiate
        the transaction, but the client completes the rest of the flow. In the
        Xsolla case, the token returned here will be passed to Xsolla by the
        client to create a cart. Poll GetPurchase using the returned OrderId
        once you've completed the payment.


        ## Error codes


        This operation may return the following PlayFab errors:


        | Error | Code |

        | --- | --- |

        | InvalidPaymentProvider | 1063 |

        | NoPartnerEnabled | 1192 |

        | ProductDisabledForTitle | 1609 |
      operationId: GetPaymentToken
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetPaymentTokenRequest'
      responses:
        '200':
          $ref: '#/components/responses/GetPaymentTokenResult'
        '400':
          $ref: '#/components/responses/ApiErrorWrapper'
      security:
        - SessionTicket: []
components:
  schemas:
    GetPaymentTokenRequest:
      type: object
      properties:
        TokenProvider:
          description: >-
            The name of service to provide the payment token. Allowed Values
            are: xsolla
          type: string
      required:
        - TokenProvider
      example:
        TokenProvider: xsolla
    GetPaymentTokenResult:
      type: object
      properties:
        OrderId:
          description: PlayFab's purchase order identifier.
          type: string
        ProviderToken:
          description: The token from provider.
          type: string
      example:
        ProviderToken: uV0iCEvWkUGVqWerTgbrndWePOMiLAfO
        OrderId: '8853591446005860822'
    ApiErrorWrapper:
      description: The basic wrapper around every failed API response
      type: object
      properties:
        code:
          description: Numerical HTTP code
          type: integer
        status:
          description: String HTTP code
          type: string
        error:
          description: Playfab error code
          type: string
        errorCode:
          description: Numerical PlayFab error code
          type: integer
        errorMessage:
          description: Description for the PlayFab errorCode
          type: string
        errorDetails:
          description: Detailed description of individual issues with the request object
          type: object
      required:
        - code
        - errorCode
  responses:
    GetPaymentTokenResult:
      description: ''
      content:
        application/json:
          schema:
            type: object
            properties:
              code:
                type: integer
                description: >-
                  The Http status code. If X-ReportErrorAsSuccess header is set
                  to true, this will report the actual http error code.
              status:
                type: string
                description: The Http status code as a string.
              data:
                $ref: '#/components/schemas/GetPaymentTokenResult'
            example:
              code: 200
              status: OK
              data:
                ProviderToken: uV0iCEvWkUGVqWerTgbrndWePOMiLAfO
                OrderId: '8853591446005860822'
    ApiErrorWrapper:
      description: This is the outer wrapper for all responses with errors
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiErrorWrapper'
  securitySchemes:
    SessionTicket:
      type: apiKey
      in: header
      name: X-Authorization
      description: >-
        This API requires a client session ticket, available from any Client
        Login function.

````

## Related topics

- [Get Payment Token](/api-reference/player-item-management/get-payment-token.md)
- [Get Entity Token](/services/playfab/api-references/rest/authentication/authentication/get-entity-token.md)
- [Get Photon Authentication Token](/services/playfab/api-references/rest/client/authentication/get-photon-authentication-token.md)
- [Get Player Id From Auth Token](/api-reference/account-management/get-player-id-from-auth-token.md)
- [XInputGetStateWithToken](/reference/input/xinputongameinput/functions/xinputgetstatewithtoken.md)
