Skip to main content
GET
/
v2
/
payment_links
/
connections
Get the connection status
curl --request GET \
  --url https://thirdparty.qonto.com/v2/payment_links/connections \
  --header 'Authorization: Bearer <token>'
{
"connection_location": "<string>",
"status": "not_connected",
"bank_account_id": "46e9e0d2-f1af-4d2e-a6be-a536a604b89e"
}

Authorizations

Authorization
string
header
required

Bearer authorization header: Bearer <token>, where <token> is the access token received from the authorization server at the end of the OAuth 2.0 flow.

Headers

X-Qonto-Staging-Token
string

Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.

Response

The connection status has been retrieved successfully.

connection_location
string
required

URL to redirect the user to initiate the connection.

status
enum<string>
required

Status of the overall payment links feature activation:

  • enabled: The payment links feature is active, and the connection with the provider has been established.
  • pending: The provider requires the user to complete additional steps in the onboarding process. While no action is required from you, you may choose to notify your users about this status.
  • disabled: The payment links feature is not active.
  • not_connected: The connection with the provider has not yet been established.
Available options:
enabled,
pending,
disabled,
not_connected
Example:

"not_connected"

bank_account_id
string<uuid>
required

The bank account ID to be credited when the payment link is paid.

Example:

"46e9e0d2-f1af-4d2e-a6be-a536a604b89e"