action ebay_get_payments_program {
  label: "getPaymentsProgram"
  description: "<span class=\"tablenote\"><b>Note:</b> This method is no longer applicable, as all seller accounts globally have been enabled for the new eBay payment and checkout flow.</span><br/><br/>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 <b>marketplace_id</b> path parameter to specify the marketplace of the status flag you want returned."
  provider: ebay
  method: GET
  path: "/payments_program/{marketplace_id}/{payments_program_type}"
  encoding: json
  input: {
    type: "object"
    properties: {
      marketplace_id: {
        type: "string"
      }
      payments_program_type: {
        type: "string"
      }
    }
    required: ["marketplace_id", "payments_program_type"]
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "The response object containing the sellers status with regards to the specified payment program."
    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>."
      }
    }
  }
}