List ACHs - Treasury Prime Developer Documentation

List ACH Transfers

curl --request GET \
  --url https://api.treasuryprime.com/ach \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

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::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "data": [
    {
      "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
    }
  ]
}

GET

/

ach

List ACH Transfers

curl --request GET \
  --url https://api.treasuryprime.com/ach \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

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::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "data": [
    {
      "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.

Query Parameters

account_id

string

ID of the Account originating the transfer. Filterable.

counterparty_id

string

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

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.

org_id

string

ID of your organization. Filterable.

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

page_cursor

string

Pagination cursor, value is the object ID.

page_size

integer

default:100

Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.

Required range: x >= 1

from_date

string

Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).

to_date

string

Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).

Response

200 - application/json

A dictionary with a data property that contains a list of up to page_size ach elements, starting after the ach described by page_cursor. If no more achs are available, the resulting list will be empty.

data

object[]

Show child attributes

Overview Create an ACH

⌘I