Create a Manual Hold - Treasury Prime Developer Documentation

Create a Manual Hold

curl --request POST \
  --url https://api.treasuryprime.com/hold \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "acct_1234567890",
  "amount": "10.00",
  "expires_at": "2023-11-09T22:39:48Z",
  "hold_description": "Hold description",
  "hold_release_description": "Released description"
}
'

import requests

url = "https://api.treasuryprime.com/hold"

payload = {
    "account_id": "acct_1234567890",
    "amount": "10.00",
    "expires_at": "2023-11-09T22:39:48Z",
    "hold_description": "Hold description",
    "hold_release_description": "Released description"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    account_id: 'acct_1234567890',
    amount: '10.00',
    expires_at: '2023-11-09T22:39:48Z',
    hold_description: 'Hold description',
    hold_release_description: 'Released description'
  })
};

fetch('https://api.treasuryprime.com/hold', 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.treasuryprime.com/hold",
  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([
    'account_id' => 'acct_1234567890',
    'amount' => '10.00',
    'expires_at' => '2023-11-09T22:39:48Z',
    'hold_description' => 'Hold description',
    'hold_release_description' => 'Released description'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "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.treasuryprime.com/hold"

	payload := strings.NewReader("{\n  \"account_id\": \"acct_1234567890\",\n  \"amount\": \"10.00\",\n  \"expires_at\": \"2023-11-09T22:39:48Z\",\n  \"hold_description\": \"Hold description\",\n  \"hold_release_description\": \"Released description\"\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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.treasuryprime.com/hold")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"acct_1234567890\",\n  \"amount\": \"10.00\",\n  \"expires_at\": \"2023-11-09T22:39:48Z\",\n  \"hold_description\": \"Hold description\",\n  \"hold_release_description\": \"Released description\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.treasuryprime.com/hold")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"acct_1234567890\",\n  \"amount\": \"10.00\",\n  \"expires_at\": \"2023-11-09T22:39:48Z\",\n  \"hold_description\": \"Hold description\",\n  \"hold_release_description\": \"Released description\"\n}"

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

{
  "account_id": "acct_1234567890",
  "amount": "10.00",
  "bank_id": "bank_treasuryprime",
  "expires_at": "2023-11-09T22:39:48Z",
  "hold_description": "Hold description",
  "hold_release_description": "Released description",
  "hold_transaction_id": "ttx_1234567890",
  "id": "mhold_1234567890",
  "org_id": "org_fintech",
  "release_transaction_id": null,
  "status": "active"
}

POST

/

hold

Create a Manual Hold

curl --request POST \
  --url https://api.treasuryprime.com/hold \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "acct_1234567890",
  "amount": "10.00",
  "expires_at": "2023-11-09T22:39:48Z",
  "hold_description": "Hold description",
  "hold_release_description": "Released description"
}
'

import requests

url = "https://api.treasuryprime.com/hold"

payload = {
    "account_id": "acct_1234567890",
    "amount": "10.00",
    "expires_at": "2023-11-09T22:39:48Z",
    "hold_description": "Hold description",
    "hold_release_description": "Released description"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    account_id: 'acct_1234567890',
    amount: '10.00',
    expires_at: '2023-11-09T22:39:48Z',
    hold_description: 'Hold description',
    hold_release_description: 'Released description'
  })
};

fetch('https://api.treasuryprime.com/hold', 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.treasuryprime.com/hold",
  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([
    'account_id' => 'acct_1234567890',
    'amount' => '10.00',
    'expires_at' => '2023-11-09T22:39:48Z',
    'hold_description' => 'Hold description',
    'hold_release_description' => 'Released description'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "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.treasuryprime.com/hold"

	payload := strings.NewReader("{\n  \"account_id\": \"acct_1234567890\",\n  \"amount\": \"10.00\",\n  \"expires_at\": \"2023-11-09T22:39:48Z\",\n  \"hold_description\": \"Hold description\",\n  \"hold_release_description\": \"Released description\"\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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.treasuryprime.com/hold")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"acct_1234567890\",\n  \"amount\": \"10.00\",\n  \"expires_at\": \"2023-11-09T22:39:48Z\",\n  \"hold_description\": \"Hold description\",\n  \"hold_release_description\": \"Released description\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.treasuryprime.com/hold")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"acct_1234567890\",\n  \"amount\": \"10.00\",\n  \"expires_at\": \"2023-11-09T22:39:48Z\",\n  \"hold_description\": \"Hold description\",\n  \"hold_release_description\": \"Released description\"\n}"

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

{
  "account_id": "acct_1234567890",
  "amount": "10.00",
  "bank_id": "bank_treasuryprime",
  "expires_at": "2023-11-09T22:39:48Z",
  "hold_description": "Hold description",
  "hold_release_description": "Released description",
  "hold_transaction_id": "ttx_1234567890",
  "id": "mhold_1234567890",
  "org_id": "org_fintech",
  "release_transaction_id": null,
  "status": "active"
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

The manual_hold to create

account_id

string

required

ID of the Account to place the hold. Filterable.

amount

string

required

Amount of money to hold, with two decimal precision

Pattern: ^[0-9]+[.][0-9][0-9]$

expires_at

string

Optional timestamp to expire the hold

hold_description

string

Optional description for the hold transaction

hold_release_description

string

Optional description for the hold release transaction

Response

200 - application/json

The manual_hold created

account_id

string

ID of the Account to place the hold. Filterable.

amount

string

Amount of money to hold, with two decimal precision

Pattern: ^[0-9]+[.][0-9][0-9]$

bank_id

string

ID of the bank with which the object is associated

expires_at

string

Optional timestamp to expire the hold

hold_description

string

Optional description for the hold transaction

hold_release_description

string

Optional description for the hold release transaction

hold_transaction_id

string

ID of the hold transaction

id

string

Unique identifier for object

org_id

string

ID of the organization with which the object is associated

release_transaction_id

string

ID of the hold release transaction

status

string

Status of the hold, one of active, released, or expired. Filterable.