Skip to content
Vespy API

List saved payment methods for the authenticated tenant

GET
/api/portal/payment-methods
curl --request GET \
  --url https://api.getvespy.com/api/portal/payment-methods \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
paymentMethods
required
Array<object>
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
{
  "paymentMethods": [
    {
      "kind": "us_bank_account",
      "status": "verified"
    }
  ]
}

401

Section titled “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
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Section titled “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
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

503

Section titled “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
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}