POST
/
v2
/
payments
/
ach
/
pull
curl --request POST \
  --url https://api.sandbox.solidfi.com/v2/payments/ach/pull \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "sub_account_id": "sub_bda1e562657c41e553104b10aad3fe70",
  "counterparty_id": "ctp_8e5541c8a9e50c3af3b0daacf9175130",
  "amount": "500.00",
  "description": "May Rent",
  "same_day": "true",
  "effective_date": "2024-04-05",
  "company_entry_description": "Payment",
  "external_reference_id": "123-9088-2"
}'
{
  "id": "txn_817d2a074042bb4ec54e08fd82b1e0a8",
  "client_id": "cli_64c6c87ee9d609f36a6f390dc378a4ce",
  "master_account_holder_id": "mah_201e02c581a098a740456c5c19fcfcd6",
  "master_account_id": "mas_743fa071316bc6beaf5dddfd05f49c30",
  "sub_account_holder_id": "sah_5ccfeef0adf0cbe2aa0980d2c9505752",
  "sub_account_id": "sub_bda1e562657c41e553104b10aad3fe70",
  "status": "originated",
  "amount": "500.00",
  "currency": "usd",
  "direction": "credit",
  "method": "ach",
  "type": "pull",
  "message": "outgoing",
  "description": "May Rent",
  "available_balance": "250.00",
  "pending_credits": "500.00",
  "pending_debits": "0.00",
  "counterparty": {
    "id": "ctp_8e5541c8a9e50c3af3b0daacf9175130",
    "name": "John Doe",
    "verification_status": "pass",
    "account_number": "98324502",
    "routing_number": "121042882",
    "account_type": "business_checking",
    "bank_name": "Wells Fargo",
    "beneficiary_bank": null,
    "correspondent_bank": null,
    "shipping_address": null
  },
  "ach": {
    "same_day": "true",
    "effective_date": "2024-04-04",
    "company_discretionary_data": "DIRECT DEPOSIT",
    "company_entry_description": "Payments",
    "trace_number": "",
    "return_code": "",
    "rta_id": ""
  },
  "parent_transaction_id": "",
  "external_reference_id": "123-9088-2",
  "purpose": "",
  "ofac": {
    "status": "pass",
    "last_updated_at": "2024-04-01T21:00:00Z"
  },
  "attachments": null,
  "metadata": null,
  "reconciliation": {
    "status": "not_reconciled",
    "master_account": null,
    "sub_account": [
      {
        "id": "sub_bda1e562657c41e553104b10aad3fe70",
        "transaction_id": "txn_817d2a074042bb4ec54e08fd82b1e0a8",
        "amount": "500.00"
      }
    ]
  },
  "timestamps": {
    "created_at": "2024-04-04T11:06:00Z",
    "updated_at": "2024-04-04T11:06:00Z",
    "settled_at": "2024-04-04T11:06:00Z"
  }
}

Headers

​
api-key
string
required

API key is required to call Solid APIs. You can view and manage your API keys in the Solid dashboard.

Example:

"{{api_key}}"

Body

application/json
​
sub_account_id
string

unique id of the sub account

Example:

"sub_bda1e562657c41e553104b10aad3fe70"

​
counterparty_id
string

unique id of the counterparty

Example:

"ctp_8e5541c8a9e50c3af3b0daacf9175130"

​
amount
string

amount of the transaction

Example:

"500.00"

​
description
string

description of the transaction

Example:

"May Rent"

​
same_day
string

if ACH is same day or next day

Example:

"true"

​
effective_date
string

date on which the ACH must post on the beneficiary's bank account

Example:

"2024-04-05"

​
company_discretionary_data
string

text field within the ACH batch file used to reference ACH originator details like name, etc.

Example:

"DIRECT DEPOSIT"

​
company_entry_description
string

text field within the ACH batch file that describes the purpose of the ACH transaction

Example:

"PAYROLL"

​
external_reference_id
string

unique id to cross-reference records with external systems

Example:

"123-9088-2"

Response

201
application/json
Originate an ACH Pull
​
id
string

unique id of the transaction

Example:

"txn_817d2a074042bb4ec54e08fd82b1e0a8"

​
sub_account_id
string

unique id of the sub account

Example:

"sub_bda1e562657c41e553104b10aad3fe70"

​
master_account_id
string

unique id of the master account holder

Example:

"mas_743fa071316bc6beaf5dddfd05f49c30"

​
status
enum<string>

status of the transaction

Available options:
originated,
pending,
clearing,
cleared,
settled,
canceled,
in_review,
returned,
reversed,
received,
declined,
refunded
Example:

"originated"

​
amount
string

amount of the transaction

Example:

"93.50"

​
currency
enum<string>

currency of the transaction

Available options:
usd
Example:

"usd"

​
direction
enum<string>

if transaction is debit or credit

Available options:
debit,
credit
Example:

"debit"

​
method
enum<string>

payment method for the transaction

Available options:
ach,
domestic_wire,
international_wire,
check,
fednow,
rtp,
debit_card,
card_issuing
Example:

"ach"

​
type
enum<string>

type within the payment method used for the transaction

Available options:
push,
pull,
decline,
cancel,
return,
send,
deposit,
request,
auth,
adjust,
reverse,
refund
Example:

"push"

​
message
enum<string>

if transaction is incoming or outgoing

Available options:
incoming,
outgoing
Example:

"outgoing"

​
description
string

description of the transaction

Example:

"Invoice payment"

​
available_balance
string

available balance in the sub account after the transaction

Example:

"500.00"

​
pending_credits
string

total pending credits to the sub account after the transaction

Example:

"0.00"

​
pending_debits
string

total pending debits to the sub account after the transaction

Example:

"93.50"

​
counterparty
object
​
ach
object
​
domestic_wire
object
​
international_wire
object
​
rtp
object
​
fednow
object
​
check
object
​
card
object
​
external_reference_id
string

unique id to cross-reference records with external systems

Example:

"123-9088-2"

​
purpose
string

purpose of the transaction

Example:

"May Invoice"

​
ofac
object
​
attachments
object[]
​
metadata
object

Metadata takes free-form key-value pairs. You may send metadata when you create an object (POST) and when updating the object (PATCH). If you would like to remove metadata that is already on an object, you can unset it by passing in the key-value pair with an empty string, like this: {"key": ""}

​
reconciliation
object
​
timestamps
object