Skip to content
vocapable.Docs

Open the business's hosted payment page

POST
/v1/share/{token}/payments
curl --request POST \
  --url https://api.vocapable.com/v1/share/example/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "kind": "deposit" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
token
required
Token
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceSharedPaymentStart
object
kind
required
Kind
string
Allowed values: deposit full

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceSharedPaymentRedirect
object
url
required
Url
string
payment
required
WorkspaceSharedPayment
object
kind
required
Kind
string
Allowed values: deposit full
amount_minor
required
Amount Minor
integer
currency
required
Currency
string
status
required
Status
string
Allowed values: draft approved link_created processing paid partially_paid failed refunded disputed cancelled expired
paid_minor
required
Paid Minor
integer
refunded_minor
required
Refunded Minor
integer
Example
{
  "payment": {
    "kind": "deposit",
    "status": "draft"
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}