/refresh_embedded_js_urls

Retrieves or regenerates the embedded_js_url for one or more orders. The endpoint supports requests for a specific order (using pnm_order_identifier or site_order_identifier) or for multiple orders associated with a consumer (using pnm_customer_identifier or site_customer_identifier).

The embedded_js_url is required to invoke the Embedded Form. This URL expires 30 minutes after order creation, whether the order is created via bulk file upload or through the /create_order endpoint. Before an agent can invoke the Embedded Form, the embedded_js_url must be regenerated if it has expired.

When regenerating the embedded_js_url for all orders associated with a customer, pagination parameters can be used to control the response size. The limit parameter specifies the maximum number of orders (up to 5) to return per request (default is 2). The offset parameter specifies the number of orders to skip before beginning to return results (default is 0).

To regenerate the embedded_js_url for all matching orders regardless of expiration status, set the force parameter to true. If force is set to false or is not provided, the embedded_js_url is regenerated only for orders where the existing URL has expired.

Language
URL