Skip to main content
POST
Simulate a card transaction

Authorizations

x-contro-api-key
string
header
required

Partner API key (sk_live_* for production, sk_test_* for sandbox)

Body

application/json
cardId
string
required

ID of the sandbox card

Minimum string length: 1
Example:

"card_sandbox_123"

amount
number
required

Transaction amount in minor units (cents)

Example:

2500

currency
string
default:USD

ISO 4217 currency code

Example:

"USD"

merchantName
string
default:Sandbox Merchant

Simulated merchant name

Example:

"Test Coffee Shop"

type
enum<string>
default:purchase

purchase settles spend against the sandbox balance; refund credits back a prior simulated purchase

Available options:
purchase,
refund
originalTransactionId
string

Required for refunds: the transactionId of the simulated purchase to refund

Minimum string length: 1

Response

Transaction simulated

transactionId
string
required
amount
number
required
currency
string
required
status
string
required