Add a virtual IBAN using the API

Add a virtual IBAN with the API.

Prerequisites

The account has the account type PaymentService and the payment level Unlimited.

Guide

1. Call the addVirtualIbanEntry mutation.
2. Enter the account ID for which you'd like to add a virtual IBAN.
3. Add the success payload, including any information you'd like to review.
4. Add rejections (not shown).

Mutation

Open in API Explorer

mutation AddVirtual {
  addVirtualIbanEntry(input: { accountId: "$YOUR_ACCOUNT_ID" }) {
    ... on AddVirtualIbanEntrySuccessPayload {
      __typename
      virtualIbanEntry {
        IBAN
        BIC
        id
        label
        status
      }
    }
  }
}

Payload

The payload returns the virtual IBAN with the status Enabled.

{
  "data": {
    "addVirtualIbanEntry": {
      "__typename": "AddVirtualIbanEntrySuccessPayload",
      "virtualIbanEntry": {
        "IBAN": "FR7617328899000000000000000",
        "BIC": "SWNBFR22",
        "id": "$YOUR_VIRTUAL_IBAN_ID",
        "label": "Virtual",
        "status": "Enabled"
      }
    }
  }
}