Getting Started
Master Accounts
Sub Account Holders
Sub Accounts
Counterparties
Card Holders
Cards
Transactions
- GETList all Transactions
- POSTSub Ledger a Transaction
- POSTOriginate an Intra Account Push
- POSTOriginate an Intra Account Pull
- POSTOriginate an ACH Push
- POSTOriginate an ACH Pull
- POSTOriginate a Domestic Wire
- POSTOriginate an International Wire
- POSTOriginate an RTP Push
- POSTOriginate a FedNow Push
- POSTOriginate a Debit Card Push
- POSTOriginate a Debit Card Pull
- POSTOriginate a Check Send
- POSTOriginate a Check Deposit
- GETRetrieve a Transaction
- PATCHUpdate a Transaction
Attachments
Webhooks
List all Transactions
List all Transactions
curl --request GET \
--url https://api.sandbox.solidfi.com/v2/payments/transaction \
--header 'api-key: <api-key>'
{
"total": 1,
"data": [
{
"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": "settled",
"amount": "1500.00",
"currency": "usd",
"direction": "credit",
"method": "ach",
"type": "push",
"message": "incoming",
"description": "May invoice from NewCo",
"available_balance": "1590.00",
"pending_credits": "230.00",
"pending_debits": "150.00",
"counterparty": {
"id": "ctp_8e5541c8a9e50c3af3b0daacf9175130",
"name": "NewCo Inc",
"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": "",
"company_entry_description": "Payments",
"trace_number": "123112211",
"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": {
"invoice_number": "INV-AC989878"
},
"reconciliation": {
"status": "not_reconciled",
"master_account": null,
"sub_account": [
{
"id": "sub_bda1e562657c41e553104b10aad3fe70",
"transaction_id": "txn_817d2a074042bb4ec54e08fd82b1e0a8",
"amount": "1500.00"
}
]
},
"timestamps": {
"created_at": "2024-04-04T11:06:00Z",
"updated_at": "2024-04-04T11:06:00Z",
"settled_at": "2024-04-04T11:06:00Z"
}
}
],
"has_more": "true",
"starting_after": "Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky",
"ending_before": "Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky"
}
Headers
API key is required to call Solid APIs. You can view and manage your API keys in the Solid dashboard.
Query Parameters
unique id of the sub account
unique id of the master account
unique id of the sub account holder
unique id of the master account holder
unique id to cross-reference records with external systems
type of ledger
master_account
, sub_account
number of records to return
A cursor for use in pagination. starting_after
is an ID that defines your place in the list. For instance, if you make a list request and receive 50 records, ending with Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky
, your subsequent call can include starting_after=Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky
in order to fetch the next page of the list.
A cursor for use in pagination. ending_before
is an ID that defines your place in the list. For instance, if you make a list request and receive 50 records, starting with Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky
, your subsequent call can include ending_before= Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky
in order to fetch the previous page of the list.
Response
total number of records
unique id of the transaction
unique id of the sub account
unique id of the master account holder
status of the transaction
originated
, pending
, clearing
, cleared
, settled
, canceled
, in_review
, returned
, reversed
, received
, declined
, refunded
amount of the transaction
currency of the transaction
usd
if transaction is debit or credit
debit
, credit
payment method for the transaction
ach
, domestic_wire
, international_wire
, check
, fednow
, rtp
, debit_card
, card_issuing
type within the payment method used for the transaction
push
, pull
, decline
, cancel
, return
, send
, deposit
, request
, auth
, adjust
, reverse
, refund
if transaction is incoming or outgoing
incoming
, outgoing
description of the transaction
available balance in the sub account after the transaction
total pending credits to the sub account after the transaction
total pending debits to the sub account after the transaction
unique id of the counterparty
name of the counterparty
account verification status of the counterparty
pass
, fail
, review
bank account number of the counterparty
routing number of the counterparty's bank
type of counterparty's bank account
business_checking
, business_savings
, personal_checking
, personal_savings
name of counterparty's bank
SWIFT/BIC code of counterparty's bank
name of counterparty's bank
line 1 of the address
line 2 of the address
city of the address
2-Letter state abbreviation (ex: CA)
2-letter abbreviated country code (ex: US)
postal code
SWIFT/BIC code of counterparty's correspondent bank
name of counterparty's correspondent bank
line 1 of the address
line 2 of the address
city of the address
2-Letter US state abbreviation (ex: CA)
2-letter abbreviated country code (ex: US)
postal code
line 1 of the address
line 2 of the address
city of the address
2-Letter US state abbreviation (ex: CA)
2-letter abbreviated country code (ex: US)
postal code
date on which the ACH must post on the beneficiary's bank account
text field within the ACH batch file used to reference ACH originator details like name, etc.
text field within the ACH batch file that describes the purpose of the ACH transaction
unique identifier within the ACH batch file
reason code given in case of ACH return
unique id for real time authorization
IMAD (Input Message Accountability Data) number is a unique number generated by FedwireService for tracking purposes.
OMAD (Output Message Accountability Data) number is a unique number generated by FedwireService for tracking purposes.
reference number of the RTP transaction that shown to the beneficiary
reference number of the FedNow transaction that shown to the beneficiary
unique id of the card
unique id of the card holder
merchant the card was used at
method of use for the card transaction
digital wallet type
unique id for real time authorization
time period available in which the maximum amount is allowed to be spent
daily
, per_transaction
, weekly
, monthly
, yearly
, all_time
maximum amount available to be spent in the set period
unique id to cross-reference records with external systems
purpose of the transaction
unique id of the attachment created
label of the attachment
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 status of the transaction
reconciled
, not_reconciled
if there are more records to iterate or not
true
, false
A cursor for use in pagination. starting_after
is an ID that defines your place in the list. For instance, if you make a list request and receive 50 records, ending with Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky
, your subsequent call can include starting_after=Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky
in order to fetch the next page of the list.
A cursor for use in pagination. ending_before
is an ID that defines your place in the list. For instance, if you make a list request and receive 50 records, starting with Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky
, your subsequent call can include ending_before= Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky
in order to fetch the previous page of the list.
curl --request GET \
--url https://api.sandbox.solidfi.com/v2/payments/transaction \
--header 'api-key: <api-key>'
{
"total": 1,
"data": [
{
"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": "settled",
"amount": "1500.00",
"currency": "usd",
"direction": "credit",
"method": "ach",
"type": "push",
"message": "incoming",
"description": "May invoice from NewCo",
"available_balance": "1590.00",
"pending_credits": "230.00",
"pending_debits": "150.00",
"counterparty": {
"id": "ctp_8e5541c8a9e50c3af3b0daacf9175130",
"name": "NewCo Inc",
"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": "",
"company_entry_description": "Payments",
"trace_number": "123112211",
"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": {
"invoice_number": "INV-AC989878"
},
"reconciliation": {
"status": "not_reconciled",
"master_account": null,
"sub_account": [
{
"id": "sub_bda1e562657c41e553104b10aad3fe70",
"transaction_id": "txn_817d2a074042bb4ec54e08fd82b1e0a8",
"amount": "1500.00"
}
]
},
"timestamps": {
"created_at": "2024-04-04T11:06:00Z",
"updated_at": "2024-04-04T11:06:00Z",
"settled_at": "2024-04-04T11:06:00Z"
}
}
],
"has_more": "true",
"starting_after": "Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky",
"ending_before": "Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky"
}