Prepaid Payment API

Consumes prepaid balance to pay the filing fee for the specified form. Supports optional coupon codes and idempotency to prevent duplicate charges.

Endpoint:

POST /api/payment/prepaid

Description: Processes a prepaid payment for a form using the user’s prepaid balance. Supports optional coupon codes and requires billing address.

Request Body

{
  "formKey": "string (required)",
  "userKey": "string (required)",
  "couponCode": "string (optional)",
  "idempotencyKey": "string (optional)",
  "billingAddress": {
    "streetAddress1": "string (required)",
    "city": "string (required)",
    "state": "string (required)",
    "zipcode": "string (required)",
    "country": "string (required)"
  }
}

Validation Rules

formKey → required
userKey → required
billingAddress → required object
All billing address fields must be non-empty strings

Responses

// Validation Failure
{
  "Status": false,
  "Message": "Validation failed",
  "ErrorMessage": "billingAddress.zipcode: Zipcode is required"
}
// Success
{
  "Status": true,
  "PaymentStatus": "completed",
  "TransactionId": "PREPAID-31fb65d5",
  "ReferenceNumber": "201126246",
  "Amount": 1090,
  "Message": "Payment successful using prepaid balance. Amount: $10.90"
}