Create an ACH

Create an ACH

curl --request POST \
  --url https://api.treasuryprime.com/ach \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "acct_1234567890",
  "amount": "100.00",
  "counterparty_id": "cp_0987654321",
  "direction": "credit",
  "sec_code": "ccd"
}
'

import requests

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

payload = {
    "account_id": "acct_1234567890",
    "amount": "100.00",
    "counterparty_id": "cp_0987654321",
    "direction": "credit",
    "sec_code": "ccd"
}
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: '100.00',
    counterparty_id: 'cp_0987654321',
    direction: 'credit',
    sec_code: 'ccd'
  })
};

fetch('https://api.treasuryprime.com/ach', 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/ach",
  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' => '100.00',
    'counterparty_id' => 'cp_0987654321',
    'direction' => 'credit',
    'sec_code' => 'ccd'
  ]),
  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/ach"

	payload := strings.NewReader("{\n  \"account_id\": \"acct_1234567890\",\n  \"amount\": \"100.00\",\n  \"counterparty_id\": \"cp_0987654321\",\n  \"direction\": \"credit\",\n  \"sec_code\": \"ccd\"\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/ach")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"acct_1234567890\",\n  \"amount\": \"100.00\",\n  \"counterparty_id\": \"cp_0987654321\",\n  \"direction\": \"credit\",\n  \"sec_code\": \"ccd\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"100.00\",\n  \"counterparty_id\": \"cp_0987654321\",\n  \"direction\": \"credit\",\n  \"sec_code\": \"ccd\"\n}"

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

{
  "account_id": "acct_1234567890",
  "amount": "100.00",
  "counterparty_id": "cp_0987654321",
  "created_at": "2017-11-02T11:55:14Z",
  "description": null,
  "direction": "credit",
  "effective_date": "2017-11-03",
  "error": null,
  "id": "ach_1029384756",
  "originator_name": null,
  "scheduled_settlement": null,
  "sec_code": "ppd",
  "service": "standard",
  "status": "pending",
  "updated_at": "2017-11-02T11:55:14Z",
  "userdata": null
}

POST

ach

Create an ACH

curl --request POST \
  --url https://api.treasuryprime.com/ach \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "acct_1234567890",
  "amount": "100.00",
  "counterparty_id": "cp_0987654321",
  "direction": "credit",
  "sec_code": "ccd"
}
'

import requests

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

payload = {
    "account_id": "acct_1234567890",
    "amount": "100.00",
    "counterparty_id": "cp_0987654321",
    "direction": "credit",
    "sec_code": "ccd"
}
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: '100.00',
    counterparty_id: 'cp_0987654321',
    direction: 'credit',
    sec_code: 'ccd'
  })
};

fetch('https://api.treasuryprime.com/ach', 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/ach",
  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' => '100.00',
    'counterparty_id' => 'cp_0987654321',
    'direction' => 'credit',
    'sec_code' => 'ccd'
  ]),
  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/ach"

	payload := strings.NewReader("{\n  \"account_id\": \"acct_1234567890\",\n  \"amount\": \"100.00\",\n  \"counterparty_id\": \"cp_0987654321\",\n  \"direction\": \"credit\",\n  \"sec_code\": \"ccd\"\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/ach")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"acct_1234567890\",\n  \"amount\": \"100.00\",\n  \"counterparty_id\": \"cp_0987654321\",\n  \"direction\": \"credit\",\n  \"sec_code\": \"ccd\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"100.00\",\n  \"counterparty_id\": \"cp_0987654321\",\n  \"direction\": \"credit\",\n  \"sec_code\": \"ccd\"\n}"

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

{
  "account_id": "acct_1234567890",
  "amount": "100.00",
  "counterparty_id": "cp_0987654321",
  "created_at": "2017-11-02T11:55:14Z",
  "description": null,
  "direction": "credit",
  "effective_date": "2017-11-03",
  "error": null,
  "id": "ach_1029384756",
  "originator_name": null,
  "scheduled_settlement": null,
  "sec_code": "ppd",
  "service": "standard",
  "status": "pending",
  "updated_at": "2017-11-02T11:55:14Z",
  "userdata": null
}

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 ach to create

