Skip to content

Depot payments public

Registers the public pay surface.

This page is generated from the Depot route table. Every operation carries the permission it needs and the anchor an agent can link to.

GETNo permission neededpublic facemspIdempotentToken in the pathNot fully resolved

What this page does not know
  • response

These are parts of the route the extractor could not read from the source. Everything else on this page came straight from it.

Source: [object Object]

Wrap

NameInTypeRequiredDescription
tokenpathstringYes
StatusBodyDescription
200NoneSuccess. The body shape was not resolved; see x-outpost-unresolved.
404application/problem+json, ProblemDetailsThis payment link is no longer valid. It may have expired or been replaced. Contact the sender for a new one.
413application/problem+json, ProblemDetailsThat request is too large.
429application/problem+json, ProblemDetailsPlease wait a moment and try again.
Terminal window
# This operation is public. It takes no credentials.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/public/autopay/revoke/<token>' \
-H 'Accept: application/json'

POST /api/v1/public/autopay/revoke/{token}

Section titled “POST /api/v1/public/autopay/revoke/{token}”

POSTNo permission neededpublic facemspToken in the pathNot fully resolved

What this page does not know
  • response

These are parts of the route the extractor could not read from the source. Everything else on this page came straight from it.

Source: [object Object]

Wrap

NameInTypeRequiredDescription
tokenpathstringYes
StatusBodyDescription
200NoneSuccess. The body shape was not resolved; see x-outpost-unresolved.
404application/problem+json, ProblemDetailsThis payment link is no longer valid. It may have expired or been replaced. Contact the sender for a new one.
413application/problem+json, ProblemDetailsThat request is too large.
429application/problem+json, ProblemDetailsPlease wait a moment and try again.
Terminal window
# This operation is public. It takes no credentials.
curl -X POST 'https://depot.example.com/api/v1/public/autopay/revoke/<token>' \
-H 'Accept: application/json'

GET /api/v1/public/autopay/revoke/{token}/favicon

Section titled “GET /api/v1/public/autopay/revoke/{token}/favicon”

GETNo permission neededpublic facemspIdempotentToken in the pathNot fully resolved

What this page does not know
  • response

These are parts of the route the extractor could not read from the source. Everything else on this page came straight from it.

Source: [object Object]

Wrap

NameInTypeRequiredDescription
tokenpathstringYes
StatusBodyDescription
200NoneSuccess. The body shape was not resolved; see x-outpost-unresolved.
404application/problem+json, ProblemDetailsThis payment link is no longer valid. It may have expired or been replaced. Contact the sender for a new one.
413application/problem+json, ProblemDetailsThat request is too large.
429application/problem+json, ProblemDetailsPlease wait a moment and try again.
Terminal window
# This operation is public. It takes no credentials.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/public/autopay/revoke/<token>/favicon' \
-H 'Accept: application/json'

GET /api/v1/public/autopay/revoke/{token}/logo

Section titled “GET /api/v1/public/autopay/revoke/{token}/logo”

GETNo permission neededpublic facemspIdempotentToken in the pathNot fully resolved

What this page does not know
  • response

These are parts of the route the extractor could not read from the source. Everything else on this page came straight from it.

Source: [object Object]

Wrap

NameInTypeRequiredDescription
tokenpathstringYes
StatusBodyDescription
200NoneSuccess. The body shape was not resolved; see x-outpost-unresolved.
404application/problem+json, ProblemDetailsThis payment link is no longer valid. It may have expired or been replaced. Contact the sender for a new one.
413application/problem+json, ProblemDetailsThat request is too large.
429application/problem+json, ProblemDetailsPlease wait a moment and try again.
Terminal window
# This operation is public. It takes no credentials.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/public/autopay/revoke/<token>/logo' \
-H 'Accept: application/json'

GET /api/v1/public/autopay/revoke/{token}/logo-dark

Section titled “GET /api/v1/public/autopay/revoke/{token}/logo-dark”

GETNo permission neededpublic facemspIdempotentToken in the pathNot fully resolved

What this page does not know
  • response

These are parts of the route the extractor could not read from the source. Everything else on this page came straight from it.

