Skip to content

Charge a custom amount to a saved card

POST
/payment/one_off_charge
billing.funnelfox.com

Charge an arbitrary amount and currency against a customer’s saved card, without a Price Point.

org_id
required
string

Organization ID

Media typeapplication/json
OneOffChargeIn
object
external_id
required
Customer Id

Your unique identifier for the user

string
≤ 256 characters
amount
required
Any of:
number
currency_code
required
Currency Code

Three-letter ISO currency code. Case-insensitive.

string
3–3 characters
idempotency_key
required
Idempotency Key

Unique key per purchase intent. Reuse it on retries to avoid double-charging.

string
1–128 characters
client_metadata
object
Client Metadata

Custom metadata from your client application

Show 1 propertyHide property
key
additional properties
any

Example generated

{
"external_id": "example",
"amount": 1,
"currency_code": "example",
"idempotency_key": "example",
"client_metadata": {}
}

200 Payment status and details

Section titled “200”
Media typeapplication/json
OneOffChargeOut
object
action_required_token
required
Action Required Token

Always empty for custom charges — merchant-initiated charges have no authentication step.

string
checkout_status
required
CheckoutPaymentStatus
string
one of processing succeeded failed cancelled
failed_message_for_user
required
Failed Message For User
string
order_id
required
string format: uuid
nullable
idempotent_replay
Idempotent Replay

True when this response replays an earlier charge made with the same idempotency key, rather than a new charge.

boolean