Update a card specification before or between authorizations
curl --request PATCH \
--url https://api.onkernel.com/vaults/{id_or_name}/items/{key} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"spec": {
"amount": 250000,
"context": "<string>",
"currency": "<string>",
"merchant_name": "<string>",
"merchant_url": "<string>",
"payment_method_id": "<string>",
"provider": "link",
"test": true,
"wallet": "<string>",
"expires_at": 123,
"line_items": [
{
"name": "<string>",
"description": "<string>",
"image_url": "<string>",
"product_url": "<string>",
"quantity": 2,
"sku": "<string>",
"totals": [
{
"amount": 123,
"display_text": "<string>",
"type": "<string>"
}
],
"unit_amount": 123,
"url": "<string>"
}
],
"metadata": {},
"totals": [
{
"amount": 123,
"display_text": "<string>",
"type": "<string>"
}
]
}
}
'import requests
url = "https://api.onkernel.com/vaults/{id_or_name}/items/{key}"
payload = { "spec": {
"amount": 250000,
"context": "<string>",
"currency": "<string>",
"merchant_name": "<string>",
"merchant_url": "<string>",
"payment_method_id": "<string>",
"provider": "link",
"test": True,
"wallet": "<string>",
"expires_at": 123,
"line_items": [
{
"name": "<string>",
"description": "<string>",
"image_url": "<string>",
"product_url": "<string>",
"quantity": 2,
"sku": "<string>",
"totals": [
{
"amount": 123,
"display_text": "<string>",
"type": "<string>"
}
],
"unit_amount": 123,
"url": "<string>"
}
],
"metadata": {},
"totals": [
{
"amount": 123,
"display_text": "<string>",
"type": "<string>"
}
]
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
spec: {
amount: 250000,
context: '<string>',
currency: '<string>',
merchant_name: '<string>',
merchant_url: '<string>',
payment_method_id: '<string>',
provider: 'link',
test: true,
wallet: '<string>',
expires_at: 123,
line_items: [
{
name: '<string>',
description: '<string>',
image_url: '<string>',
product_url: '<string>',
quantity: 2,
sku: '<string>',
totals: [{amount: 123, display_text: '<string>', type: '<string>'}],
unit_amount: 123,
url: '<string>'
}
],
metadata: {},
totals: [{amount: 123, display_text: '<string>', type: '<string>'}]
}
})
};
fetch('https://api.onkernel.com/vaults/{id_or_name}/items/{key}', 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.onkernel.com/vaults/{id_or_name}/items/{key}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'spec' => [
'amount' => 250000,
'context' => '<string>',
'currency' => '<string>',
'merchant_name' => '<string>',
'merchant_url' => '<string>',
'payment_method_id' => '<string>',
'provider' => 'link',
'test' => true,
'wallet' => '<string>',
'expires_at' => 123,
'line_items' => [
[
'name' => '<string>',
'description' => '<string>',
'image_url' => '<string>',
'product_url' => '<string>',
'quantity' => 2,
'sku' => '<string>',
'totals' => [
[
'amount' => 123,
'display_text' => '<string>',
'type' => '<string>'
]
],
'unit_amount' => 123,
'url' => '<string>'
]
],
'metadata' => [
],
'totals' => [
[
'amount' => 123,
'display_text' => '<string>',
'type' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.onkernel.com/vaults/{id_or_name}/items/{key}"
payload := strings.NewReader("{\n \"spec\": {\n \"amount\": 250000,\n \"context\": \"<string>\",\n \"currency\": \"<string>\",\n \"merchant_name\": \"<string>\",\n \"merchant_url\": \"<string>\",\n \"payment_method_id\": \"<string>\",\n \"provider\": \"link\",\n \"test\": true,\n \"wallet\": \"<string>\",\n \"expires_at\": 123,\n \"line_items\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"product_url\": \"<string>\",\n \"quantity\": 2,\n \"sku\": \"<string>\",\n \"totals\": [\n {\n \"amount\": 123,\n \"display_text\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"unit_amount\": 123,\n \"url\": \"<string>\"\n }\n ],\n \"metadata\": {},\n \"totals\": [\n {\n \"amount\": 123,\n \"display_text\": \"<string>\",\n \"type\": \"<string>\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.onkernel.com/vaults/{id_or_name}/items/{key}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"spec\": {\n \"amount\": 250000,\n \"context\": \"<string>\",\n \"currency\": \"<string>\",\n \"merchant_name\": \"<string>\",\n \"merchant_url\": \"<string>\",\n \"payment_method_id\": \"<string>\",\n \"provider\": \"link\",\n \"test\": true,\n \"wallet\": \"<string>\",\n \"expires_at\": 123,\n \"line_items\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"product_url\": \"<string>\",\n \"quantity\": 2,\n \"sku\": \"<string>\",\n \"totals\": [\n {\n \"amount\": 123,\n \"display_text\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"unit_amount\": 123,\n \"url\": \"<string>\"\n }\n ],\n \"metadata\": {},\n \"totals\": [\n {\n \"amount\": 123,\n \"display_text\": \"<string>\",\n \"type\": \"<string>\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.onkernel.com/vaults/{id_or_name}/items/{key}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"spec\": {\n \"amount\": 250000,\n \"context\": \"<string>\",\n \"currency\": \"<string>\",\n \"merchant_name\": \"<string>\",\n \"merchant_url\": \"<string>\",\n \"payment_method_id\": \"<string>\",\n \"provider\": \"link\",\n \"test\": true,\n \"wallet\": \"<string>\",\n \"expires_at\": 123,\n \"line_items\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"product_url\": \"<string>\",\n \"quantity\": 2,\n \"sku\": \"<string>\",\n \"totals\": [\n {\n \"amount\": 123,\n \"display_text\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"unit_amount\": 123,\n \"url\": \"<string>\"\n }\n ],\n \"metadata\": {},\n \"totals\": [\n {\n \"amount\": 123,\n \"display_text\": \"<string>\",\n \"type\": \"<string>\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"available_expansions": [
{
"description": "<string>",
"type": "payment_methods"
}
],
"available_operations": [
{
"description": "<string>",
"type": "authorize"
}
],
"created_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"key": "<string>",
"spec": {
"authorization": {
"client": {
"type": "kernel_managed"
},
"method": "oauth"
},
"provider": "link"
},
"state": {
"provider": "link",
"status": "pending_authorization",
"status_reason": "<string>"
},
"type": "wallet",
"updated_at": "2023-11-07T05:31:56Z",
"action": {
"name": "link_oauth",
"url": "<string>"
},
"expanded": {
"payment_methods": [
{
"capabilities": {
"single_use_card": {
"eligible": true,
"reasons": [
"<string>"
]
}
},
"display": {
"brand": "<string>",
"label": "<string>",
"last4": "<string>"
},
"id": "<string>",
"is_default": true,
"provider": "<string>",
"type": "<string>"
}
]
},
"expires_at": "2023-11-07T05:31:56Z"
}{
"code": "bad_request",
"message": "Missing required field: app_name",
"details": [
{
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
],
"inner_error": {
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
}{
"code": "bad_request",
"message": "Missing required field: app_name",
"details": [
{
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
],
"inner_error": {
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
}{
"code": "bad_request",
"message": "Missing required field: app_name",
"details": [
{
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
],
"inner_error": {
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
}{
"code": "bad_request",
"message": "Missing required field: app_name",
"details": [
{
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
],
"inner_error": {
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
}{
"code": "bad_request",
"message": "Missing required field: app_name",
"details": [
{
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
],
"inner_error": {
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
}Vaults
Update a card specification before or between authorizations
PATCH
/
vaults
/
{id_or_name}
/
items
/
{key}
Update a card specification before or between authorizations
curl --request PATCH \
--url https://api.onkernel.com/vaults/{id_or_name}/items/{key} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"spec": {
"amount": 250000,
"context": "<string>",
"currency": "<string>",
"merchant_name": "<string>",
"merchant_url": "<string>",
"payment_method_id": "<string>",
"provider": "link",
"test": true,
"wallet": "<string>",
"expires_at": 123,
"line_items": [
{
"name": "<string>",
"description": "<string>",
"image_url": "<string>",
"product_url": "<string>",
"quantity": 2,
"sku": "<string>",
"totals": [
{
"amount": 123,
"display_text": "<string>",
"type": "<string>"
}
],
"unit_amount": 123,
"url": "<string>"
}
],
"metadata": {},
"totals": [
{
"amount": 123,
"display_text": "<string>",
"type": "<string>"
}
]
}
}
'import requests
url = "https://api.onkernel.com/vaults/{id_or_name}/items/{key}"
payload = { "spec": {
"amount": 250000,
"context": "<string>",
"currency": "<string>",
"merchant_name": "<string>",
"merchant_url": "<string>",
"payment_method_id": "<string>",
"provider": "link",
"test": True,
"wallet": "<string>",
"expires_at": 123,
"line_items": [
{
"name": "<string>",
"description": "<string>",
"image_url": "<string>",
"product_url": "<string>",
"quantity": 2,
"sku": "<string>",
"totals": [
{
"amount": 123,
"display_text": "<string>",
"type": "<string>"
}
],
"unit_amount": 123,
"url": "<string>"
}
],
"metadata": {},
"totals": [
{
"amount": 123,
"display_text": "<string>",
"type": "<string>"
}
]
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
spec: {
amount: 250000,
context: '<string>',
currency: '<string>',
merchant_name: '<string>',
merchant_url: '<string>',
payment_method_id: '<string>',
provider: 'link',
test: true,
wallet: '<string>',
expires_at: 123,
line_items: [
{
name: '<string>',
description: '<string>',
image_url: '<string>',
product_url: '<string>',
quantity: 2,
sku: '<string>',
totals: [{amount: 123, display_text: '<string>', type: '<string>'}],
unit_amount: 123,
url: '<string>'
}
],
metadata: {},
totals: [{amount: 123, display_text: '<string>', type: '<string>'}]
}
})
};
fetch('https://api.onkernel.com/vaults/{id_or_name}/items/{key}', 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.onkernel.com/vaults/{id_or_name}/items/{key}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'spec' => [
'amount' => 250000,
'context' => '<string>',
'currency' => '<string>',
'merchant_name' => '<string>',
'merchant_url' => '<string>',
'payment_method_id' => '<string>',
'provider' => 'link',
'test' => true,
'wallet' => '<string>',
'expires_at' => 123,
'line_items' => [
[
'name' => '<string>',
'description' => '<string>',
'image_url' => '<string>',
'product_url' => '<string>',
'quantity' => 2,
'sku' => '<string>',
'totals' => [
[
'amount' => 123,
'display_text' => '<string>',
'type' => '<string>'
]
],
'unit_amount' => 123,
'url' => '<string>'
]
],
'metadata' => [
],
'totals' => [
[
'amount' => 123,
'display_text' => '<string>',
'type' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.onkernel.com/vaults/{id_or_name}/items/{key}"
payload := strings.NewReader("{\n \"spec\": {\n \"amount\": 250000,\n \"context\": \"<string>\",\n \"currency\": \"<string>\",\n \"merchant_name\": \"<string>\",\n \"merchant_url\": \"<string>\",\n \"payment_method_id\": \"<string>\",\n \"provider\": \"link\",\n \"test\": true,\n \"wallet\": \"<string>\",\n \"expires_at\": 123,\n \"line_items\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"product_url\": \"<string>\",\n \"quantity\": 2,\n \"sku\": \"<string>\",\n \"totals\": [\n {\n \"amount\": 123,\n \"display_text\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"unit_amount\": 123,\n \"url\": \"<string>\"\n }\n ],\n \"metadata\": {},\n \"totals\": [\n {\n \"amount\": 123,\n \"display_text\": \"<string>\",\n \"type\": \"<string>\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.onkernel.com/vaults/{id_or_name}/items/{key}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"spec\": {\n \"amount\": 250000,\n \"context\": \"<string>\",\n \"currency\": \"<string>\",\n \"merchant_name\": \"<string>\",\n \"merchant_url\": \"<string>\",\n \"payment_method_id\": \"<string>\",\n \"provider\": \"link\",\n \"test\": true,\n \"wallet\": \"<string>\",\n \"expires_at\": 123,\n \"line_items\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"product_url\": \"<string>\",\n \"quantity\": 2,\n \"sku\": \"<string>\",\n \"totals\": [\n {\n \"amount\": 123,\n \"display_text\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"unit_amount\": 123,\n \"url\": \"<string>\"\n }\n ],\n \"metadata\": {},\n \"totals\": [\n {\n \"amount\": 123,\n \"display_text\": \"<string>\",\n \"type\": \"<string>\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.onkernel.com/vaults/{id_or_name}/items/{key}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"spec\": {\n \"amount\": 250000,\n \"context\": \"<string>\",\n \"currency\": \"<string>\",\n \"merchant_name\": \"<string>\",\n \"merchant_url\": \"<string>\",\n \"payment_method_id\": \"<string>\",\n \"provider\": \"link\",\n \"test\": true,\n \"wallet\": \"<string>\",\n \"expires_at\": 123,\n \"line_items\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"product_url\": \"<string>\",\n \"quantity\": 2,\n \"sku\": \"<string>\",\n \"totals\": [\n {\n \"amount\": 123,\n \"display_text\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"unit_amount\": 123,\n \"url\": \"<string>\"\n }\n ],\n \"metadata\": {},\n \"totals\": [\n {\n \"amount\": 123,\n \"display_text\": \"<string>\",\n \"type\": \"<string>\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"available_expansions": [
{
"description": "<string>",
"type": "payment_methods"
}
],
"available_operations": [
{
"description": "<string>",
"type": "authorize"
}
],
"created_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"key": "<string>",
"spec": {
"authorization": {
"client": {
"type": "kernel_managed"
},
"method": "oauth"
},
"provider": "link"
},
"state": {
"provider": "link",
"status": "pending_authorization",
"status_reason": "<string>"
},
"type": "wallet",
"updated_at": "2023-11-07T05:31:56Z",
"action": {
"name": "link_oauth",
"url": "<string>"
},
"expanded": {
"payment_methods": [
{
"capabilities": {
"single_use_card": {
"eligible": true,
"reasons": [
"<string>"
]
}
},
"display": {
"brand": "<string>",
"label": "<string>",
"last4": "<string>"
},
"id": "<string>",
"is_default": true,
"provider": "<string>",
"type": "<string>"
}
]
},
"expires_at": "2023-11-07T05:31:56Z"
}{
"code": "bad_request",
"message": "Missing required field: app_name",
"details": [
{
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
],
"inner_error": {
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
}{
"code": "bad_request",
"message": "Missing required field: app_name",
"details": [
{
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
],
"inner_error": {
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
}{
"code": "bad_request",
"message": "Missing required field: app_name",
"details": [
{
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
],
"inner_error": {
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
}{
"code": "bad_request",
"message": "Missing required field: app_name",
"details": [
{
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
],
"inner_error": {
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
}{
"code": "bad_request",
"message": "Missing required field: app_name",
"details": [
{
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
],
"inner_error": {
"code": "invalid_input",
"message": "Provided version string is not semver compliant"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
- Option 1
- Option 2
Show child attributes
Show child attributes
Response
Vault item updated
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Immutable item key assigned when the item is created.
- Option 1
- Option 2
Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
Available options:
wallet - Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
Show child attributes
Show child attributes
Live, non-persisted data requested through the item GET expand parameter.
Show child attributes
Show child attributes