Get a check deposit by id
curl --request GET \
--url https://rest.staging.nickel.com/nickelBanking/checkDeposits/{checkDepositId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://rest.staging.nickel.com/nickelBanking/checkDeposits/{checkDepositId}"
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/{checkDepositId}', 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/{checkDepositId}",
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/{checkDepositId}"
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/{checkDepositId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.staging.nickel.com/nickelBanking/checkDeposits/{checkDepositId}")
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{
"checkDeposit": {
"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"
}
]
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Nickel Banking
Get a check deposit by id
Returns one check deposit, in the same shape as List check deposits. This is what to fetch when a check_deposit.* webhook arrives: the event carries only the deposit’s id, and this response is its current state.
A deposit that isn’t your organization’s is a 404. When the team member the API key belongs to can’t see Nickel Banking deposits, or your organization has no active Nickel Banking account, the response is a 403 that says which.
GET
/
nickelBanking
/
checkDeposits
/
{checkDepositId}
Get a check deposit by id
curl --request GET \
--url https://rest.staging.nickel.com/nickelBanking/checkDeposits/{checkDepositId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://rest.staging.nickel.com/nickelBanking/checkDeposits/{checkDepositId}"
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/{checkDepositId}', 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/{checkDepositId}",
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/{checkDepositId}"
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/{checkDepositId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.staging.nickel.com/nickelBanking/checkDeposits/{checkDepositId}")
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{
"checkDeposit": {
"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"
}
]
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The deposit's id from a check_deposit.* webhook, List check deposits or Deposit a check.
Response
Successful operation
Show child attributes
Show child attributes
