Regenerate Key

PUT 
/v1/merchants/:merchantId/regenerate_key

Regenerate an API key for a specific account

Request

Path Parameters

merchantId uuidrequired

application/json

Body

required

account_type stringrequired

Possible values: [live, test]

Entity's account type.

key_type stringrequired

Possible values: [secret, publishable]

Key type to be regenerated.

Responses

200

Merchant submitted for review successfully

application/json

Schema

Schema

key string

Newly generated key

Example (from schema)

{
  "key": "sk_live_123"
}

400

Business Error or validation error.

application/json

Schema

Schema

type string

Contains the error type

message string

Human readable error message for the error

errors object

Contains string-array pair representing a field and list of validation errors.

Example (from schema)

{
  "type": "invalid_request",
  "message": null,
  "errors": {
    "foo": "this is returned for validation errors only"
  }
}

401

Invalid authorization credentials

application/json

Schema

Schema

type string

Possible values: [authentication_error]

message string

Possible values: [Invalid authorization credentials]

errors object

Example (from schema)

{
  "type": "authentication_error",
  "message": "Invalid authorization credentials",
  "errors": null
}

403

Invalid authorization credentials

application/json

Schema

Schema

type string

Possible values: [api_error]

message string

Possible values: [User not authorized]

errors object

Example (from schema)

{
  "type": "api_error",
  "message": "User not authorized",
  "errors": null
}

404

One of the record referenced in the request was not found

application/json

Schema

Schema

type string

Possible values: [record_not_found]

message string
errors object

Example (from schema)

{
  "type": "record_not_found",
  "message": "The <object type> record you were looking for was not found.",
  "errors": null
}

Loading...