Skip to main content
POST
Process a charge

Authorizations

Authorization
string
header
required

access token

Body

application/json
idempotencyKey
string
required

Unique key to prevent duplicate charges (1-255 characters)

Example:

"charge-2025-08-15-abc123def456"

skus
object[]
required

List of SKUs to charge (at least one required)

createdBy
string
required

Identifier of who created this charge (1-255 characters)

Example:

"user-2720f109-0caf-4c62-af22-5d08c853711c"

userID
string<uuid>

User ID to charge (exactly one of userID or orgID must be provided)

Example:

"2720f109-0caf-4c62-af22-5d08c853711c"

orgID
string<uuid>

Organization ID to charge (exactly one of userID or orgID must be provided)

Example:

"3840f219-1dbf-5d73-bg33-6e19d964822d"

caseID
string

Optional case ID to associate with the charge (max 20 characters)

Example:

"2025-08-00292"

partyID
string

Optional filing party ID (max 20 characters)

Example:

"claimant"

useCredits
boolean

Whether to charge in credits (true) or dollars (false)

Example:

true

taxCredits
number

Tax amount in credits (must be non-negative)

Example:

0.5

taxDollars
number

Tax amount in dollars (must be non-negative)

Example:

0

Response

Charge processed successfully

transactionID
string
Example:

"7e2a8c9f-1b3d-4e6f-8a7c-9b1e3d5f7a9c"

balanceID
string
Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

status
string
Example:

"completed"

subtotal
number
Example:

10

tax
number
Example:

0.5

total
number
Example:

10.5

currency
string
Example:

"credits"

balanceAfterCredits
number
Example:

140

balanceAfterDollars
number
Example:

25.75

items
object[]
created
string<date-time>
Example:

"2025-08-15T14:30:00.000Z"