POST
/
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"
}'
{
  "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

​
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)

​
sec_code
string
required

One of ccd, ppd, or web. 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
​
userdata
object

Arbitrary data the user can attach to the object

Response

200
application/json
The ach created
​
account_id
string

ID of the Account originating the transfer. 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

​
amount
string

Amount of money to transfer, with two decimal precision

​
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)

​
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

​
id
string

Unique identifier for object

​
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, or web. Specifies the transfer type, according to the ACH network

​
sec_details
object
​
service
string

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

​
status
string
​
trace_suffix
integer
​
userdata
object

Arbitrary data the user can attach to the object