Get Stripe Connect onboarding status

GET

/api/payments/connect/status

curl --request GET \
  --url https://api.getvespy.com/api/payments/connect/status \
  --header 'Authorization: Bearer <token>'

• Production
• Development
• Local

Authorizations

• bearerAuth

Responses

200

Default Response

Media typeapplication/json

object

status

required

object

paymentsEnabled

required

boolean

stripeAccountId

required

string

nullable >= 1 characters

stripeChargesEnabled

required

boolean

stripePayoutsEnabled

required

boolean

Example^generated

{
  "status": {
    "paymentsEnabled": true,
    "stripeAccountId": "example",
    "stripeChargesEnabled": true,
    "stripePayoutsEnabled": true
  }
}

401

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

502

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

503

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}