Create a payment intent for selected charges

POST

/api/portal/payments

curl --request POST \
  --url https://api.getvespy.com/api/portal/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "authorizationLanguageVersion": "example", "chargeIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "paymentMethodId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

• Production
• Development
• Local

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

authorizationLanguageVersion

string

>= 1 characters <= 80 characters

chargeIds

required

Array<string>

>= 1 items <= 50 items

paymentMethodId

required

string format: uuid

Example^generated

{
  "authorizationLanguageVersion": "example",
  "chargeIds": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ],
  "paymentMethodId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

200

Default Response

Media typeapplication/json

object

amountCents

required

integer

>= 1

clientSecret

required

string

>= 1 characters

connectedAccountId

required

string

>= 1 characters

convenienceFeeCents

required

integer

paymentId

required

string format: uuid

Example^generated

{
  "amountCents": 1,
  "clientSecret": "example",
  "connectedAccountId": "example",
  "convenienceFeeCents": 1,
  "paymentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

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