Sign in

v1

latestOpenAPI 3.0.02026-07-2656110201.6 KB
Charge

Create a Charge

Creates a one-time pay link (charge) that can be used to collect a single payment from a customer.

post/v1/charge/api-key

Query parameters

apiKeystring required

Your API key can be generated on the Helio Dashboard’s settings page.

Request body

paymentRequestIdstring required

The unique identifier of the pay link you want to use to create a charge.

requestAmountstring

The amount to charge when using a dynamic pay link.

expiresAtstring

The expiration date and time of the charge in ISO 8601 format (e.g., 2025-09-01T14:31:44.171Z).

successRedirectUrlstring

Redirect URL to use after a successful payment. The parent Pay Link must have a redirect URL enabled, and this value overrides the Paylink’s default success redirect URL.

cancelRedirectUrlstring

Redirect URL to use after a cancelled payment. The parent Pay Link must have a redirect URL enabled, and this value overrides the Paylink’s default success redirect URL.

Response

Charge successfully created

idstring required
pageUrlstring required