Void

Suggest Edits

A Void transaction will Void (effectively cancel) an existing transaction that has not yet been settled, and is available immediately after an Auth, Sale, Capture, or Refund transaction request is created.

Voids differ from Refund transactions in that Voids cancel a transaction that has not yet settled, and can be performed immediately after an erroneous transaction. In order to perform a Refund, the transaction must be settled - i.e. the transaction has "gone through"- usually as early as the next day.

For already settled transactions, see Refund Transaction.

API Request Example

A Void transaction can be created by calling our POST /v1/transactions API endpoint and providing void as the value of the type property.

Below is a Void transaction example with the minimum required request fields, for a previously approved Auth transaction which had the id of h1rn8c9nd81y9bkgzax2k2rax.

{
    "type": "void",
    "transactionId": "txn_h1rn8c9nd81y9bkgzax2k2rax"
}

{
    "amount": 145,
    "authorization": {
        "approvedAmount": 145,
        "partial": false,
        "processorMessage": "canceled",
        "processorTransactionId": "pi_3MgGccAzKBz0Hugp2ItYTEdq",
        "status": "A"
    },
    "createdOn": "2023-02-22T00:00:49Z",
    "currency": "USD",
    "id": "txn_6v59stftbs837axmpahj21m8jf",
    "merchantId": "mid_2zyd88xrnr90xskmjmqpd0x1vj",
    "message": "Void Succeeded",
    "originalTransactionId": "txn_h1rn8c9nd81y9bkgzax2k2rax",
    "payment": {
        "bin": "432100",
        "brand": "VISA",
        "last4": "0012",
        "type": "CREDIT"
    },
    "plan": {
        "id": "plan_57jaev7pna8nftrkr6xksaastw",
        "name": "Stripe Only Plan"
    },
    "platformId": "pfm_7aj2pxrrcg8zs8x6cxyyrwmyqe",
    "processor": {
        "id": "midCon_6v59stftbs837axmpahj21m8jf",
        "name": "Stripe"
    },
    "type": "void"
}

Updated 12 months ago

What’s Next

Capture