List the payment connections of a NIF
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 200 with 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.
Request
- Base URL: https://app.beel.es/api
- URL: https://app.beel.es/api/v1/companies/{company_id}/payment-connections
- Auth: HTTP bearer
Response
Connections of the NIF
Example response
{
"data": {
"connections": [
{
"id": "5f2b1c0e-9a3d-4c11-8f6e-7b0d2a4c9e13",
"provider": "stripe",
"external_account_id": "acct_1234567890",
"environment": "PROD"
}
]
},
"meta": {
"timestamp": "2025-01-15T10:30:00Z",
"request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.