beel_list_payment_connections
Retrieve a company's payment provider connections, including linked external accounts and statuses, to check if a provisioned NIF has completed its connection.
Instructions
Returns the payment provider connections of a company your account owns or
manages, with the provider-side account each one points at and its status. Use it to
check whether a NIF you provisioned has completed its connection.
A NIF with no connections: answers
200with an empty list.environment: Test and Live connections are independent, so only the ones living in the mode of the key you ask with are returned; this field states which.
Closed catalogue. A NIF is not limited to one connection per provider: within a single
environment it may hold several of the same provider, one per external account. What is
unique is the external account itself — one live connection per provider, environment and
external account. The set is still bounded and unpaginated: the collection carries no
pagination and takes no page/limit, and every response holds the whole set for the
environment of the key you ask with.
Endpoint: GET /v1/companies/{company_id}/payment-connections
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company_id | Yes | Unique identifier (UUID) of the company the operation acts on — its identifier, not its NIF. It is the only source of context: the account that owns it is derived from it, and the `BeeL-Active-Company` header plays no part. A company you do not reach answers `403`, and so does a company that does not exist, so the existence of a company in another account is never disclosed. |