Set Callback URLs
curl --request POST \
--url https://api.bolt.com/v1/merchant/callbacks \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"callback_urls": [
{
"type": "oauth_redirect",
"url": "https://example.com/1"
},
{
"type": "oauth_logout",
"url": "https://example.com/2"
},
{
"type": "get_account",
"url": "https://example.com/3"
}
],
"division_id": "3X9aPQ67-YrB"
}
'import requests
url = "https://api.bolt.com/v1/merchant/callbacks"
payload = {
"callback_urls": [
{
"type": "oauth_redirect",
"url": "https://example.com/1"
},
{
"type": "oauth_logout",
"url": "https://example.com/2"
},
{
"type": "get_account",
"url": "https://example.com/3"
}
],
"division_id": "3X9aPQ67-YrB"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
callback_urls: [
{type: 'oauth_redirect', url: 'https://example.com/1'},
{type: 'oauth_logout', url: 'https://example.com/2'},
{type: 'get_account', url: 'https://example.com/3'}
],
division_id: '3X9aPQ67-YrB'
})
};
fetch('https://api.bolt.com/v1/merchant/callbacks', 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.bolt.com/v1/merchant/callbacks",
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([
'callback_urls' => [
[
'type' => 'oauth_redirect',
'url' => 'https://example.com/1'
],
[
'type' => 'oauth_logout',
'url' => 'https://example.com/2'
],
[
'type' => 'get_account',
'url' => 'https://example.com/3'
]
],
'division_id' => '3X9aPQ67-YrB'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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.bolt.com/v1/merchant/callbacks"
payload := strings.NewReader("{\n \"callback_urls\": [\n {\n \"type\": \"oauth_redirect\",\n \"url\": \"https://example.com/1\"\n },\n {\n \"type\": \"oauth_logout\",\n \"url\": \"https://example.com/2\"\n },\n {\n \"type\": \"get_account\",\n \"url\": \"https://example.com/3\"\n }\n ],\n \"division_id\": \"3X9aPQ67-YrB\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<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.bolt.com/v1/merchant/callbacks")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"callback_urls\": [\n {\n \"type\": \"oauth_redirect\",\n \"url\": \"https://example.com/1\"\n },\n {\n \"type\": \"oauth_logout\",\n \"url\": \"https://example.com/2\"\n },\n {\n \"type\": \"get_account\",\n \"url\": \"https://example.com/3\"\n }\n ],\n \"division_id\": \"3X9aPQ67-YrB\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bolt.com/v1/merchant/callbacks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"callback_urls\": [\n {\n \"type\": \"oauth_redirect\",\n \"url\": \"https://example.com/1\"\n },\n {\n \"type\": \"oauth_logout\",\n \"url\": \"https://example.com/2\"\n },\n {\n \"type\": \"get_account\",\n \"url\": \"https://example.com/3\"\n }\n ],\n \"division_id\": \"3X9aPQ67-YrB\"\n}"
response = http.request(request)
puts response.read_body{
"errors": [
{
"code": 2001005,
"message": "The input is missing a required parameter."
}
],
"result": {
"success": false
}
}{
"errors": [
{
"code": 2001005,
"message": "The input is missing a required parameter."
}
],
"result": {
"success": false
}
}{
"errors": [
{
"code": 2001005,
"message": "The input is missing a required parameter."
}
],
"result": {
"success": false
}
}Configuration
Set Callback URLs
Configure callbacks URLs for a Bolt merchant division. This will store or override only the callback URLs that are specified in the request. Operations are fully transactional.
POST
/
v1
/
merchant
/
callbacks
Set Callback URLs
curl --request POST \
--url https://api.bolt.com/v1/merchant/callbacks \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"callback_urls": [
{
"type": "oauth_redirect",
"url": "https://example.com/1"
},
{
"type": "oauth_logout",
"url": "https://example.com/2"
},
{
"type": "get_account",
"url": "https://example.com/3"
}
],
"division_id": "3X9aPQ67-YrB"
}
'import requests
url = "https://api.bolt.com/v1/merchant/callbacks"
payload = {
"callback_urls": [
{
"type": "oauth_redirect",
"url": "https://example.com/1"
},
{
"type": "oauth_logout",
"url": "https://example.com/2"
},
{
"type": "get_account",
"url": "https://example.com/3"
}
],
"division_id": "3X9aPQ67-YrB"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
callback_urls: [
{type: 'oauth_redirect', url: 'https://example.com/1'},
{type: 'oauth_logout', url: 'https://example.com/2'},
{type: 'get_account', url: 'https://example.com/3'}
],
division_id: '3X9aPQ67-YrB'
})
};
fetch('https://api.bolt.com/v1/merchant/callbacks', 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.bolt.com/v1/merchant/callbacks",
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([
'callback_urls' => [
[
'type' => 'oauth_redirect',
'url' => 'https://example.com/1'
],
[
'type' => 'oauth_logout',
'url' => 'https://example.com/2'
],
[
'type' => 'get_account',
'url' => 'https://example.com/3'
]
],
'division_id' => '3X9aPQ67-YrB'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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.bolt.com/v1/merchant/callbacks"
payload := strings.NewReader("{\n \"callback_urls\": [\n {\n \"type\": \"oauth_redirect\",\n \"url\": \"https://example.com/1\"\n },\n {\n \"type\": \"oauth_logout\",\n \"url\": \"https://example.com/2\"\n },\n {\n \"type\": \"get_account\",\n \"url\": \"https://example.com/3\"\n }\n ],\n \"division_id\": \"3X9aPQ67-YrB\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<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.bolt.com/v1/merchant/callbacks")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"callback_urls\": [\n {\n \"type\": \"oauth_redirect\",\n \"url\": \"https://example.com/1\"\n },\n {\n \"type\": \"oauth_logout\",\n \"url\": \"https://example.com/2\"\n },\n {\n \"type\": \"get_account\",\n \"url\": \"https://example.com/3\"\n }\n ],\n \"division_id\": \"3X9aPQ67-YrB\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bolt.com/v1/merchant/callbacks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"callback_urls\": [\n {\n \"type\": \"oauth_redirect\",\n \"url\": \"https://example.com/1\"\n },\n {\n \"type\": \"oauth_logout\",\n \"url\": \"https://example.com/2\"\n },\n {\n \"type\": \"get_account\",\n \"url\": \"https://example.com/3\"\n }\n ],\n \"division_id\": \"3X9aPQ67-YrB\"\n}"
response = http.request(request)
puts response.read_body{
"errors": [
{
"code": 2001005,
"message": "The input is missing a required parameter."
}
],
"result": {
"success": false
}
}{
"errors": [
{
"code": 2001005,
"message": "The input is missing a required parameter."
}
],
"result": {
"success": false
}
}{
"errors": [
{
"code": 2001005,
"message": "The input is missing a required parameter."
}
],
"result": {
"success": false
}
}Authorizations
Admins and Developers can obtain their Bolt API key from the Bolt Merchant Dashboard.
Body
application/json
List of callback URLs to configure
Show child attributes
Show child attributes
Example:
[
{
"type": "oauth_redirect",
"url": "https://example.com/1"
},
{
"type": "oauth_logout",
"url": "https://example.com/2"
},
{
"type": "get_account",
"url": "https://example.com/3"
}
]
The unique ID associated to the merchant's Bolt Account division; Merchants can have different divisions to suit multiple use cases (storefronts, pay-by-link, phone order processing). Use the Bolt Merchant Dashboard to switch between divisions and find the division ID under Merchant Division Public ID.
Example:
"3X9aPQ67-YrB"
Response
Successfully sets callback URLs. No JSON schema is expected.
⌘I