Simulate Refunds

Simulate a refund from a merchant to a virtual card.

A refund is a request by a merchant to return money to a virtual card. The refund must be associated with a previously created debit.

Create a Simulated Refund

A simulated refund is created by calling the simulate refund API and supplying the identifier of a previous debit and the amount to refund.

The debitId is the identifier of a debit that was created by calling the Create a Simulated Debit 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 refund is:

TypeScript

try {
  const result = await simulatorClient.simulateRefund({
    debitId: debit.id,
    amount: 1200,
  })
} catch (error) {
  // Handle error
}

Swift

do {
    let refundInput = SimulateRefundInput(
        amount: 1200,
        debitId: debit.id
    )
    let response = try await simulatorClient.simulateRefundWithInput(
        refundInput
    )
    // Refund has been created
} catch let error {
    // Handle/notify the user of error
}

Kotlin

val refundInput = SimulateRefundInput(
    debitId = debit.id,
    amount = 1200
)
launch {
    try {
        val refund = withContext(Dispatchers.IO) {
             simulatorClient.simulateRefund(refundInput)
        }
        // Refund has been created
    } catch (e: RefundException) {
        // Handle/notify the user of exception
    }
}

This API call creates a simulated refund against a virtual card. If an exception occurs, the error or exception will contain a description of the fault that caused the exception.