REST API

Payments Public API

Public payment endpoints for customer payment links and payment-provider return handling.

Generated from the Celerp 2.5.0 OpenAPI schema, 21 September 2026.

GET /pay/{token}

Open Customer Payment Link

Open the public payment flow associated with a Celerp payment link.

Parameters

NameInRequiredTypeDescription
tokenpathyesstringOpaque public token identifying the shared or payment resource.

Responses

StatusDescriptionBody
200Redirects to the payment page for the document.--
422The request failed validation. The response lists each invalid field and why.HTTPValidationError

Example

curl -X GET http://localhost:8000/pay/:token \
  -H "Authorization: Bearer $TOKEN"

GET /pay/{token}/return

Handle Payment Provider Return

Handle the customer's return from the payment provider, reconcile the payment result, and show the related Celerp document.

Parameters

NameInRequiredTypeDescription
tokenpathyesstringOpaque public token identifying the shared or payment resource.
session_idquery--stringIdentifier of the bank reconciliation session.

Responses

StatusDescriptionBody
200Redirects back to the shared document once the payment result is recorded.--
422The request failed validation. The response lists each invalid field and why.HTTPValidationError

Example

curl -X GET http://localhost:8000/pay/:token/return \
  -H "Authorization: Bearer $TOKEN"