POST
/
v2
/
simulate
/
incoming
/
ach
/
pull

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.

Body

application/json
master_account_id
string

unique id of the master account

sub_account_id
string

unique id of the sub account

amount
string

amount of the transaction

description
string

description of the transaction

counterparty_name
string

name of the counterparty

counterparty_routing_number
string

routing number of the counterparty's bank

Response

201 - application/json
id
string

unique id of the transaction

sub_account_id
string

unique id of the sub account

master_account_id
string

unique id of the master account holder

status
enum<string>

status of the transaction

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

amount of the transaction

currency
enum<string>

currency of the transaction

Available options:
usd
direction
enum<string>

if transaction is debit or credit

Available options:
debit,
credit
method
enum<string>

payment method for the transaction

Available options:
ach,
domestic_wire,
international_wire,
check,
fednow,
rtp,
debit_card,
card_issuing
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
message
enum<string>

if transaction is incoming or outgoing

Available options:
incoming,
outgoing
description
string

description of the transaction

available_balance
string

available balance in the sub account after the transaction

pending_credits
string

total pending credits to the sub account after the transaction

pending_debits
string

total pending debits to the sub account after the transaction

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

purpose
string

purpose of the transaction

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