Skip to main content
POST
/
v1
/
businesses
/
{businessId}
/
deposits
Create Deposit
curl --request POST \
  --url https://api.cadanapay.com/v1/businesses/{businessId}/deposits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": {
    "amount": 10000,
    "currency": "USD"
  },
  "idempotencyKey": "b6ae5da9-6342-4a58-bd50-8564d68d3f7e",
  "externalAccountId": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e",
  "paymentMethod": "ach",
  "suppressNotification": false,
  "description": "April payroll funding"
}
'
import requests

url = "https://api.cadanapay.com/v1/businesses/{businessId}/deposits"

payload = {
"amount": {
"amount": 10000,
"currency": "USD"
},
"idempotencyKey": "b6ae5da9-6342-4a58-bd50-8564d68d3f7e",
"externalAccountId": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e",
"paymentMethod": "ach",
"suppressNotification": False,
"description": "April payroll funding"
}
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({
amount: {amount: 10000, currency: 'USD'},
idempotencyKey: 'b6ae5da9-6342-4a58-bd50-8564d68d3f7e',
externalAccountId: '8ef9a712-cdae-4110-b1ea-9ba95abbee6e',
paymentMethod: 'ach',
suppressNotification: false,
description: 'April payroll funding'
})
};

fetch('https://api.cadanapay.com/v1/businesses/{businessId}/deposits', 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.cadanapay.com/v1/businesses/{businessId}/deposits",
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([
'amount' => [
'amount' => 10000,
'currency' => 'USD'
],
'idempotencyKey' => 'b6ae5da9-6342-4a58-bd50-8564d68d3f7e',
'externalAccountId' => '8ef9a712-cdae-4110-b1ea-9ba95abbee6e',
'paymentMethod' => 'ach',
'suppressNotification' => false,
'description' => 'April payroll funding'
]),
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.cadanapay.com/v1/businesses/{businessId}/deposits"

payload := strings.NewReader("{\n \"amount\": {\n \"amount\": 10000,\n \"currency\": \"USD\"\n },\n \"idempotencyKey\": \"b6ae5da9-6342-4a58-bd50-8564d68d3f7e\",\n \"externalAccountId\": \"8ef9a712-cdae-4110-b1ea-9ba95abbee6e\",\n \"paymentMethod\": \"ach\",\n \"suppressNotification\": false,\n \"description\": \"April payroll funding\"\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://api.cadanapay.com/v1/businesses/{businessId}/deposits")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": {\n \"amount\": 10000,\n \"currency\": \"USD\"\n },\n \"idempotencyKey\": \"b6ae5da9-6342-4a58-bd50-8564d68d3f7e\",\n \"externalAccountId\": \"8ef9a712-cdae-4110-b1ea-9ba95abbee6e\",\n \"paymentMethod\": \"ach\",\n \"suppressNotification\": false,\n \"description\": \"April payroll funding\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.cadanapay.com/v1/businesses/{businessId}/deposits")

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 \"amount\": {\n \"amount\": 10000,\n \"currency\": \"USD\"\n },\n \"idempotencyKey\": \"b6ae5da9-6342-4a58-bd50-8564d68d3f7e\",\n \"externalAccountId\": \"8ef9a712-cdae-4110-b1ea-9ba95abbee6e\",\n \"paymentMethod\": \"ach\",\n \"suppressNotification\": false,\n \"description\": \"April payroll funding\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e"
}
{
"code": "invalid_request_body",
"message": "The request body provided is not valid",
"params": {
"field": "Value is invalid."
}
}
{
"code": "resource_not_found",
"message": "Requested resource could not be found."
}
{
"code": "internal_error",
"message": "An unexpected error occurred. Please try again later."
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

businessId
string
required

The unique identifier for the business

Body

application/json

Create a deposit to add funds to a business account

amount
object
required
idempotencyKey
string
required

Unique string to prevent dedupe

Example:

"b6ae5da9-6342-4a58-bd50-8564d68d3f7e"

externalAccountId
string
required

unique identifier of the external account to pull funds from, required for an ach direct-debit

Example:

"8ef9a712-cdae-4110-b1ea-9ba95abbee6e"

paymentMethod
enum<string>
required

Payment method for the deposit

Available options:
ach
Example:

"ach"

suppressNotification
boolean
default:false
required

Whether to suppress email notifications (optional, defaults to false)

description
string

Optional free-text label attached to the deposit. Surfaced on the resulting ledger entry and any notification emails.

Example:

"April payroll funding"

Response

create business deposit response

id
string<uuid>
Example:

"8ef9a712-cdae-4110-b1ea-9ba95abbee6e"