Save a payment method from a completed setup intent

POST

/api/portal/payment-methods

curl --request POST \
  --url https://api.getvespy.com/api/portal/payment-methods \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "authorizationKind": "one_time", "authorizationLanguageVersion": "example", "isDefault": true, "setupIntentId": "example" }'

• Production
• Development
• Local

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

authorizationKind

string

Allowed values: one_time recurring

authorizationLanguageVersion

string

>= 1 characters <= 80 characters

isDefault

boolean

setupIntentId

required

string

>= 1 characters

Responses

201

Default Response

Media typeapplication/json

object

paymentMethod

required

object

brand

required

string

nullable >= 1 characters <= 80 characters

createdAt

required

string format: date-time

expMonth

required

integer

nullable >= 1 <= 12

expYear

required

integer

nullable >= 2000 <= 9999

id

required

string format: uuid

isDefault

required

boolean

kind

required

string

Allowed values: us_bank_account card

last4

required

string

nullable >= 1 characters <= 8 characters

status

required

string

Allowed values: verified pending_verification blocked invalid

tenantId

required

string format: uuid

Example

{
  "paymentMethod": {
    "kind": "us_bank_account",
    "status": "verified"
  }
}

400

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"
}

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"
}

409

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"
}

412

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"
}