eBay Payments_program API

openapi: 3.2.0
info:
  title: eBay Account Payments Program API
  description: 'The Account API gives sellers the ability to configure their eBay seller accounts, including the seller''s policies (eBay business policies and seller-defined custom policies), opt in and out of eBay seller programs, configure sales tax tables, and get account information.


    For details on the availability of the methods in this API, see Account API requirements and restrictions.'
  contact:
    name: eBay Inc,
  license:
    name: eBay API License Agreement
    url: https://go.developer.ebay.com/api-license-agreement
  version: v1.9.2
servers:
- url: https://api.ebay.com{basePath}
  description: Production
  variables:
    basePath:
      default: /sell/account/v1
tags:
- name: Payments_program
paths:
  /payments_program/{marketplace_id}/{payments_program_type}:
    get:
      tags:
      - Payments_program
      description: 'Note: This method is no longer applicable, as all seller accounts globally have been enabled for the new eBay payment and checkout flow.

        This method returns whether or not the user is opted-in to the specified payments program. Sellers opt-in to payments programs by marketplace and you use the marketplace_id path parameter to specify the marketplace of the status flag you want returned.'
      operationId: getPaymentsProgram
      parameters:
      - name: marketplace_id
        in: path
        description: This path parameter specifies the eBay marketplace of the payments program for which you want to retrieve the seller's status.
        required: true
        schema:
          type: string
      - name: payments_program_type
        in: path
        description: This path parameter specifies the payments program whose status is returned by the call.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentsProgramResponse'
        '400':
          description: Bad Request
          x-response-codes:
            errors:
              '20408':
                domain: API_ACCOUNT
                category: REQUEST
                description: No payment program available. The user may not be registered to the specified site or the site may not be supported by the payments program.
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          x-response-codes:
            errors:
              '20500':
                domain: API_ACCOUNT
                category: APPLICATION
                description: Application error
      security:
      - api_auth:
        - https://api.ebay.com/oauth/api_scope/sell.account
        - https://api.ebay.com/oauth/api_scope/sell.account.readonly
      summary: Get payments program
      x-summary-source: derived
components:
  schemas:
    PaymentsProgramResponse:
      type: object
      properties:
        marketplaceId:
          type: string
          description: The ID of the eBay marketplace to which the payment program applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:MarketplaceIdEnum'>eBay API documentation</a>
        paymentsProgramType:
          type: string
          description: This parameter specifies the payment program whose status is returned by the call.  <br><br>Currently the only supported payments program is <code>EBAY_PAYMENTS</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:PaymentsProgramType'>eBay API documentation</a>
        status:
          type: string
          description: The enumeration value returned in this field indicates whether or not the seller's account is enabled for the payments program. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:PaymentsProgramStatus'>eBay API documentation</a>
        wasPreviouslyOptedIn:
          type: boolean
          description: If returned as <code>true</code>, the seller was at one point opted-in to the associated payment program, but they later opted out of the program. A value of <code>false</code> indicates the seller never opted-in to the program or if they did opt-in to the program, they never opted-out of it.  <br><br>It's important to note that the setting of this field does not indicate the seller's current status regarding the payment program. It is possible for this field to return <code>true</code> while the <b>status</b> field returns <code>OPTED_IN</code>.
      description: The response object containing the sellers status with regards to the specified payment program.
  securitySchemes:
    api_auth:
      type: oauth2
      description: The security definitions for this API. Please check individual operations for applicable scopes.
      flows:
        authorizationCode:
          authorizationUrl: https://auth.ebay.com/oauth2/authorize
          tokenUrl: https://api.ebay.com/identity/v1/oauth2/token
          scopes:
            https://api.ebay.com/oauth/api_scope/sell.account.readonly: View your account settings
            https://api.ebay.com/oauth/api_scope/sell.account: View and manage your account settings