account_id

string

required

ID of the Account originating the transfer. Filterable.

amount

string

required

Amount of money to transfer, with two decimal precision

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

counterparty_id

string

required

ID of the Counterparty receiving the transfer. Be sure that the ach section of the Counterparty contains non-null values. Filterable.

direction

string

required

Direction of funds flow. One of credit (send money to your counterparty) or debit (receive money from your counterparty). Filterable.

sec_code

string

required

One of ccd, ppd, tel, web, cie, arc, or boc. Specifies the transfer type, according to the ACH network

service

string

required

Either standard or sameday. Specifies same-day or standard processing. Filterable.

addenda

string[]

Additional payment-related information. Most uses will not require this field; contact support at help@treasuryprime.com to learn more. Currently only supported for ACH transfers with the SEC code CCD and WEB

bankdata

object

Optional arbitrary data that can be attached for the bank's use

batch_key

string

deprecated

Batch configuration to use for payment

description

string

Optional description (maximum of 10 characters)

originator_name

string

Custom value for specifying the originating company name (maximum of 16 characters). This field will be blank unless explicitly set. This is only available to customers partnered with certain banks

sec_details

object

Optional supplemental fields required by certain SEC codes. Applicable when sec_code is one of: arc, boc, cie, tel, or web. The relevant sub-fields vary by sec_code — see the sec_details object definition for per-code field descriptions.

Show child attributes

userdata

object

Arbitrary data the user can attach to the object

Response

The ach created

account_id

string

ID of the Account originating the transfer. Filterable.

addenda

string[]

amount

string

Amount of money to transfer, with two decimal precision

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

bank_id

string

ID of the bank with which the object is associated

bankdata

object

Optional arbitrary data that can be attached for the bank's use

batch_key

string

deprecated

Batch configuration to use for payment

counterparty_id

string

ID of the Counterparty receiving the transfer. Be sure that the ach section of the Counterparty contains non-null values. Filterable.

description

string

Optional description (maximum of 10 characters)

direction

string

Direction of funds flow. One of credit (send money to your counterparty) or debit (receive money from your counterparty). Filterable.

effective_date

string

The official effective date of the transaction, according to the ACH network. Filterable.

error

string

If the ACH has been returned, this will contain the ACH return reason code for this entry. For example, "R01" would indicate insufficient funds

string

Unique identifier for object

noc_change_code

string

If a notice of change has been received for this ACH, this will contain the latest change code for this entry. For example, "C02" would indicate incorrect routing number

noc_corrected_data

string

If a notice of change has been received for this ACH, this will contain the latest corrected data for this entry. For example, this field could contain a corrected routing number

org_id

string

ID of your organization. Filterable.

originator_name

string

Custom value for specifying the originating company name (maximum of 16 characters). This field will be blank unless explicitly set. This is only available to customers partnered with certain banks

scheduled_settlement

string

A timestamp dictating the approximate time a debit ACH hold will be released, and the debit ACH will be considered settled. (only available when originating ACH on Treasury Prime ledger accounts)

sec_code

string

One of ccd, ppd, tel, web, cie, arc, or boc. Specifies the transfer type, according to the ACH network

sec_details

object

Show child attributes

service

string

Either standard or sameday. Specifies same-day or standard processing. Filterable.

status

string

Current status of the ACH transfer. Read-only. Possible values: pending, processing, sent, returned, canceled, error. Filterable.

trace_number

string

15 digit trace number assigned to the ACH when it was originated. Not available at every bank. Filterable.

trace_suffix

integer

userdata

object

Arbitrary data the user can attach to the object

Introduction

Account

Account Opening

Cards

Payments

Testing

Utilities

Authorizations

Body

Response