POST
/
v2
/
payment_links
/
connections
Connect to the payment links provider
curl --request POST \
  --url https://thirdparty.qonto.com/v2/payment_links/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "partner_callback_url": "https://partner.com/payment-links/onboarding-callback",
  "user_bank_account_id": "46e9e0d2-f1af-4d2e-a6be-a536a604b89e",
  "user_phone_number": "+33612345678",
  "user_website_url": "https://the-user-website.com",
  "business_description": "An 80-chars long string describing the business. An 80-chars long string describing the business."
}'
{
  "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.

Body

application/json
​
partner_callback_url
string
required

URL to redirect the user to after the connection is completed.

Example:

"https://partner.com/payment-links/onboarding-callback"

​
user_bank_account_id
string
required

The bank account ID to link to the payment links provider profile.

Example:

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

​
user_phone_number
string<e164>
required

The phone number to associate with the payment links provider account.

Example:

"+33612345678"

​
business_description
string | null
required

The business description to associate with the payment links provider account.

Minimum length: 80
Example:

"An 80-chars long string describing the business. An 80-chars long string describing the business."

​
user_website_url
string<http> | null

The user's website URL. The url is valid if it starts with http or https and does not contain any @

Example:

"https://the-user-website.com"

Response

The connection has been created successfully, and the customer can be redirected to complete the onboarding.

​
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"