---
title: "Create a Charge"
method: POST
path: "/v1/charge/api-key"
tags: ["Charge"]
---

# Create a Charge

`POST /v1/charge/api-key`

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

## Query parameters

- `apiKey` string, required

## Request body

- CreateChargeByApiKeyDto
  - `paymentRequestId` string, required — The unique identifier of the pay link you want to use to create a charge.
  - `requestAmount` string — The amount to charge when using a dynamic pay link.
  - `expiresAt` string — The expiration date and time of the charge in ISO 8601 format (e.g., 2025-09-01T14:31:44.171Z).
  - `successRedirectUrl` string — 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.
  - `cancelRedirectUrl` string — 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.
  - `prepareRequestBody` object — Optional configuration passed when preparing the charge.
    - `customerDetails` object — Additional customer metadata for the charge.
      - `additionalJSON` string — Arbitrary JSON string attached to the charge. Useful for passing custom metadata.

## Response `200`

Charge successfully created

- ChargePageUrl
  - `id` string, required
  - `pageUrl` string, required

## Other responses

- `401` — Provided API key has no access to the resource.

---

[API](https://skmtc.net/hel/apis/helio-open-api.md) · [All operations](https://skmtc.net/hel/apis/helio-open-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hel/helio-open-api/revisions/5732beb2d39f/schema)