getPaymentsProgramOnboarding

v1.0.0

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 retrieves a seller's onboarding status for a payments program for a specified marketplace. The overall onboarding status of the seller and the status of each onboarding step is returned.

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": "Type used by the payments program onboarding response",
  "properties": {
    "onboardingStatus": {
      "type": "string",
      "description": "This enumeration value indicates the eligibility of payment onboarding for the registered site. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:PaymentsProgramOnboardingStatus'>eBay API documentation</a>"
    },
    "steps": {
      "type": "array",
      "description": "An array of the active process steps for payment onboarding and the status of each step. This array includes the step <strong>name</strong>, step <strong>status</strong>, and a <strong>webUrl</strong> to the <code>IN_PROGRESS</code> step. The step names are returned in sequential order. ",
      "items": {
        "type": "object",
        "description": "The payments program onboarding steps, status, and link.",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the step in the steps array. Over time, these names are subject to change as processes change. The output sample contains example step names. Review an actual call response for updated step names. "
          },
          "status": {
            "type": "string",
            "description": "This enumeration value indicates the status of the associated step. <p> <span class=\"tablenote\"><strong>Note:</strong> Only one step can be <code>IN_PROGRESS</code> at a time.</span></p> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:PaymentsProgramOnboardingStepStatus'>eBay API documentation</a>"
          },
          "webUrl": {
            "type": "string",
            "description": "This URL provides access to the <code>IN_PROGRESS</code> step."
          }
        }
      }
    }
  }
}