Skip to main content
POST
/
transactions
/
inflight
/
bulk
/
void
curl --request POST \
  --url http://localhost:5001/transactions/inflight/bulk/void \
  --header 'X-blnk-key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "transaction_ids": [
      "txn_11111111-1111-4111-8111-111111111111",
      "txn_22222222-2222-4222-8222-222222222222",
      "txn_33333333-3333-4333-8333-333333333333"
    ]
  }'
{
  "succeeded": 2,
  "failed": 1,
  "results": [
    {
      "transaction_id": "txn_11111111-1111-4111-8111-111111111111",
      "status": "succeeded"
    },
    {
      "transaction_id": "txn_22222222-2222-4222-8222-222222222222",
      "status": "succeeded"
    },
    {
      "transaction_id": "txn_33333333-3333-4333-8333-333333333333",
      "status": "failed",
      "code": "ALREADY_COMMITTED",
      "message": "cannot void. Transaction already committed"
    }
  ]
}
If you’re using the auto-provisioned Enterprise Core instance included with your Production License deployment, set the base URL to: https://ENTERPRISE_PUBLIC_URL/core.If you’re connecting to a different Core instance, use the publicly accessible base URL for that instance instead.

Authorization

If set, the API uses an API key for authentication. Include the following header in your requests: X-blnk-key: <api-key>. Replace <api-key> with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code. See also: Secure your Blnk server
Available in version 0.14.2 and later.

Body

transaction_ids
string[]
required
Unique ids of the independently-created inflight transactions to void. The request accepts up to 100 ids.

Response

succeeded
integer
required
Number of transactions voided successfully.
failed
integer
required
Number of transactions that failed.
results
object[]
required
Per-transaction result in the same order as the request.
transaction_id
string
required
Transaction id from the request.
status
string
required
succeeded or failed.
code
string
Stable failure code, such as NOT_FOUND, ALREADY_VOIDED, ALREADY_COMMITTED, NOT_INFLIGHT, LOCKED, or INTERNAL_ERROR.
message
string
Human-readable failure message.
curl --request POST \
  --url http://localhost:5001/transactions/inflight/bulk/void \
  --header 'X-blnk-key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "transaction_ids": [
      "txn_11111111-1111-4111-8111-111111111111",
      "txn_22222222-2222-4222-8222-222222222222",
      "txn_33333333-3333-4333-8333-333333333333"
    ]
  }'
{
  "succeeded": 2,
  "failed": 1,
  "results": [
    {
      "transaction_id": "txn_11111111-1111-4111-8111-111111111111",
      "status": "succeeded"
    },
    {
      "transaction_id": "txn_22222222-2222-4222-8222-222222222222",
      "status": "succeeded"
    },
    {
      "transaction_id": "txn_33333333-3333-4333-8333-333333333333",
      "status": "failed",
      "code": "ALREADY_COMMITTED",
      "message": "cannot void. Transaction already committed"
    }
  ]
}

Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.