ExternalPayment

Single entry-point for payment submission. Creates a Pending Payment record, then confirms the PaymentIntent server-side with Stripe. The webpage is not responsible for completion — the Stripe webhook promotes the record to Completed.

post/api/v1/ExternalPayment/{guid}/submit-payment

Request

  • Base URL
    https://api.fireserviceusa.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.fireserviceusa.com/api/v1/ExternalPayment/{guid}/submit-payment
  • Auth
    none declared

Path parameters

guidstring required

Request body

PaymentMethodIdstring nullable

Stripe PaymentMethod ID created client-side via stripe.createPaymentMethod({ elements })

CustomerEmailstring nullable
Amountnumber double

Gross amount (invoice net + fee). Server validates against PaymentIntent amount.

InvoiceAmountnumber double nullable

Net invoice amount (excluding processing fee). Used as fallback when PaymentIntent metadata is unavailable (e.g. dev mode).

SelectedPaymentMethodstring nullable

Payment method the user selected in the UI: creditcard / debitcard / ach

ReturnUrlstring nullable

Return URL used for 3DS / bank redirect flows

Response

Success

Changes

No operation changes recorded.