EaserixDocs
DevelopersAPI referenceSignPayments

Start, or resume, the payment for a payment field (EAS-119)

Idempotent: a double click, a reload, or a retry after a declined card all land on the same PaymentIntent. The amount and currency are the field's own, snapshotted when the payment starts — nothing in the request can change them. Requires the same signing state as signingComplete (pending, before the deadline, this signer's turn, not yet signed or declined), and the field must be a payment field assigned to the caller. The response carries the client secret that Stripe.js confirms in the browser; whether the payment succeeded is never reported by the browser — it is learned from Stripe's webhook, or by reading the PaymentIntent server-side.

View as Markdown
POST
/public/signing/{token}/fields/{fieldId}/payment-intent

Path Parameters

token*string
fieldId*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/public/signing/string/fields/string/payment-intent"
{  "clientSecret": "string",  "publishableKey": "string",  "stripeAccount": "string",  "payment": {    "status": "requires_payment",    "paid": true,    "amountMinor": 0,    "currency": "string",    "description": "string",    "failureMessage": "string",    "failureCode": "string"  }}

A document's payments, with refund and failure state (EAS-119)

What the sender needs to see: each payment's status (requires_payment, processing, succeeded, failed, canceled, refunded, partially_refunded, disputed), the Stripe reference, any failure reason, and the refunded amount. Empty for a document with no payment field.

Where a payment stands (EAS-119)

Polled by the signer's page after the card is confirmed. When Stripe's webhook has not landed yet and the payment is still open, the PaymentIntent is read from Stripe, so a signer who has just paid is never left waiting on webhook delivery.