Create Connect Link
https://api.druo.com/connect/link/createCreates a new Connect Link to securely connect an end user's bank account.
This endpoint generates a customizable Connect Link object. This link can be sent to customers to safely initiate the account connection process, supporting custom colors, redirection configurations, and language defaults.
Request body
The introductory text displayed in the center of the link interface. The text must include both the merchant name (as registered in the business profile) and 'DRUO'. This field has a minimum length of 40 characters and a maximum length of 70 characters.
The customer details for a new end user. This field is required only if existing_end_user_id is not provided.
The unique identifier of an existing end user. This field is required only if new_end_user_details is not provided.
The unique identifier of the merchant associated with the connect link.
The HEX color code for the link background.
The HEX color code for the text inside the content box.
The HEX color code for the content box background.
The identifier of the default financial institution to pre-select in the link flow.
The primary reference for the connect link. Used to associate the connected account with an entity in an external system.
The secondary reference for the connect link. Used to associate the connected account with an entity in an external system.
The language code to display the link flow in. Defaults to English if left blank.
The URL to redirect to after completing the connection flow. Parameters such as account code (ac), account last 4 (al4), account institution name (ain), account status (as), account UUID (aid), and connect link UUID (clid) will be appended as URL query parameters.
The expiration date and time for the connect link in GMT (ISO 8601 format). If set, users will see an error page if they attempt to open the link after this date.
A set of key-value pairs that can be attached to the object. You can specify up to 50 keys, with key names up to 40 characters and values up to 500 characters.
If true, the user is redirected directly to the redirect_url without displaying the DRUO confirmation page.
Determines which account capabilities are enabled when the link is created.
PAYMENTPAYOUTResponse
The unique identifier of the connect link.
clk_aee571f2-cdf0-4fad-8abb-74fcb8b83f20The secure URL to which the user should be redirected to connect their account.
https://link.druo.com/connect/secure?sl=fd6f7577cThe HEX color code for the text inside the content box.
#333333The HEX color code for the content box background.
#eaeaeaThe key-value pairs mapping languages to their configured intro text.
The details of the end-user customer associated with this connect link.
The pre-selected financial institution for the link.
The primary reference for the connect link. Used to associate the connected account with an entity in an external system.
23423524The secondary reference for the connect link. Used to associate the connected account with an entity in an external system.
bj39fhow39fhqp3f0hfae4344The language code configured to display the link in.
es_COen_USThe URL to redirect the user to once the flow completes successfully.
https://example.comThe GMT expiration timestamp for the connect link.
2021-11-16T23:23:38Indicates whether the redirect occurs automatically without showing the DRUO confirmation page.
falseKey-value pairs containing custom metadata attached to the object.
{"order_id": "6735"}The creation timestamp of the connect link in GMT.
2021-11-15T23:23:38ZThe last update timestamp of the connect link in GMT.
2021-11-15T23:23:38Z
