---
title: "POST /payment-execution/{tenantLocator}/paymentProviders"
method: POST
path: "/payment-execution/{tenantLocator}/paymentProviders"
---

# POST /payment-execution/{tenantLocator}/paymentProviders

`POST /payment-execution/{tenantLocator}/paymentProviders`

## Request

- Base URL: `https://docs.socotra.com`
- URL: `https://docs.socotra.com/payment-execution/{tenantLocator}/paymentProviders`
- Auth: none declared
- TypeScript: <https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/docs/payment-execution/:tenantLocator/paymentProviders/post.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `tenantLocator` string, uuid, required

## Request body

- union
  - BraintreeConfigurationRequest
    - `paymentServiceProvider` 'braintree' | 'braintreeSandbox' | 'stripe' | 'stripeTest', required
    - `paymentProviderState` 'active' | 'inactive', required
    - `merchantId` string, required
    - `publicKey` string, required
    - `privateKey` string, required
  - StripeConfigurationRequest
    - `paymentServiceProvider` 'braintree' | 'braintreeSandbox' | 'stripe' | 'stripeTest', required
    - `paymentProviderState` 'active' | 'inactive', required
    - `secretKey` string, required

## Response `200`

OK

- PaymentProvider
  - `locator` string, ulid, required
  - `paymentServiceProvider` 'braintree' | 'braintreeSandbox' | 'stripe' | 'stripeTest', required
  - `paymentProviderState` 'active' | 'inactive', required

---

[API](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi.md) - [All operations](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/llms.txt) - [OpenAPI document](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/revisions/77ee7d8172b9?raw)