Update payment provider

PUT

/api/v1/settings/payment-providers/{provider}

curl --request PUT \
  --url https://api.pitch2sale.com/api/v1/settings/payment-providers/stripe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "is_test_mode": true, "is_active": true, "secret": "example", "publishable_key_or_key_id": "example", "webhook_secret": "example" }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Parameters

Path Parameters

provider

required

string

Allowed values: stripe razorpay

Request Body^required

Media typeapplication/json

object

is_test_mode

boolean

is_active

boolean

secret

Any of:

string

string

>= 1 characters <= 500 characters

null

null

publishable_key_or_key_id

Any of:

string

string

<= 500 characters

null

null

webhook_secret

Any of:

string

string

>= 1 characters <= 500 characters

null

null

Example^generated

{
  "is_test_mode": true,
  "is_active": true,
  "secret": "example",
  "publishable_key_or_key_id": "example",
  "webhook_secret": "example"
}

Responses

200

OK

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}