Skip to content

Open a stable invoice link

GET
/v1/public/invoices/{id}
curl --request GET \
--url 'http://localhost:4000/v1/public/invoices/example?cs=example'

Redirects to the current payment attempt. A confirmed failed attempt may be replaced while the invoice remains payable.

id
required
string
cs
required

Invoice link secret

string
>= 1 characters

Invoice link secret

Redirect to the current hosted checkout payment

Validation error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Not found

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Invoice is no longer payable

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Rate limited; see Retry-After response header

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}