Source: [object Object]

Wrap

NameInTypeRequiredDescription
tokenpathstringYes
StatusBodyDescription
200NoneSuccess. The body shape was not resolved; see x-outpost-unresolved.
404application/problem+json, ProblemDetailsThis payment link is no longer valid. It may have expired or been replaced. Contact the sender for a new one.
413application/problem+json, ProblemDetailsThat request is too large.
429application/problem+json, ProblemDetailsPlease wait a moment and try again.
Terminal window
# This operation is public. It takes no credentials.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/public/autopay/revoke/<token>/logo-dark' \
-H 'Accept: application/json'

GETNo permission neededpublic facemspIdempotentToken in the pathNot fully resolved

What this page does not know
  • response

These are parts of the route the extractor could not read from the source. Everything else on this page came straight from it.

Source: [object Object]

Wrap

NameInTypeRequiredDescription
tokenpathstringYes
StatusBodyDescription
200NoneSuccess. The body shape was not resolved; see x-outpost-unresolved.
404application/problem+json, ProblemDetailsThis payment link is no longer valid. It may have expired or been replaced. Contact the sender for a new one.
413application/problem+json, ProblemDetailsThat request is too large.
429application/problem+json, ProblemDetailsPlease wait a moment and try again.
Terminal window
# This operation is public. It takes no credentials.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/public/autopay/setup/<token>' \
-H 'Accept: application/json'

POST /api/v1/public/autopay/setup/{token}/enroll

Section titled “POST /api/v1/public/autopay/setup/{token}/enroll”

POSTNo permission neededpublic facemspToken in the pathNot fully resolved

What this page does not know
  • response

These are parts of the route the extractor could not read from the source. Everything else on this page came straight from it.

Source: [object Object]

Wrap

NameInTypeRequiredDescription
tokenpathstringYes
StatusBodyDescription
200NoneSuccess. The body shape was not resolved; see x-outpost-unresolved.
404application/problem+json, ProblemDetailsThis payment link is no longer valid. It may have expired or been replaced. Contact the sender for a new one.
413application/problem+json, ProblemDetailsThat request is too large.
429application/problem+json, ProblemDetailsPlease wait a moment and try again.
Terminal window
# This operation is public. It takes no credentials.
curl -X POST 'https://depot.example.com/api/v1/public/autopay/setup/<token>/enroll' \
-H 'Accept: application/json'

GET /api/v1/public/autopay/setup/{token}/favicon

Section titled “GET /api/v1/public/autopay/setup/{token}/favicon”

GETNo permission neededpublic facemspIdempotentToken in the pathNot fully resolved

What this page does not know
  • response

These are parts of the route the extractor could not read from the source. Everything else on this page came straight from it.

Source: [object Object]

Wrap

NameInTypeRequiredDescription
tokenpathstringYes
StatusBodyDescription
200NoneSuccess. The body shape was not resolved; see x-outpost-unresolved.
404application/problem+json, ProblemDetailsThis payment link is no longer valid. It may have expired or been replaced. Contact the sender for a new one.
413application/problem+json, ProblemDetailsThat request is too large.
429application/problem+json, ProblemDetailsPlease wait a moment and try again.
Terminal window
# This operation is public. It takes no credentials.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/public/autopay/setup/<token>/favicon' \
-H 'Accept: application/json'

GET /api/v1/public/autopay/setup/{token}/logo

Section titled “GET /api/v1/public/autopay/setup/{token}/logo”

GETNo permission neededpublic facemspIdempotentToken in the pathNot fully resolved

What this page does not know
  • response

These are parts of the route the extractor could not read from the source. Everything else on this page came straight from it.

Source: [object Object]

Wrap

NameInTypeRequiredDescription
tokenpathstringYes
StatusBodyDescription
200NoneSuccess. The body shape was not resolved; see x-outpost-unresolved.
404application/problem+json, ProblemDetailsThis payment link is no longer valid. It may have expired or been replaced. Contact the sender for a new one.
413application/problem+json, ProblemDetailsThat request is too large.
429application/problem+json, ProblemDetailsPlease wait a moment and try again.
Terminal window
# This operation is public. It takes no credentials.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/public/autopay/setup/<token>/logo' \
-H 'Accept: application/json'

