Create a transaction

Creates a transaction.

POST /bankaccounts/{bankAccountId}/transactions

Create a transaction

cURL

curl --request POST \
  --url https://api.smokeball.com/bankaccounts/{bankAccountId}/transactions \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "matterId": "da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262",
  "payorId": "<string>",
  "type": "Deposit",
  "amount": 102.65,
  "effectiveDate": "2023-11-07T05:31:56Z",
  "reference": "<string>",
  "reason": "<string>",
  "description": "<string>",
  "note": "<string>"
}
'

import requests

url = "https://api.smokeball.com/bankaccounts/{bankAccountId}/transactions"

payload = {
    "matterId": "da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262",
    "payorId": "<string>",
    "type": "Deposit",
    "amount": 102.65,
    "effectiveDate": "2023-11-07T05:31:56Z",
    "reference": "<string>",
    "reason": "<string>",
    "description": "<string>",
    "note": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json-patch+json'
  },
  body: JSON.stringify({
    matterId: 'da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262',
    payorId: '<string>',
    type: 'Deposit',
    amount: 102.65,
    effectiveDate: '2023-11-07T05:31:56Z',
    reference: '<string>',
    reason: '<string>',
    description: '<string>',
    note: '<string>'
  })
};

fetch('https://api.smokeball.com/bankaccounts/{bankAccountId}/transactions', 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.smokeball.com/bankaccounts/{bankAccountId}/transactions",
  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([
    'matterId' => 'da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262',
    'payorId' => '<string>',
    'type' => 'Deposit',
    'amount' => 102.65,
    'effectiveDate' => '2023-11-07T05:31:56Z',
    'reference' => '<string>',
    'reason' => '<string>',
    'description' => '<string>',
    'note' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json-patch+json",
    "x-api-key: <api-key>"
  ],
]);

$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.smokeball.com/bankaccounts/{bankAccountId}/transactions"

	payload := strings.NewReader("{\n  \"matterId\": \"da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262\",\n  \"payorId\": \"<string>\",\n  \"type\": \"Deposit\",\n  \"amount\": 102.65,\n  \"effectiveDate\": \"2023-11-07T05:31:56Z\",\n  \"reference\": \"<string>\",\n  \"reason\": \"<string>\",\n  \"description\": \"<string>\",\n  \"note\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+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.smokeball.com/bankaccounts/{bankAccountId}/transactions")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"matterId\": \"da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262\",\n  \"payorId\": \"<string>\",\n  \"type\": \"Deposit\",\n  \"amount\": 102.65,\n  \"effectiveDate\": \"2023-11-07T05:31:56Z\",\n  \"reference\": \"<string>\",\n  \"reason\": \"<string>\",\n  \"description\": \"<string>\",\n  \"note\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smokeball.com/bankaccounts/{bankAccountId}/transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"matterId\": \"da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262\",\n  \"payorId\": \"<string>\",\n  \"type\": \"Deposit\",\n  \"amount\": 102.65,\n  \"effectiveDate\": \"2023-11-07T05:31:56Z\",\n  \"reference\": \"<string>\",\n  \"reason\": \"<string>\",\n  \"description\": \"<string>\",\n  \"note\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

202

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Path Parameters

bankAccountId · string · required

Body

application/json-patch+jsonapplication/jsonapplication/*+json

matterId · string | null

Unique identifier of the associated matter.

Example:

"da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262"

payorId · string | null

Unique identifier of the associated contact.

type · string | null

The type of the transaction.

Possible values: Deposit.

Example:

"Deposit"

amount · number<double>

The amount of the transaction in dollars. Limited to 2 decimal places (cents).

Example:

102.65

effectiveDate · string<date-time>

Date of the transaction.

reference · string | null

Reference for the transaction.

reason · string | null

Reason for the transaction.

description · string | null

Description of the transaction.

note · string | null

Note for the transaction (for internal use).

Response

202

application/json

When request is accepted. Returns a hypermedia 'Link' object of the transaction to be created.

id · string | null

href · string | null

relation · string | null

method · string | null · default: GET