Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Headers

Idempotency-Key
string
required

Required. A unique value per purchase, 8 to 255 visible characters. Reuse it only to retry the same request; the retry returns the first answer with idempotentReplay: true and charges nothing. A declined card is an answer too: the retry replays the decline, so once the card is fixed, try again with a new key.

Required string length: 8 - 255

Path Parameters

locationId
string
required

The sub-account's GoHighLevel Location ID.

Minimum string length: 1

Body

application/json

The amount.

amountUSD
number
required

Dollars to charge, 1 to 10000, in whole cents.

Required range: 1 <= x <= 10000Must be a multiple of 0.01
{key}
any

Response

Charged, and the minutes added.

success
boolean
required
Example:

true

data
object
required
idempotentReplay
boolean

Present, and true, when this answer is a replay of an earlier request with the same Idempotency-Key.