GET /api/v1/public/autopay/setup/{token}/logo-dark

Section titled “GET /api/v1/public/autopay/setup/{token}/logo-dark”

GETNo permission neededpublic facemspIdempotentToken in the pathNot fully resolved

What this page does not know
  • response

These are parts of the route the extractor could not read from the source. Everything else on this page came straight from it.

Source: [object Object]

Wrap

NameInTypeRequiredDescription
tokenpathstringYes
StatusBodyDescription
200NoneSuccess. The body shape was not resolved; see x-outpost-unresolved.
404application/problem+json, ProblemDetailsThis payment link is no longer valid. It may have expired or been replaced. Contact the sender for a new one.
413application/problem+json, ProblemDetailsThat request is too large.
429application/problem+json, ProblemDetailsPlease wait a moment and try again.
Terminal window
# This operation is public. It takes no credentials.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/public/autopay/setup/<token>/logo-dark' \
-H 'Accept: application/json'

POST /api/v1/public/autopay/setup/{token}/preview

Section titled “POST /api/v1/public/autopay/setup/{token}/preview”

POSTNo permission neededpublic facemspToken in the pathNot fully resolved

What this page does not know
  • response

These are parts of the route the extractor could not read from the source. Everything else on this page came straight from it.

Source: [object Object]

Wrap

NameInTypeRequiredDescription
tokenpathstringYes
StatusBodyDescription
200NoneSuccess. The body shape was not resolved; see x-outpost-unresolved.
404application/problem+json, ProblemDetailsThis payment link is no longer valid. It may have expired or been replaced. Contact the sender for a new one.
413application/problem+json, ProblemDetailsThat request is too large.
429application/problem+json, ProblemDetailsPlease wait a moment and try again.
Terminal window
# This operation is public. It takes no credentials.
curl -X POST 'https://depot.example.com/api/v1/public/autopay/setup/<token>/preview' \
-H 'Accept: application/json'

POST /api/v1/public/autopay/setup/{token}/session

Section titled “POST /api/v1/public/autopay/setup/{token}/session”

POSTNo permission neededpublic facemspToken in the pathNot fully resolved

What this page does not know
  • response

These are parts of the route the extractor could not read from the source. Everything else on this page came straight from it.

Source: [object Object]

Wrap

NameInTypeRequiredDescription
tokenpathstringYes
StatusBodyDescription
200NoneSuccess. The body shape was not resolved; see x-outpost-unresolved.
404application/problem+json, ProblemDetailsThis payment link is no longer valid. It may have expired or been replaced. Contact the sender for a new one.
413application/problem+json, ProblemDetailsThat request is too large.
429application/problem+json, ProblemDetailsPlease wait a moment and try again.
Terminal window
# This operation is public. It takes no credentials.
curl -X POST 'https://depot.example.com/api/v1/public/autopay/setup/<token>/session' \
-H 'Accept: application/json'

GETNo permission neededpublic facemspIdempotentToken in the pathNot fully resolved

What this page does not know
  • response

These are parts of the route the extractor could not read from the source. Everything else on this page came straight from it.

Source: [object Object]

Wrap

NameInTypeRequiredDescription
tokenpathstringYes
StatusBodyDescription
200NoneSuccess. The body shape was not resolved; see x-outpost-unresolved.
404application/problem+json, ProblemDetailsThis payment link is no longer valid. It may have expired or been replaced. Contact the sender for a new one.
413application/problem+json, ProblemDetailsThat request is too large.
429application/problem+json, ProblemDetailsPlease wait a moment and try again.
Terminal window
# This operation is public. It takes no credentials.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/public/pay/<token>' \
-H 'Accept: application/json'

GET /api/v1/public/pay/{token}/attempts/{attemptId}

Section titled “GET /api/v1/public/pay/{token}/attempts/{attemptId}”

GETNo permission neededpublic facemspIdempotentToken in the pathNot fully resolved

What this page does not know
  • response

These are parts of the route the extractor could not read from the source. Everything else on this page came straight from it.

