POST
/
v2
/
simulate
/
incoming
/
ach
/
push

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
​
amount
string

amount of the transaction

​
counterparty
object
​
description
string

description of the transaction

​
master_account_id
string

unique id of the master account

​
sub_account_id
string

unique id of the sub account

Response

201 - application/json
​
ach
object
​
amount
string

amount of the transaction

​
attachments
object[]
​
available_balance
string

available balance in the sub account after the transaction

​
card
object
​
check
object
​
counterparty
object
​
currency
enum<string>

currency of the transaction

Available options:
usd
​
description
string

description of the transaction

​
direction
enum<string>

if transaction is debit or credit

Available options:
debit,
credit
​
domestic_wire
object
​
external_reference_id
string

unique id to cross-reference records with external systems

​
fednow
object
​
id
string

unique id of the transaction

​
international_wire
object
​
master_account_id
string

unique id of the master account holder

​
message
enum<string>

if transaction is incoming or outgoing

Available options:
incoming,
outgoing
​
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": ""}

​
method
enum<string>

payment method for the transaction

Available options:
ach,
domestic_wire,
international_wire,
check,
fednow,
rtp,
debit_card,
card_issuing
​
ofac
object
​
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

​
purpose
string

purpose of the transaction

​
reconciliation
object
​
rtp
object
​
status
enum<string>

status of the transaction

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

unique id of the sub account

​
timestamps
object
​
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
Delete a WebhookSimulate an Incoming ACH Pull