Drop-in checkout links
The Drop-in Checkout Links allow businesses to create simple, shareable URLs that lead customers directly to a checkout page. This resource is ideal for those seeking a streamlined, efficient way to facilitate transactions without needing a full-fledged eCommerce site. By using Checkout Links, businesses can improve the customer experience, increase conversion rates, and simplify the payment process, all while maintaining secure and reliable transactions.
Get all checkout links.
A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.
A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.
A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.
Only return objects with these IDs.
200 OK
400 Bad Request
401 Unauthorized
403 Forbidden
405 Method Not Allowed
406 Not Acceptable
408 Request Timeout
429 Too Many Requests
500 Internal Server Error
502 Bad Gateway Error
503 Service Unavailable Error
504 Gateway Timeout Error
GET /drop-in/checkout-links HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"hasMore": true,
"data": [
{
"id": "894d4fed-1097-4d1e-991a-814069000cb1",
"link": "https://store.digitalriver.com/dropin-checkout/v1/modal?linkId=894d4fed-1097-4d1e-991a-814069000cb1&token=pk_45971nf84m0he7792nmgmhi83mhu49sh",
"createdTime": "2018-04-25T20:36:00Z",
"expired": false,
"expiresTime": "2020-04-25T20:36:00Z",
"checkoutSession": {
"upstreamId": "7765374748",
"currency": "USD",
"taxInclusive": true,
"items": [
{
"skuId": "sku_5823594809",
"productDetails": {
"id": "100067660336",
"skuGroupId": "wireless-keyboards",
"name": "Keyboard",
"description": "Top rated keyboard",
"categories": "Sports & Outdoors > Exercise & Fitness > Wearable Technology > Fitness Trackers",
"url": "https://producturl.com",
"countryOfOrigin": "US",
"image": "https://imageurl.com",
"weight": 20.5,
"weightUnit": "oz",
"partNumber": "SWG1224J10L",
"partnerAccountId": "00g6atnynbl2wFsFG357"
},
"logisticsOptions": {
"deliveryOptions": [
"[\"direct_delivery_only\",\"additional_handling\"]"
],
"dangerousGoods": [
"nimh_battery"
]
},
"subscriptionInfo": {
"freeTrial": true,
"autoRenewal": true,
"terms": "Please accept these terms.",
"planId": "654321",
"plan": {
"interval": "month",
"intervalCount": 1
},
"subscriptionId": "665430999",
"billingAgreementId": "cfeba2ac-d532-49e4-99f4-7a433507facf",
"startTime": "2020-05-21T00:00:00Z",
"endTime": "2021-05-20T11:59:59Z"
},
"price": 9.99,
"aggregatePrice": 9.99,
"strikeThroughPrice": 9.99,
"quantity": 2,
"discount": {
"amountOff": 5.95,
"percentOff": 100,
"quantity": 1
},
"shipFrom": {
"address": {
"line1": "10380 Bren Rd W",
"line2": "text",
"city": "Minnetonka",
"postalCode": "55129",
"state": "MN",
"country": "US"
},
"additionalAddressInfo": {
"neighborhood": "Centro",
"division": "営業部",
"phoneticName": "ヤマダ タロ"
}
},
"metadata": {
"coupon": "iOS"
}
}
],
"shipFrom": {
"address": {
"line1": "10380 Bren Rd W",
"line2": "text",
"city": "Minnetonka",
"postalCode": "55129",
"state": "MN",
"country": "US"
},
"additionalAddressInfo": {
"neighborhood": "Centro",
"division": "営業部",
"phoneticName": "ヤマダ タロ"
}
},
"discount": {
"amountOff": 5.95,
"percentOff": 100
},
"shippingDiscount": {
"amountOff": 5.95,
"percentOff": 100
},
"browserIp": "111.111.111.111",
"applicationId": "68f72e0c-cb7d-48e1-93c8-998668ad0ff4",
"locale": "en_IE",
"language": "en",
"customerType": "individual",
"chargeType": "merchant_initiated",
"disclosures": [
{
"type": "termsOfSale",
"entityName": "Digital River Inc.",
"entityId": "DR_INC-ENTITY",
"localizedText": "Terms of Sale",
"url": "https://store.digitalriver.com/store/defaults/en_US/DisplayDRTermsAndConditionsPage/eCommerceProvider.Digital%20River%20Inc."
}
],
"style": {
"modal": {
"borderRadius": "8px",
"fontFamily": "Montserrat, sans-serif",
"fontVariant": "normal",
"letterSpacing": "1px",
"logo": "https://drh.img.digitalriver.com/DRHM/Storefront/Site/drdod15/cm/images/DR-Demo-Store_New.png",
"themeColor": {
"headerBackground": "#fff",
"highlight": "#002f57",
"mainBackground": "#fff",
"primary": "#00a7e1",
"stepperBorder": "#00a7e1"
}
},
"textField": {
"base": {
"color": "#000",
"fontFamily": "Arial, Helvetica, sans-serif",
"fontSize": "20px",
"fontVariant": "normal",
"letterSpacing": "1px"
}
}
},
"options": {
"addresses": [
{
"address": {
"line1": "10380 Bren Rd W",
"line2": "text",
"city": "Minnetonka",
"postalCode": "55129",
"state": "MN",
"country": "US"
},
"name": "John Smith",
"phone": "952-111-1111",
"email": "[email protected]",
"organization": "Digital River",
"additionalAddressInfo": {
"neighborhood": "Centro",
"division": "営業部",
"phoneticName": "ヤマダ タロ"
}
}
],
"shippingMethods": [
{
"amount": 5.95,
"description": "USPS: Priority (1 day delivery)",
"serviceLevel": "Standard Ground",
"deliveryInformation": {
"businessDaysInTransit": "3 - 5 Business Days",
"estimatedArrival": {
"date": "2018-04-25T20:36:00Z",
"dayOfWeek": "Tuesday"
},
"pickupDate": "2018-04-25T20:36:00Z",
"weekendService": {
"saturdayDelivery": true,
"sundayDelivery": false
},
"supportCutoffTime": "180000"
}
}
],
"storeCredits": [
{
"amount": 5,
"name": "Gift card",
"upstreamId": "7654-2345-0987-123456",
"iconUrl": "https://test.com/logo.png",
"lastFour": "7831"
}
]
},
"redirects": {
"successUrl": "https://digitalriver.com/success",
"cancelUrl": "https://digitalriver.com/cancel"
},
"metadata": {
"coupon": "iOS"
}
}
}
]
}Creates a new Drop-in checkout link
The session identifier.
eyJjdHkiOiJKV1QiLCJlbmMiOiJBMTI4R0NNIiw201 Created
400 Bad Request
401 Unauthorized
403 Forbidden
405 Method Not Allowed
406 Not Acceptable
408 Request Timeout
409 Conflict
429 Too Many Requests
500 Internal Server Error
502 Bad Gateway Error
503 Service Unavailable Error
504 Gateway Timeout Error
POST /drop-in/checkout-links HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55
{
"sessionId": "eyJjdHkiOiJKV1QiLCJlbmMiOiJBMTI4R0NNIiw"
}{
"id": "894d4fed-1097-4d1e-991a-814069000cb1",
"sessionId": "eyJjdHkiOiJKV1QiLCJlbmMiOiJBMTI4R0NNIiw",
"link": "https://store.digitalriver.com/dropin-checkout/v1/modal?linkId=894d4fed-1097-4d1e-991a-814069000cb1&token=pk_45971nf84m0he7792nmgmhi83mhu49sh"
}Deletes the checkout link so it cannot be used after this operation.
Link ID
204 No Content
400 Bad Request
401 Unauthorized
403 Forbidden
401 Not Found
405 Method Not Allowed
406 Not Acceptable
408 Request Timeout
409 Conflict
429 Too Many Requests
500 Internal Server Error
502 Bad Gateway Error
503 Service Unavailable Error
504 Gateway Timeout Error
DELETE /drop-in/checkout-links/{id} HTTP/1.1
Host: api.digitalriver.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Last updated