Source: [object Object]

Wrap

NameInTypeRequiredDescription
attemptIdpathstringYes
tokenpathstringYes
StatusBodyDescription
200NoneSuccess. The body shape was not resolved; see x-outpost-unresolved.
404application/problem+json, ProblemDetailsThis payment link is no longer valid. It may have expired or been replaced. Contact the sender for a new one.
413application/problem+json, ProblemDetailsThat request is too large.
429application/problem+json, ProblemDetailsPlease wait a moment and try again.
Terminal window
# This operation is public. It takes no credentials.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/public/pay/<token>/attempts/<attemptId>' \
-H 'Accept: application/json'

POSTNo permission neededpublic facemspToken in the pathNot fully resolved

What this page does not know
  • response

These are parts of the route the extractor could not read from the source. Everything else on this page came straight from it.

Source: [object Object]

Wrap

NameInTypeRequiredDescription
tokenpathstringYes
StatusBodyDescription
200NoneSuccess. The body shape was not resolved; see x-outpost-unresolved.
404application/problem+json, ProblemDetailsThis payment link is no longer valid. It may have expired or been replaced. Contact the sender for a new one.
413application/problem+json, ProblemDetailsThat request is too large.
429application/problem+json, ProblemDetailsPlease wait a moment and try again.
Terminal window
# This operation is public. It takes no credentials.
curl -X POST 'https://depot.example.com/api/v1/public/pay/<token>/autopay' \
-H 'Accept: application/json'

POST /api/v1/public/pay/{token}/autopay/preview

Section titled “POST /api/v1/public/pay/{token}/autopay/preview”

POSTNo permission neededpublic facemspToken in the pathNot fully resolved

What this page does not know
  • response

These are parts of the route the extractor could not read from the source. Everything else on this page came straight from it.

Source: [object Object]

Wrap

NameInTypeRequiredDescription
tokenpathstringYes
StatusBodyDescription
200NoneSuccess. The body shape was not resolved; see x-outpost-unresolved.
404application/problem+json, ProblemDetailsThis payment link is no longer valid. It may have expired or been replaced. Contact the sender for a new one.
413application/problem+json, ProblemDetailsThat request is too large.
429application/problem+json, ProblemDetailsPlease wait a moment and try again.
Terminal window
# This operation is public. It takes no credentials.
curl -X POST 'https://depot.example.com/api/v1/public/pay/<token>/autopay/preview' \
-H 'Accept: application/json'

POSTNo permission neededpublic facemspToken in the pathNot fully resolved

What this page does not know
  • response

These are parts of the route the extractor could not read from the source. Everything else on this page came straight from it.

Source: [object Object]

Wrap

NameInTypeRequiredDescription
tokenpathstringYes
StatusBodyDescription
200NoneSuccess. The body shape was not resolved; see x-outpost-unresolved.
404application/problem+json, ProblemDetailsThis payment link is no longer valid. It may have expired or been replaced. Contact the sender for a new one.
413application/problem+json, ProblemDetailsThat request is too large.
429application/problem+json, ProblemDetailsPlease wait a moment and try again.
Terminal window
# This operation is public. It takes no credentials.
curl -X POST 'https://depot.example.com/api/v1/public/pay/<token>/confirm' \
-H 'Accept: application/json'

GETNo permission neededpublic facemspIdempotentToken in the pathNot fully resolved

What this page does not know
  • response

These are parts of the route the extractor could not read from the source. Everything else on this page came straight from it.

Source: [object Object]

Wrap

NameInTypeRequiredDescription
tokenpathstringYes
StatusBodyDescription
200NoneSuccess. The body shape was not resolved; see x-outpost-unresolved.
404application/problem+json, ProblemDetailsThis payment link is no longer valid. It may have expired or been replaced. Contact the sender for a new one.
413application/problem+json, ProblemDetailsThat request is too large.
429application/problem+json, ProblemDetailsPlease wait a moment and try again.
Terminal window
# This operation is public. It takes no credentials.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/public/pay/<token>/favicon' \
-H 'Accept: application/json'

GETNo permission neededpublic facemspIdempotentToken in the pathNot fully resolved

