Simulate an ACH debit from another company
curl --request POST \
--url https://rest.staging.nickel.com/sandbox/nickelBanking/accounts/{accountId}/inboundAchDebits \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amountCents": 1234,
"companyName": "Gusto Payroll",
"companyId": "1943827561",
"entryDescription": "PAYROLL"
}
'import requests
url = "https://rest.staging.nickel.com/sandbox/nickelBanking/accounts/{accountId}/inboundAchDebits"
payload = {
"amountCents": 1234,
"companyName": "Gusto Payroll",
"companyId": "1943827561",
"entryDescription": "PAYROLL"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amountCents: 1234,
companyName: 'Gusto Payroll',
companyId: '1943827561',
entryDescription: 'PAYROLL'
})
};
fetch('https://rest.staging.nickel.com/sandbox/nickelBanking/accounts/{accountId}/inboundAchDebits', 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/sandbox/nickelBanking/accounts/{accountId}/inboundAchDebits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amountCents' => 1234,
'companyName' => 'Gusto Payroll',
'companyId' => '1943827561',
'entryDescription' => 'PAYROLL'
]),
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://rest.staging.nickel.com/sandbox/nickelBanking/accounts/{accountId}/inboundAchDebits"
payload := strings.NewReader("{\n \"amountCents\": 1234,\n \"companyName\": \"Gusto Payroll\",\n \"companyId\": \"1943827561\",\n \"entryDescription\": \"PAYROLL\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://rest.staging.nickel.com/sandbox/nickelBanking/accounts/{accountId}/inboundAchDebits")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amountCents\": 1234,\n \"companyName\": \"Gusto Payroll\",\n \"companyId\": \"1943827561\",\n \"entryDescription\": \"PAYROLL\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.staging.nickel.com/sandbox/nickelBanking/accounts/{accountId}/inboundAchDebits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amountCents\": 1234,\n \"companyName\": \"Gusto Payroll\",\n \"companyId\": \"1943827561\",\n \"entryDescription\": \"PAYROLL\"\n}"
response = http.request(request)
puts response.read_body{
"simulatedDebit": {
"accountId": "cmf1nba0001qz8x4k2v7c9d3e",
"amountCents": 1234,
"companyName": "GUSTO PAYROLL",
"companyId": "1943827561",
"entryDescription": "PAYROLL",
"automaticallyResolvesAt": "2026-11-10T22:20:00.000Z"
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Sandbox
Simulate an ACH debit from another company
Sandbox only. Another company pulls an ACH debit from the account, as a payroll provider, tax agency or vendor would. The debit stays pending for 20 minutes, until automaticallyResolvesAt. With Debit Protection on, it is held and Nickel sends held_debit.held. Once it resolves, the bank takes the money if the account has it, and otherwise declines the debit for insufficient funds. companyName, companyId and entryDescription default to SANDBOX PULL CO, 9999999999 and AUTOPAY, and are uppercased. Production answers 400. Needs “Can withdraw from Nickel Banking account”.
POST
/
sandbox
/
nickelBanking
/
accounts
/
{accountId}
/
inboundAchDebits
Simulate an ACH debit from another company
curl --request POST \
--url https://rest.staging.nickel.com/sandbox/nickelBanking/accounts/{accountId}/inboundAchDebits \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amountCents": 1234,
"companyName": "Gusto Payroll",
"companyId": "1943827561",
"entryDescription": "PAYROLL"
}
'import requests
url = "https://rest.staging.nickel.com/sandbox/nickelBanking/accounts/{accountId}/inboundAchDebits"
payload = {
"amountCents": 1234,
"companyName": "Gusto Payroll",
"companyId": "1943827561",
"entryDescription": "PAYROLL"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amountCents: 1234,
companyName: 'Gusto Payroll',
companyId: '1943827561',
entryDescription: 'PAYROLL'
})
};
fetch('https://rest.staging.nickel.com/sandbox/nickelBanking/accounts/{accountId}/inboundAchDebits', 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/sandbox/nickelBanking/accounts/{accountId}/inboundAchDebits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amountCents' => 1234,
'companyName' => 'Gusto Payroll',
'companyId' => '1943827561',
'entryDescription' => 'PAYROLL'
]),
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://rest.staging.nickel.com/sandbox/nickelBanking/accounts/{accountId}/inboundAchDebits"
payload := strings.NewReader("{\n \"amountCents\": 1234,\n \"companyName\": \"Gusto Payroll\",\n \"companyId\": \"1943827561\",\n \"entryDescription\": \"PAYROLL\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://rest.staging.nickel.com/sandbox/nickelBanking/accounts/{accountId}/inboundAchDebits")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amountCents\": 1234,\n \"companyName\": \"Gusto Payroll\",\n \"companyId\": \"1943827561\",\n \"entryDescription\": \"PAYROLL\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.staging.nickel.com/sandbox/nickelBanking/accounts/{accountId}/inboundAchDebits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amountCents\": 1234,\n \"companyName\": \"Gusto Payroll\",\n \"companyId\": \"1943827561\",\n \"entryDescription\": \"PAYROLL\"\n}"
response = http.request(request)
puts response.read_body{
"simulatedDebit": {
"accountId": "cmf1nba0001qz8x4k2v7c9d3e",
"amountCents": 1234,
"companyName": "GUSTO PAYROLL",
"companyId": "1943827561",
"entryDescription": "PAYROLL",
"automaticallyResolvesAt": "2026-11-10T22:20:00.000Z"
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Authorizations
Body
application/json
