v1

latestOpenAPI 3.1.0Proprietary2026-07-24462215.9 KB
IBAN

Create Virtual IBAN

Creates a virtual IBAN for a user or the organization.

  • If customer.userId is provided, the IBAN is created for that user
  • If customer.userId is omitted, the IBAN is created for the organization itself.

Additional customer fields (e.g. email, street, city) should be passed inside the customer object as required by the payment method's requiredFields (see GET /v3/config/payment-methods/iban).

Supports multipart/form-data when document file uploads are required by the payment method.

post/v3/iban/create-iban

Headers

MIDstring required

Merchant or sub-merchant MID

Request body

currencystring required

ISO currency code for the virtual IBAN

paymentCodestring required

Payment method code (from GET /v3/config/payment-methods/iban)

uiEnabledboolean

If true, returns a UI link to complete IBAN creation instead of creating it directly via API.

Example request

{
  "currency": "EUR",
  "paymentCode": "virtual_iban",
  "customer": {
    "userId": "UX-123456"
  }
}

Response

Virtual IBAN created successfully

statusstring
messagestring