Initiate Hosted Checkout

View as Markdown

Headers

{{tenant_key_name}}stringOptional

Request

This endpoint expects a multipart form.
amountstringRequired

Optional: Partial payment amount - numeric, min 0.01 - defaults to invoice balance_due

invoice_uuidstringRequired

Required: Invoice UUID to pay - uuid format - “550e8400-e29b-41d4-a716-446655440000”

checkout_modestringRequired

Optional: Checkout mode - hosted (Stripe page) or embedded (your own page via Stripe Elements) - default hosted

save_payment_methodstringRequired

Optional: Save payment method for future use - true|false

payment_method_types[]stringRequired

Optional: Payment method types - card|ach - default card

Response

Successful response