Skip to main content
POST
Simulate a charge
Authorizes and clears a charge on a sandbox card in one call. A single-use card closes after it, as it would after a real charge.

Authorizations

Authorization
string
header
required

A platform access token. Get one on the Create an access token endpoint by exchanging your client_id + client_secret, then send it as Authorization: Bearer <token>. Tokens live one hour.

Path Parameters

card_id
string
required

Body

application/json
amount_cents
integer

Defaults to $6.75, or the card's balance if that's lower.

Required range: x >= 1
merchant
string

The merchant name on the transaction.

Maximum string length: 80
mcc
string

The merchant category code. Defaults to 5812, a restaurant.

Pattern: ^\d{4}$

Response

The cleared transaction.

object
string
required
Allowed value: "test_transaction"
id
string
required
card_id
string
required
amount_cents
integer
required

Negative on a refund.

merchant
string
required
status
enum<string>
required
Available options:
authorized,
cleared,
declined,
voided,
refunded
simulated
boolean
required
events
string[]
required

The webhook events this call sent.

card
object
required
mcc
string
decline_reason
string
original_transaction_id
string

On a refund, the transaction it refunds.