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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

ISO currency code for the virtual IBAN

string
required

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

boolean
Defaults to false

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

customer
object

Customer details. If omitted (or if userId is not provided), the IBAN is created for the organization. Pass any additional fields required by the payment method's requiredFields.

Headers
string
required

Merchant or sub-merchant MID

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json