## Get payment-provider status

`client.paymentProviders.retrieve(stringprovider, RequestOptionsoptions?): PaymentProvider`

**get** `/v3/payments/providers/{provider}`

Returns your organization's onboarding status for a payment provider.

### Parameters

- `provider: string`

### Returns

- `PaymentProvider`

  - `provider?: string`

  - `status?: "onboarding" | "ready" | "disabled"`

    - `"onboarding"`

    - `"ready"`

    - `"disabled"`

### Example

```typescript
import LinqAPIV3 from '@linqapp/sdk';

const client = new LinqAPIV3({
  apiKey: process.env['LINQ_API_V3_API_KEY'], // This is the default and can be omitted
});

const paymentProvider = await client.paymentProviders.retrieve('provider');

console.log(paymentProvider.provider);
```

#### Response

```json
{
  "provider": "agentcard",
  "status": "ready"
}
```