Update Deposit Customer
curl --request PATCH \
--url https://api.hel.io/v1/deposit-customers/{depositCustomerToken}/api-key \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipientPublicKeys": [
"<string>"
],
"disabled": true,
"additionalJSON": "<string>"
}
'import requests
url = "https://api.hel.io/v1/deposit-customers/{depositCustomerToken}/api-key"
payload = {
"recipientPublicKeys": ["<string>"],
"disabled": True,
"additionalJSON": "<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({recipientPublicKeys: ['<string>'], disabled: true, additionalJSON: '<string>'})
};
fetch('https://api.hel.io/v1/deposit-customers/{depositCustomerToken}/api-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.hel.io/v1/deposit-customers/{depositCustomerToken}/api-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([
'recipientPublicKeys' => [
'<string>'
],
'disabled' => true,
'additionalJSON' => '<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.hel.io/v1/deposit-customers/{depositCustomerToken}/api-key"
payload := strings.NewReader("{\n \"recipientPublicKeys\": [\n \"<string>\"\n ],\n \"disabled\": true,\n \"additionalJSON\": \"<string>\"\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.hel.io/v1/deposit-customers/{depositCustomerToken}/api-key")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"recipientPublicKeys\": [\n \"<string>\"\n ],\n \"disabled\": true,\n \"additionalJSON\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hel.io/v1/deposit-customers/{depositCustomerToken}/api-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 \"recipientPublicKeys\": [\n \"<string>\"\n ],\n \"disabled\": true,\n \"additionalJSON\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "68f8c78f600865f76e7cc866",
"deposit": "68f25d8ebe91855f9fad444b",
"token": "ba065c1b-9134-4a68-9bfc-104e5c1c7631",
"customerId": "customerId",
"recipientPublicKeys": [
"7YancRyN3yp9s6G7YNwx9H93UqswoKFqF9GuNJPufyvW"
]
}{
"message": "Api key or token is invalid",
"code": 401
}Customers
Update Deposit Customer
Updates a customer associated with a specific deposit using the depositCustomerToken.
PATCH
/
v1
/
deposit-customers
/
{depositCustomerToken}
/
api-key
Update Deposit Customer
curl --request PATCH \
--url https://api.hel.io/v1/deposit-customers/{depositCustomerToken}/api-key \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipientPublicKeys": [
"<string>"
],
"disabled": true,
"additionalJSON": "<string>"
}
'import requests
url = "https://api.hel.io/v1/deposit-customers/{depositCustomerToken}/api-key"
payload = {
"recipientPublicKeys": ["<string>"],
"disabled": True,
"additionalJSON": "<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({recipientPublicKeys: ['<string>'], disabled: true, additionalJSON: '<string>'})
};
fetch('https://api.hel.io/v1/deposit-customers/{depositCustomerToken}/api-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.hel.io/v1/deposit-customers/{depositCustomerToken}/api-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([
'recipientPublicKeys' => [
'<string>'
],
'disabled' => true,
'additionalJSON' => '<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.hel.io/v1/deposit-customers/{depositCustomerToken}/api-key"
payload := strings.NewReader("{\n \"recipientPublicKeys\": [\n \"<string>\"\n ],\n \"disabled\": true,\n \"additionalJSON\": \"<string>\"\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.hel.io/v1/deposit-customers/{depositCustomerToken}/api-key")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"recipientPublicKeys\": [\n \"<string>\"\n ],\n \"disabled\": true,\n \"additionalJSON\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hel.io/v1/deposit-customers/{depositCustomerToken}/api-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 \"recipientPublicKeys\": [\n \"<string>\"\n ],\n \"disabled\": true,\n \"additionalJSON\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "68f8c78f600865f76e7cc866",
"deposit": "68f25d8ebe91855f9fad444b",
"token": "ba065c1b-9134-4a68-9bfc-104e5c1c7631",
"customerId": "customerId",
"recipientPublicKeys": [
"7YancRyN3yp9s6G7YNwx9H93UqswoKFqF9GuNJPufyvW"
]
}{
"message": "Api key or token is invalid",
"code": 401
}Authorizations
Authentication using JWT token
Path Parameters
The token associated with the deposit customer to retrieve.
Query Parameters
Your API key can be generated on the Helio Dashboard’s settings page.
Body
application/json
