Returns what is enabled for the company, its tariff and, once issued, the IBAN with its balance. `account` is `null` until an IBAN has been issued. An IBAN still being issued is re-checked on every call.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
companyId |
path | string (uuid) |
yes | Your company that Payca enabled for Virtual IBAN. |
fundingAccountId |
query | string (uuid) |
no | Your EUR account to show next to the bank balance before an IBAN is issued. Once issued, the account the issue fee was paid from is used. |
Responses
| Status | Body | Description |
|---|---|---|
200 |
VirtualIbanState |
Virtual IBAN state. |
401 |
— | Missing or invalid `x-client-id` / `x-client-secret` (no body). |
403 |
VirtualIbanError |
The request was refused; `code` says why (see the Virtual IBAN section). |
404 |
VirtualIbanError |
The request was refused; `code` says why (see the Virtual IBAN section). |
409 |
VirtualIbanError |
The request was refused; `code` says why (see the Virtual IBAN section). |
503 |
VirtualIbanError |
The request was refused; `code` says why (see the Virtual IBAN section). |
Specification
This page is generated from the OpenAPI specification, which remains the authoritative machine-readable source.