Skip to main content

Cancel a virtual IBAN

Cancel a virtual IBAN with the API. Note that canceling a virtual IBAN is permanent; they can't be reactivated.

Guide​

  1. Call the cancelVirtualIbanEntry mutation.
  2. Enter the ID for the virtual IBAN you'd like to cancel (virtualIbanEntryId).
  3. Add the success payload, including any information you'd like to review.
  4. Add rejections (not shown).

Mutation​

🔎 Open the mutation in API Explorer

mutation CancelVirtual {
cancelVirtualIbanEntry(
input: { virtualIbanEntryId: "$YOUR_VIRTUAL_IBAN_ID" }
) {
... on CancelVirtualIbanEntrySuccessPayload {
__typename
virtualIbanEntry {
BIC
id
blockSDD
label
status
IBAN
}
}
}
}

Payload​

The payload shows the IBAN status changed to Canceled.

{
"data": {
"cancelVirtualIbanEntry": {
"__typename": "CancelVirtualIbanEntrySuccessPayload",
"virtualIbanEntry": {
"BIC": "SWNBFR22",
"id": "$YOUR_VIRTUAL_IBAN_ID",
"blockSDD": false,
"label": "Virtual",
"status": "Canceled",
"IBAN": "FR7617328899000000000000000"
}
}
}
}