Create Checkout Link
POST /checkout/link/create
Creates a checkout link
The endpoint creates a Checkout Link object
Request Body
existing_end_user_id
string
REQUIRED
Customer Id. If no end user is sent, you need to create a new one.
Example Value: eur_422f0f81-5001-4cce-a229-242d9ab9960a
new_end_user_details
EndUser
link_name
string
REQUIRED
The name for this Checkout link.
Example value: Default checkout
transaction
Payment
REQUIRED
Payment Information.
See more here.
link_description
string
The description for this Checkout link.
Example value: Checkout for Order #3553432
background_color
string
The HEX code for the link’s background color.
Example value: #333333
sidebar_background_color
string
The HEX code for the link’s transaction details background color. If empty, will default to #f2f2f2.
Example value: #f2f2f2
sidebar_text_color
string
The HEX code for the link’s transaction details text color. If empty, will default to #333333.
Example value: #222222
main_content_box_
background_color
string
The HEX code for the link’s verification flow background color. If empty, will default to #ffffff.
Example value: #ffffff
main_content_box_
text_color
string
The HEX code for the link’s verification flow text color. If empty, will default to #333333.
Example value: #333333
button_color
string
The HEX code for the link’s button color.
Example value: #ffffff
button_text_color
string
The HEX code for the link’s button text color.
Example value: #000000
default_institution
string
Default institution used for the checkout link.
Example value: ins_e42460a8-c783-4bc3-8dcd-2e6fcab78b77
primary_reference
string
The checkout link’s primary reference. Can be any value to associate the connected account to an entity in an external system.
Example value: 23423524
secondary_reference
string
The checkout link’s primary reference. Can be any value to associate the connected account to an entity in an external system.
Example value: bj39fhow39fhqp3f0hfae4344
default_language
string
The language code to display this link in. If left blank, system will default to English.
Example value: es-co
redirect_url
string
The URL to redirect to after the connection flow is completed.
Example value: https://example.com
expiration_date
string
The expiration date for this checkout Link in GMT time. If set, the user will be presented with an error upon open opening the link.
Example value: 2021-11-16T23:23:38
custom_confirmation_page
boolean
If true, the user will be taken directly to the redirect URL without showing the DRUO redirect page.
Example value: FALSE
POST /checkout/link/create
curl --location 'https://api.druo.com/checkout/link/create' \
--header 'DRUO-version: 2021-11-22' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ACCESS_TOKEN \
--data-raw '{
"existing_end_user_id": "eur_868d99a5-6578-40cf-8aec-e7a48085fa37",
"link_name": "Checkout Link #1234556",
"transaction": {
"tenant_id": "22637d15-5b37-4fb2-90e5-aa8751970469",
"amount":20000,
"description": "Insurance policy renewal - INV12324",
"statement_descriptor": "NOVO BILLING* INV12324",
"auto_send_receipt": false
}
}'
Response Fields
uuid
string
The Connect Link’s UUID.
Example value: clk_422f0f81-5001-4cce-a229-242d9ab9960a
code
string
The checkout Link’s code.
Example value: CSFM03FNA3
url
string
The URL that the user should be sent to to connect their account.
Example value: https://link.druo.com/checkout/?sl=e4243523423423423423
delivary_status
string
Link delivery status
Example value: OPENNED
link_name
string
The name for this Checkout link.
Example value: Default checkout
link_description
string
The description for this Checkout link.
Example value: Checkout for Order #3553432
background_color
string
The HEX code for the link’s background color.
Example value: #333333
sidebar_background_color
string
The HEX code for the link’s transaction details background color. If empty, will default to #f2f2f2.
Example value: #f2f2f2
sidebar_text_color
string
The HEX code for the link’s transaction details text color. If empty, will default to #333333.
Example value: #222222
main_content_box_
background_color
string
The HEX code for the link’s verification flow background color. If empty, will default to #ffffff.
Example value: #ffffff
main_content_box_text_color
string
The HEX code for the link’s verification flow text color. If empty, will default to #333333.
Example value: #333333
button_color
string
The HEX code for the link’s button color.
Example value: #ffffff
button_text_color
string
The HEX code for the link’s button text color.
Example value: #000000
end_user
EndUser
Customer Information.
See more here.
transaction
Payment
Payment Information.
See more here.
default_institution
string
The connect link’s default institution.
primary_reference
string
The connect link’s primary reference. Can be any value to associate the connected account to an entity in an external system.
Example value: 23423524
secondary_reference
string
The connect link’s primary reference. Can be any value to associate the connected account to an entity in an external system.
Example value: bj39fhow39fhqp3f0hfae4344
default_language
string
The language code to display this link in. If left blank, system will default to English.
Possible values: es_CO, en_US
redirect_url
string
The URL to redirect to after the connection flow is completed. Reference, Status, and Connected Account Code will be appended as URL parameters. For example, if the provided redirect URL is http://www.example.com/order-complete, a successful transaction redirects the customer to: http://www.example.com/order-complete?code=CM9D3DOH39H&…
Example value: https://example.com
expiration_date
string
The expiration date for this Connect Link in GMT time. If set, the user will be presented with an error upon open opening the link.
Example value: 2021-11-16T23:23:38
expired
string
If true, the link is expired.
Example value: FALSE
custom_confirmation_page
boolean
If true, the user will be taken directly to the redirect URL without showing the DRUO redirect page.
Example value: FALSE
Response
{
"checkout_link": {
"uuid": "chk_3889cafb-047b-4844-b46b-b34bcee85d76",
"code": "CHXL3HTJYRRW",
"url": "https://link.druo.com/checkout/?sl=fdc1627e-4e2e-4fbe-9f17-d3127f35053f-6f66d6a7-e148-4b8e-85e9-2e2d4f5eb0ad",
"delivery_status": "CREATED",
"link_name": "Checkout Link #1234556",
"link_description": "",
"background_color": null,
"sidebar_background_color": null,
"sidebar_text_color": null,
"main_content_box_background_color": null,
"main_content_box_text_color": null,
"button_color": null,
"button_text_color": null,
"end_user": {
"uuid": "eur_868d99a5-6578-40cf-8aec-e7a48085fa37",
"code": "EUJXRKMEPER",
"type": "INDIVIDUAL",
"first_name": "John",
"last_name": "Doe",
"organization": null,
"local_id": "987654321",
"local_id_type": "DRIVERS_LICENSE",
"local_id_country": "USA",
"date_of_birth": null,
"email": "john.doe@example.com",
"phone_number": null,
"address": null,
"preferred_language": "en_US",
"note": null,
"primary_reference": null,
"secondary_reference": null,
"metadata": {},
"date_created_gmt": "2023-09-29T02:48:41.388Z",
"date_updated_gmt": "2023-10-09T15:32:34.623Z"
},
"transaction": {
"uuid": "trx_14273743-7da1-4468-b75b-0164d4bfcd27",
"code": "TYL9A2936VV",
"status": "PENDING",
"tenant": {
"uuid": "22637d15-5b37-4fb2-90e5-aa8751970469"
},
"type": "PAYMENT",
"creation_source": "CHECKOUT_LINK",
"amount": 20000,
"variable_fee": null,
"fixed_fee": null,
"total_fee": null,
"net_amount": null,
"currency": {
"code": "COP"
},
"description": "Insurance policy renewal - INV12324",
"remarks": null,
"funding_source": null,
"statement_descriptor": "NOVO BILLING* INV12324",
"primary_reference": null,
"secondary_reference": null,
"metadata": {},
"decline_reason": null,
"auto_send_receipt": "false",
"date_created_gmt": "2023-10-09T15:32:34.623Z",
"date_updated_gmt": "2023-10-09T15:32:34.623Z",
"additional_recipients": null
},
"default_institution": null,
"primary_reference": null,
"secondary_reference": null,
"default_language": {
"code": "en_US"
},
"redirect_url": null,
"expiration_date": "2023-10-09T15:52:33.469Z",
"expired": "false",
"custom_confirmation_page": "false"
}
}