Search…
Simulate Debits
Simulate a charge from a merchant to a virtual card.
A debit is a request by a merchant to charge a virtual card. The debit must be associated with a previously created authorization.

Create a Simulated Debit

A simulated debit is created by calling the simulate debit API and supplying the identifier of the authorization and the amount to be debited.
The authorizationId is the identifier of an authorization that was created by calling the Create a Simulated Authorization API. The amount supplied as input is expressed as a multiple of the smallest unit of currency the merchant accepts. For example if the currency is US dollar then the amount is the number of US cents.
An example implementation of creating a simulated debit is:
TypeScript
Swift
Kotlin
1
try {
2
const result = await simulatorClient.simulateDebit({
3
authorizationId: authorization.id,
4
amount: 1200,
5
})
6
} catch (error) {
7
// Handle error
8
}
Copied!
1
let debitInput = SimulateDebitInput(
2
amount: 1200,
3
authorizationId: authorization.id
4
)
5
simulatorClient.simulateDebitWithInput(debitInput) { result in
6
switch result {
7
case .success:
8
// Debit has been created
9
case .failure:
10
// Handle/notify the user of exception
11
}
12
}
Copied!
1
val debitInput = SimulateDebitInput(
2
authorizationId = authorization.id,
3
amount = 1200
4
)
5
launch {
6
try {
7
val debit = withContext(Dispatchers.IO) {
8
simulatorClient.simulateDebit(debitInput)
9
}
10
// Debit has been created
11
} catch (e: DebitException) {
12
// Handle/notify the user of exception
13
}
14
}
Copied!
This API call creates a simulated charge against a virtual card. If an exception occurs, the error or exception will contain a description of the fault that caused the exception.
Last modified 14d ago
Copy link