Checkouts
Create a checkout session
Initializes a new Blink checkout session and provides the checkout URL.
-
Request Headers:
x-store-id(string, required): The ID of the store creating the checkout.
-
Request Body:
product_id(string, required): Identifier of the product to checkout.variant_id(string, optional): Variant identifier if applicable.customer_email(string, optional): Customer’s email address.- … (other checkout configurations)
-
Response: A Blink checkout session object including the checkout URL.
Facilitates smooth customer transactions with Blink for easy payment processing.
POST
/
checkouts
Create a checkout session
curl --request POST \
--url https://api.blink.store/v1/checkouts \
--header 'Content-Type: application/json' \
--header 'x-store-id: <api-key>' \
--data '
{
"product_id": "<string>",
"variant_id": "<string>",
"customer_email": "<string>",
"discount_code": "<string>",
"affiliate_code": "<string>",
"splits": {},
"success_url": "<string>",
"cancel_url": "<string>",
"metadata": {},
"options": {
"hide_carousel": true,
"hide_title": true,
"hide_discount": true,
"hide_refund": true,
"hide_support": true,
"show_desc": true,
"button_text": "<string>",
"locale": "<string>",
"product_name": "<string>",
"custom_fields": [
{}
]
},
"appearance": {
"variables": {
"colorPrimary": "<string>"
}
}
}
'import requests
url = "https://api.blink.store/v1/checkouts"
payload = {
"product_id": "<string>",
"variant_id": "<string>",
"customer_email": "<string>",
"discount_code": "<string>",
"affiliate_code": "<string>",
"splits": {},
"success_url": "<string>",
"cancel_url": "<string>",
"metadata": {},
"options": {
"hide_carousel": True,
"hide_title": True,
"hide_discount": True,
"hide_refund": True,
"hide_support": True,
"show_desc": True,
"button_text": "<string>",
"locale": "<string>",
"product_name": "<string>",
"custom_fields": [{}]
},
"appearance": { "variables": { "colorPrimary": "<string>" } }
}
headers = {
"x-store-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-store-id': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
product_id: '<string>',
variant_id: '<string>',
customer_email: '<string>',
discount_code: '<string>',
affiliate_code: '<string>',
splits: {},
success_url: '<string>',
cancel_url: '<string>',
metadata: {},
options: {
hide_carousel: true,
hide_title: true,
hide_discount: true,
hide_refund: true,
hide_support: true,
show_desc: true,
button_text: '<string>',
locale: '<string>',
product_name: '<string>',
custom_fields: [{}]
},
appearance: {variables: {colorPrimary: '<string>'}}
})
};
fetch('https://api.blink.store/v1/checkouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.blink.store/v1/checkouts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'product_id' => '<string>',
'variant_id' => '<string>',
'customer_email' => '<string>',
'discount_code' => '<string>',
'affiliate_code' => '<string>',
'splits' => [
],
'success_url' => '<string>',
'cancel_url' => '<string>',
'metadata' => [
],
'options' => [
'hide_carousel' => true,
'hide_title' => true,
'hide_discount' => true,
'hide_refund' => true,
'hide_support' => true,
'show_desc' => true,
'button_text' => '<string>',
'locale' => '<string>',
'product_name' => '<string>',
'custom_fields' => [
[
]
]
],
'appearance' => [
'variables' => [
'colorPrimary' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-store-id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.blink.store/v1/checkouts"
payload := strings.NewReader("{\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"customer_email\": \"<string>\",\n \"discount_code\": \"<string>\",\n \"affiliate_code\": \"<string>\",\n \"splits\": {},\n \"success_url\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"metadata\": {},\n \"options\": {\n \"hide_carousel\": true,\n \"hide_title\": true,\n \"hide_discount\": true,\n \"hide_refund\": true,\n \"hide_support\": true,\n \"show_desc\": true,\n \"button_text\": \"<string>\",\n \"locale\": \"<string>\",\n \"product_name\": \"<string>\",\n \"custom_fields\": [\n {}\n ]\n },\n \"appearance\": {\n \"variables\": {\n \"colorPrimary\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-store-id", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.blink.store/v1/checkouts")
.header("x-store-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"customer_email\": \"<string>\",\n \"discount_code\": \"<string>\",\n \"affiliate_code\": \"<string>\",\n \"splits\": {},\n \"success_url\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"metadata\": {},\n \"options\": {\n \"hide_carousel\": true,\n \"hide_title\": true,\n \"hide_discount\": true,\n \"hide_refund\": true,\n \"hide_support\": true,\n \"show_desc\": true,\n \"button_text\": \"<string>\",\n \"locale\": \"<string>\",\n \"product_name\": \"<string>\",\n \"custom_fields\": [\n {}\n ]\n },\n \"appearance\": {\n \"variables\": {\n \"colorPrimary\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.blink.store/v1/checkouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-store-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"customer_email\": \"<string>\",\n \"discount_code\": \"<string>\",\n \"affiliate_code\": \"<string>\",\n \"splits\": {},\n \"success_url\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"metadata\": {},\n \"options\": {\n \"hide_carousel\": true,\n \"hide_title\": true,\n \"hide_discount\": true,\n \"hide_refund\": true,\n \"hide_support\": true,\n \"show_desc\": true,\n \"button_text\": \"<string>\",\n \"locale\": \"<string>\",\n \"product_name\": \"<string>\",\n \"custom_fields\": [\n {}\n ]\n },\n \"appearance\": {\n \"variables\": {\n \"colorPrimary\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"url": "<string>",
"status": "<string>",
"payment_status": "<string>",
"customer_email": "<string>",
"amount_total": 123,
"currency": "<string>",
"product_id": "<string>",
"variant_id": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}Authorizations
Body
application/json
Customization options for the checkout layout and behavior.
Show child attributes
Show child attributes
Appearance overrides for custom checkouts.
Show child attributes
Show child attributes
Previous
Retrieve a checkout sessionFetches information of a checkout session by its ID, including payment status.
- **Request Headers:**
- `x-store-id` (string, required): The store ID owning the checkout session.
- **Path Parameters:**
- `id` (string, required): Identifier of the checkout session.
- **Response:** Details about the checkout session such as status, amount, and customer information.
Useful for verifying the result of a customer's purchase and providing relevant order tracking details.
Next
⌘I
Create a checkout session
curl --request POST \
--url https://api.blink.store/v1/checkouts \
--header 'Content-Type: application/json' \
--header 'x-store-id: <api-key>' \
--data '
{
"product_id": "<string>",
"variant_id": "<string>",
"customer_email": "<string>",
"discount_code": "<string>",
"affiliate_code": "<string>",
"splits": {},
"success_url": "<string>",
"cancel_url": "<string>",
"metadata": {},
"options": {
"hide_carousel": true,
"hide_title": true,
"hide_discount": true,
"hide_refund": true,
"hide_support": true,
"show_desc": true,
"button_text": "<string>",
"locale": "<string>",
"product_name": "<string>",
"custom_fields": [
{}
]
},
"appearance": {
"variables": {
"colorPrimary": "<string>"
}
}
}
'import requests
url = "https://api.blink.store/v1/checkouts"
payload = {
"product_id": "<string>",
"variant_id": "<string>",
"customer_email": "<string>",
"discount_code": "<string>",
"affiliate_code": "<string>",
"splits": {},
"success_url": "<string>",
"cancel_url": "<string>",
"metadata": {},
"options": {
"hide_carousel": True,
"hide_title": True,
"hide_discount": True,
"hide_refund": True,
"hide_support": True,
"show_desc": True,
"button_text": "<string>",
"locale": "<string>",
"product_name": "<string>",
"custom_fields": [{}]
},
"appearance": { "variables": { "colorPrimary": "<string>" } }
}
headers = {
"x-store-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-store-id': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
product_id: '<string>',
variant_id: '<string>',
customer_email: '<string>',
discount_code: '<string>',
affiliate_code: '<string>',
splits: {},
success_url: '<string>',
cancel_url: '<string>',
metadata: {},
options: {
hide_carousel: true,
hide_title: true,
hide_discount: true,
hide_refund: true,
hide_support: true,
show_desc: true,
button_text: '<string>',
locale: '<string>',
product_name: '<string>',
custom_fields: [{}]
},
appearance: {variables: {colorPrimary: '<string>'}}
})
};
fetch('https://api.blink.store/v1/checkouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.blink.store/v1/checkouts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'product_id' => '<string>',
'variant_id' => '<string>',
'customer_email' => '<string>',
'discount_code' => '<string>',
'affiliate_code' => '<string>',
'splits' => [
],
'success_url' => '<string>',
'cancel_url' => '<string>',
'metadata' => [
],
'options' => [
'hide_carousel' => true,
'hide_title' => true,
'hide_discount' => true,
'hide_refund' => true,
'hide_support' => true,
'show_desc' => true,
'button_text' => '<string>',
'locale' => '<string>',
'product_name' => '<string>',
'custom_fields' => [
[
]
]
],
'appearance' => [
'variables' => [
'colorPrimary' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-store-id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.blink.store/v1/checkouts"
payload := strings.NewReader("{\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"customer_email\": \"<string>\",\n \"discount_code\": \"<string>\",\n \"affiliate_code\": \"<string>\",\n \"splits\": {},\n \"success_url\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"metadata\": {},\n \"options\": {\n \"hide_carousel\": true,\n \"hide_title\": true,\n \"hide_discount\": true,\n \"hide_refund\": true,\n \"hide_support\": true,\n \"show_desc\": true,\n \"button_text\": \"<string>\",\n \"locale\": \"<string>\",\n \"product_name\": \"<string>\",\n \"custom_fields\": [\n {}\n ]\n },\n \"appearance\": {\n \"variables\": {\n \"colorPrimary\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-store-id", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.blink.store/v1/checkouts")
.header("x-store-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"customer_email\": \"<string>\",\n \"discount_code\": \"<string>\",\n \"affiliate_code\": \"<string>\",\n \"splits\": {},\n \"success_url\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"metadata\": {},\n \"options\": {\n \"hide_carousel\": true,\n \"hide_title\": true,\n \"hide_discount\": true,\n \"hide_refund\": true,\n \"hide_support\": true,\n \"show_desc\": true,\n \"button_text\": \"<string>\",\n \"locale\": \"<string>\",\n \"product_name\": \"<string>\",\n \"custom_fields\": [\n {}\n ]\n },\n \"appearance\": {\n \"variables\": {\n \"colorPrimary\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.blink.store/v1/checkouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-store-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"customer_email\": \"<string>\",\n \"discount_code\": \"<string>\",\n \"affiliate_code\": \"<string>\",\n \"splits\": {},\n \"success_url\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"metadata\": {},\n \"options\": {\n \"hide_carousel\": true,\n \"hide_title\": true,\n \"hide_discount\": true,\n \"hide_refund\": true,\n \"hide_support\": true,\n \"show_desc\": true,\n \"button_text\": \"<string>\",\n \"locale\": \"<string>\",\n \"product_name\": \"<string>\",\n \"custom_fields\": [\n {}\n ]\n },\n \"appearance\": {\n \"variables\": {\n \"colorPrimary\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"url": "<string>",
"status": "<string>",
"payment_status": "<string>",
"customer_email": "<string>",
"amount_total": 123,
"currency": "<string>",
"product_id": "<string>",
"variant_id": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}