Skip to content

Latest commit

 

History

History
64 lines (44 loc) · 3.12 KB

OnboardingApi.md

File metadata and controls

64 lines (44 loc) · 3.12 KB

SapientPro\EbayAccountSDK\Api\OnboardingApi

All URIs are relative to https://api.ebay.com/sell/account/v1

Method HTTP request Description
getPaymentsProgramOnboarding GET /payments_program/{marketplace_id}/{payments_program_type}/onboarding

getPaymentsProgramOnboarding

getPaymentsProgramOnboarding(MarketplaceIdEnum $marketplaceId, PaymentsProgramType $paymentsProgramType = PaymentsProgramType::EBAY_PAYMENTS): PaymentsProgramOnboardingResponse

<span class="tablenote">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.

Example

<?php
use SapientPro\EbayAccountSDK\Configuration;
use SapientPro\EbayAccountSDK\Api\OnboardingApi;
use SapientPro\EbayAccountSDK\Enums\PaymentsProgramType;
use SapientPro\EbayAccountSDK\Enums\MarketplaceIdEnum;

// Configure OAuth2 access token for authorization: api_auth
$config = Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new OnboardingApi(
    config: $config
);

try {
    $result = $apiInstance->getPaymentsProgramOnboarding(
        MarketplaceIdEnum::EBAY_US,
        PaymentsProgramType::EBAY_PAYMENTS
    );
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OnboardingApi->getPaymentsProgramOnboarding: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
marketplaceId \SapientPro\EbayAccountSDK\Enums\MarketplaceIdEnum The eBay marketplace ID associated with the onboarding status to retrieve.
paymentsProgramType \SapientPro\EbayAccountSDK\Enums\PaymentsProgramType The type of payments program whose status is returned by the method.

Return type

\SapientPro\EbayAccountSDK\Models\PaymentsProgramOnboardingResponse

Authorization

api_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]