curl --request GET \
--url https://rest.staging.nickel.com/nickelBanking/heldDebits \
--header 'Authorization: Bearer <token>'import requests
url = "https://rest.staging.nickel.com/nickelBanking/heldDebits"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://rest.staging.nickel.com/nickelBanking/heldDebits', 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://rest.staging.nickel.com/nickelBanking/heldDebits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://rest.staging.nickel.com/nickelBanking/heldDebits"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://rest.staging.nickel.com/nickelBanking/heldDebits")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.staging.nickel.com/nickelBanking/heldDebits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"heldDebits": [
{
"id": "cmhd1rv0001qz8x4k2v7c9d3e",
"accountId": "cmf1nba0001qz8x4k2v7c9d3e",
"status": "PENDING_DECISION",
"amountCents": 12345,
"companyName": "ACME AUTOPAY",
"companyId": "1234567890",
"entryDescription": "AUTOPAY",
"secCode": "CCD",
"heldAt": "2023-11-07T05:31:56Z",
"decideBy": "2023-11-07T05:31:56Z",
"decidedAt": "2023-11-07T05:31:56Z",
"decidedBy": "<string>",
"allowedCompanyId": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}List held debits
Returns the ACH debits Debit Protection held on your Nickel Banking accounts, newest first, at most 200: each one’s status, who is pulling the money, and decideBy, when an undecided hold is blocked. See Debit Protection.
An empty list means nothing was held. When it would be empty because your organization has no active Nickel Banking account, or the API key can’t see Nickel Banking balances, the response is a 403 that says which.
curl --request GET \
--url https://rest.staging.nickel.com/nickelBanking/heldDebits \
--header 'Authorization: Bearer <token>'import requests
url = "https://rest.staging.nickel.com/nickelBanking/heldDebits"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://rest.staging.nickel.com/nickelBanking/heldDebits', 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://rest.staging.nickel.com/nickelBanking/heldDebits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://rest.staging.nickel.com/nickelBanking/heldDebits"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://rest.staging.nickel.com/nickelBanking/heldDebits")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.staging.nickel.com/nickelBanking/heldDebits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"heldDebits": [
{
"id": "cmhd1rv0001qz8x4k2v7c9d3e",
"accountId": "cmf1nba0001qz8x4k2v7c9d3e",
"status": "PENDING_DECISION",
"amountCents": 12345,
"companyName": "ACME AUTOPAY",
"companyId": "1234567890",
"entryDescription": "AUTOPAY",
"secCode": "CCD",
"heldAt": "2023-11-07T05:31:56Z",
"decideBy": "2023-11-07T05:31:56Z",
"decidedAt": "2023-11-07T05:31:56Z",
"decidedBy": "<string>",
"allowedCompanyId": "<string>"
}
]
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Authorizations
Query Parameters
Only holds in this status. PENDING_DECISION lists the ones waiting for you.
PENDING_DECISION: waiting for you until decideBy. ALLOWED and BLOCKED: someone decided. AUTO_ALLOWED: the company is an allowed company, so it was never held. EXPIRED_BLOCKED: blocked automatically, because nobody decided by decideBy or it arrived with no time to decide. RESOLVED_EXTERNALLY: the bank resolved it before or against the decision.
PENDING_DECISION, ALLOWED, AUTO_ALLOWED, BLOCKED, EXPIRED_BLOCKED, RESOLVED_EXTERNALLY 