List check deposits
curl --request GET \
--url https://rest.staging.nickel.com/nickelBanking/checkDeposits \
--header 'Authorization: Bearer <token>'import requests
url = "https://rest.staging.nickel.com/nickelBanking/checkDeposits"
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/checkDeposits', 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/checkDeposits",
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/checkDeposits"
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/checkDeposits")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.staging.nickel.com/nickelBanking/checkDeposits")
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{
"checkDeposits": [
{
"id": "cmf2dep0001qz8x4k2v7c9d3e",
"transferId": "cmf2nbt0001qz8x4k2v7c9d3e",
"accountId": "<string>",
"amountCents": 155055,
"status": "PROCESSING",
"payerName": "Acme Corp",
"description": "Q3 retainer",
"returnReason": "<string>",
"rejectionReason": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"depositedAt": "2023-11-07T05:31:56Z",
"unappliedAmountCents": 55055,
"applications": [
{
"id": "cmr9zx1bq000gsf02h1d5w4t8",
"amountCents": 100000,
"paymentLinkId": "cmq7ab3cd000gsf02e5f6g7h8",
"voided": true,
"voidReason": "DEPOSIT_RETURNED"
}
]
}
],
"hasMore": true
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Nickel Banking
List check deposits
Returns the checks deposited into your Nickel Banking accounts, newest first, each with the payment links it has paid and the money it has left to apply. Pass unappliedOnly=true to find a deposit that still has money to apply to an invoice.
When the list would be empty because your organization has no active Nickel Banking account, or because the team member the API key belongs to can’t see Nickel Banking deposits, the response is a 403 that says which.
GET
/
nickelBanking
/
checkDeposits
List check deposits
curl --request GET \
--url https://rest.staging.nickel.com/nickelBanking/checkDeposits \
--header 'Authorization: Bearer <token>'import requests
url = "https://rest.staging.nickel.com/nickelBanking/checkDeposits"
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/checkDeposits', 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/checkDeposits",
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/checkDeposits"
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/checkDeposits")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.staging.nickel.com/nickelBanking/checkDeposits")
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{
"checkDeposits": [
{
"id": "cmf2dep0001qz8x4k2v7c9d3e",
"transferId": "cmf2nbt0001qz8x4k2v7c9d3e",
"accountId": "<string>",
"amountCents": 155055,
"status": "PROCESSING",
"payerName": "Acme Corp",
"description": "Q3 retainer",
"returnReason": "<string>",
"rejectionReason": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"depositedAt": "2023-11-07T05:31:56Z",
"unappliedAmountCents": 55055,
"applications": [
{
"id": "cmr9zx1bq000gsf02h1d5w4t8",
"amountCents": 100000,
"paymentLinkId": "cmq7ab3cd000gsf02e5f6g7h8",
"voided": true,
"voidReason": "DEPOSIT_RETURNED"
}
]
}
],
"hasMore": true
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}