What this page does not know
  • response

These are parts of the route the extractor could not read from the source. Everything else on this page came straight from it.

Source: [object Object]

Wrap

NameInTypeRequiredDescription
tokenpathstringYes
StatusBodyDescription
200NoneSuccess. The body shape was not resolved; see x-outpost-unresolved.
404application/problem+json, ProblemDetailsThis payment link is no longer valid. It may have expired or been replaced. Contact the sender for a new one.
413application/problem+json, ProblemDetailsThat request is too large.
429application/problem+json, ProblemDetailsPlease wait a moment and try again.
Terminal window
# This operation is public. It takes no credentials.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/public/pay/<token>/logo' \
-H 'Accept: application/json'

GETNo permission neededpublic facemspIdempotentToken in the pathNot fully resolved

What this page does not know
  • response

These are parts of the route the extractor could not read from the source. Everything else on this page came straight from it.

Source: [object Object]

Wrap

NameInTypeRequiredDescription
tokenpathstringYes
StatusBodyDescription
200NoneSuccess. The body shape was not resolved; see x-outpost-unresolved.
404application/problem+json, ProblemDetailsThis payment link is no longer valid. It may have expired or been replaced. Contact the sender for a new one.
413application/problem+json, ProblemDetailsThat request is too large.
429application/problem+json, ProblemDetailsPlease wait a moment and try again.
Terminal window
# This operation is public. It takes no credentials.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/public/pay/<token>/logo-dark' \
-H 'Accept: application/json'

GETNo permission neededpublic facemspIdempotentToken in the pathNot fully resolved

What this page does not know
  • response

These are parts of the route the extractor could not read from the source. Everything else on this page came straight from it.

Source: [object Object]

Wrap

NameInTypeRequiredDescription
tokenpathstringYes
StatusBodyDescription
200NoneSuccess. The body shape was not resolved; see x-outpost-unresolved.
404application/problem+json, ProblemDetailsThis payment link is no longer valid. It may have expired or been replaced. Contact the sender for a new one.
413application/problem+json, ProblemDetailsThat request is too large.
429application/problem+json, ProblemDetailsPlease wait a moment and try again.
Terminal window
# This operation is public. It takes no credentials.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/public/pay/<token>/pdf' \
-H 'Accept: application/json'

POSTNo permission neededpublic facemspToken in the pathNot fully resolved

What this page does not know
  • response

These are parts of the route the extractor could not read from the source. Everything else on this page came straight from it.

Source: [object Object]

Wrap

NameInTypeRequiredDescription
tokenpathstringYes
StatusBodyDescription
200NoneSuccess. The body shape was not resolved; see x-outpost-unresolved.
404application/problem+json, ProblemDetailsThis payment link is no longer valid. It may have expired or been replaced. Contact the sender for a new one.
413application/problem+json, ProblemDetailsThat request is too large.
429application/problem+json, ProblemDetailsPlease wait a moment and try again.
Terminal window
# This operation is public. It takes no credentials.
curl -X POST 'https://depot.example.com/api/v1/public/pay/<token>/quote' \
-H 'Accept: application/json'

POSTNo permission neededpublic facemspToken in the pathNot fully resolved

What this page does not know
  • response

These are parts of the route the extractor could not read from the source. Everything else on this page came straight from it.

Source: [object Object]

Wrap

NameInTypeRequiredDescription
tokenpathstringYes
StatusBodyDescription
200NoneSuccess. The body shape was not resolved; see x-outpost-unresolved.
404application/problem+json, ProblemDetailsThis payment link is no longer valid. It may have expired or been replaced. Contact the sender for a new one.
413application/problem+json, ProblemDetailsThat request is too large.
429application/problem+json, ProblemDetailsPlease wait a moment and try again.
Terminal window
# This operation is public. It takes no credentials.
curl -X POST 'https://depot.example.com/api/v1/public/pay/<token>/session' \
-H 'Accept: application/json'

Content is licensed CC BY 4.0. Code samples are MIT. Outpost and the Outpost mark are trademarks of Outpost Business Solutions, PBC and are not covered by either license.