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 Counterparties
List all Counterparties
curl --request GET \
--url https://api.sandbox.solidfi.com/v2/payments/counterparty \
--header 'api-key: <api-key>'{
"total": 1,
"data": [
{
"value": {
"id": "ctp_8e5541c8a9e50c3af3b0daacf9175130",
"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",
"label": "Development Vendor",
"type": "person",
"person": {
"first_name": "John",
"last_name": "Doe",
"id_type": "ssn",
"id_number": "223902234",
"date_of_birth": "1974-01-25",
"phone": "+19418405843",
"email": "john.doe@gmail.com",
"address": {
"line1": "123 Main St",
"line2": "",
"city": "New York",
"state": "NY",
"country": "US",
"postal_code": "10001"
}
},
"intra_account": {
"sub_account_number": "95483674098723",
"sub_account_id": "sub_cda1e562657c41e553104b10aad3fe70"
},
"ach": {
"account_number": "98324502",
"routing_number": "121042882",
"account_type": "business_checking",
"bank_name": "Wells Fargo",
"verification_status": "pass"
},
"domestic_wire": {
"account_number": "98324502",
"routing_number": "121042882",
"account_type": "business_checking",
"bank_name": "Wells Fargo"
},
"international_wire": {
"account_number": "920020006167511",
"beneficiary_bank": {
"identifier_code": "ICICINBBNRI",
"name": "ICICI Bank",
"address": {
"line1": "256 Main St",
"line2": "",
"city": "Bengaluru",
"state": "KA",
"country": "IN",
"postal_code": "900009"
}
},
"correspondent_bank": {
"identifier_code": "SCBLUS33XXX",
"name": "STANDARD CHARTERED BANK",
"address": {
"line1": "1095 12th Ave",
"line2": "",
"city": "New York",
"state": "NY",
"country": "US",
"postal_code": "10001"
}
}
},
"rtp": {
"account_number": "98324502",
"routing_number": "121042882",
"account_type": "business_checking",
"bank_name": "Wells Fargo",
"verification_status": "pass"
},
"fednow": {
"account_number": "98324502",
"routing_number": "121042882",
"account_type": "business_checking",
"bank_name": "Wells Fargo",
"verification_status": "pass"
},
"check": {
"address": {
"line1": "123 Main St",
"line2": "",
"city": "New York",
"state": "NY",
"country": "US",
"postal_code": "10001"
}
},
"debit_card": {
"card_number": "tok_live_6GVyHuQR7aAjCZivYzLbuP_9990",
"last4": "9990",
"expiry_month": "10",
"expiry_year": "2024",
"cvv": "tok_live_6GVyHuQR7aAjCZivYzLbuP_9990",
"address": {
"line1": "123 Main St",
"line2": "",
"city": "New York",
"state": "NY",
"country": "US",
"postal_code": "10001"
},
"pull_enabled": true,
"push_enabled": true
},
"purpose": "Offshore dev center",
"external_reference_id": "TW-9L1L2-UVV",
"ofac": {
"status": "pass",
"last_updated_at": "2024-04-01T21:00:00Z"
},
"attachments": [
{
"label": "Dev Contract",
"id": "att_a8d2b191fa0e960d8e49a4bfd320e07b",
"created_at": "2024-04-01T21:00:00Z"
}
],
"metadata": {
"vendor_id": "VID-0987ACR"
},
"status": "activated",
"timestamps": {
"created_at": "2024-04-01T21:00:00Z",
"updated_at": "2024-04-01T21:00: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 to cross-reference records with external systems
status of counterparty
pending_activation, activated, suspended, deactivated 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 counterparty
unique id of the client to which the counterparty belongs
unique id of the master account holder
unique id of the master account
unique id of the sub account holder
unique id of the sub account under which the counterparty was created
label of the counterparty
type of counterparty
person, business first name of the person
middle name of the person
last name of the person
type of identity used
ssn, passport, other - if id_type is ssn, id_number must be full SSN
- if id_type is passport, id_number must be passport number
- if id_type is other, id_number must be unique number of the id
id_number must be unique, as in, you cannot use the same id_number for two different persons
date of birth of the person (YYYY-MM-DD)
phone number of the person (E.164, max 16 chars, starts with +)
email of the person
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
unique id of the KYC
status of the KYC
pass, fail, review, not_started sub account holder verification method. It could be an external vendor(Ex: alloy) or Solid
url to the person or business verification result. It could be a link to the external vendor or Solid
unique id of the IDV
status of the IDV
pass, fail, review, not_started sub account holder IDV method. It could be an external vendor(Ex: plaid) or Solid
url to the identity verification result. It could be a link to the external vendor or Solid
legal name of the business
doing business as
entity type of the business
sole_proprietor, single_member_llc, limited_liability_company, general_partnership, unlisted_corporation, publicly_traded_corporation, association, non_profit, government_organization, revocable_trust, irrevocable_trust, estate, professional_association, limited_partnership, limited_liability_partnership, professional_corporation type of the business identity used
ein, other - if id_type is ssn, id_number must be full SSN
- if id_type is ein, id_number must be ein number
- if id_type is other, id_number must be unique number of the id
id_number must be unique, as in, you cannot use the same id_number for two different businesses
phone number of the business (E.164, max 16 chars, starts with +)
email of the business
date business was formed (YYYY-MM-DD)
line 1 of the address
line 2 of the address (optional)
city of the address
2-Letter US state abbreviation (ex: CA)
2-letter abbreviated country code (ex: US)
postal code
unique id of the KYB
status of the KYB
pass, fail, review, not_started sub account holder verification method. It could be an external vendor(Ex: alloy) or Solid
url to the person or business verification result. It could be a link to the external vendor or Solid
first name of the person
middle name of the person
last name of the person
type of identity used
ssn, passport, other - if id_type is ssn, id_number must be full SSN
- if id_type is passport, id_number must be passport number
- if id_type is other, id_number must be unique number of the id
id_number must be unique, as in, you cannot use the same id_number for two different persons
date of birth of the person (YYYY-MM-DD)
phone number of the person (E.164, max 16 chars, starts with +)
email of the person
line 1 of the address
line 2 of the address (optional)
city of the address
2-Letter US state abbreviation (ex: CA)
2-letter abbreviated country code (ex: US)
postal code
ownership percentage in the business
title of the member in the business
true if this member is the control person of the business
true, false unique id of the KYC
status of the KYC
pass, fail, review, not_started sub account holder verification method. It could be an external vendor(Ex: alloy) or Solid
url to the person or business verification result. It could be a link to the external vendor or Solid
bank account number of the counterparty
ACH routing number of the counterparty's bank
type of the counterparty's bank account
business_checking, business_savings, personal_checking, personal_savings name of counterparty's bank
if the account is verified - true or false
pass, fail, review bank account number of the counterparty
Wire 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
bank account number of the counterparty
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
bank account number of the counterparty
RTP routing number of the counterparty's bank
type of the counterparty's bank account
business_checking, business_savings, personal_checking, personal_savings name of counterparty's bank
if the account is verified
pass, fail, review bank account number of the counterparty
FedNow routing number of the counterparty's bank
type of the counterparty's bank account
business_checking, business_savings, personal_checking, personal_savings name of counterparty's bank
if the account is verified or not
pass, fail, review 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
tokenized card number of counterparty's debit card
last4 of counterparty's debit card
expiration month of counterparty's debit card
expiration year of counterparty's debit card
cvv code of counterparty's debit card
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
if debit pull is enabled or disabled by the debit card issuer
true, false if debit pull is enabled or disabled by the debit card issuer
true, false purpose of counterparty
unique id to cross-reference records with external systems
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": ""}
status of counterparty
pending_activation, activated, suspended, deactivated, locked 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/counterparty \
--header 'api-key: <api-key>'{
"total": 1,
"data": [
{
"value": {
"id": "ctp_8e5541c8a9e50c3af3b0daacf9175130",
"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",
"label": "Development Vendor",
"type": "person",
"person": {
"first_name": "John",
"last_name": "Doe",
"id_type": "ssn",
"id_number": "223902234",
"date_of_birth": "1974-01-25",
"phone": "+19418405843",
"email": "john.doe@gmail.com",
"address": {
"line1": "123 Main St",
"line2": "",
"city": "New York",
"state": "NY",
"country": "US",
"postal_code": "10001"
}
},
"intra_account": {
"sub_account_number": "95483674098723",
"sub_account_id": "sub_cda1e562657c41e553104b10aad3fe70"
},
"ach": {
"account_number": "98324502",
"routing_number": "121042882",
"account_type": "business_checking",
"bank_name": "Wells Fargo",
"verification_status": "pass"
},
"domestic_wire": {
"account_number": "98324502",
"routing_number": "121042882",
"account_type": "business_checking",
"bank_name": "Wells Fargo"
},
"international_wire": {
"account_number": "920020006167511",
"beneficiary_bank": {
"identifier_code": "ICICINBBNRI",
"name": "ICICI Bank",
"address": {
"line1": "256 Main St",
"line2": "",
"city": "Bengaluru",
"state": "KA",
"country": "IN",
"postal_code": "900009"
}
},
"correspondent_bank": {
"identifier_code": "SCBLUS33XXX",
"name": "STANDARD CHARTERED BANK",
"address": {
"line1": "1095 12th Ave",
"line2": "",
"city": "New York",
"state": "NY",
"country": "US",
"postal_code": "10001"
}
}
},
"rtp": {
"account_number": "98324502",
"routing_number": "121042882",
"account_type": "business_checking",
"bank_name": "Wells Fargo",
"verification_status": "pass"
},
"fednow": {
"account_number": "98324502",
"routing_number": "121042882",
"account_type": "business_checking",
"bank_name": "Wells Fargo",
"verification_status": "pass"
},
"check": {
"address": {
"line1": "123 Main St",
"line2": "",
"city": "New York",
"state": "NY",
"country": "US",
"postal_code": "10001"
}
},
"debit_card": {
"card_number": "tok_live_6GVyHuQR7aAjCZivYzLbuP_9990",
"last4": "9990",
"expiry_month": "10",
"expiry_year": "2024",
"cvv": "tok_live_6GVyHuQR7aAjCZivYzLbuP_9990",
"address": {
"line1": "123 Main St",
"line2": "",
"city": "New York",
"state": "NY",
"country": "US",
"postal_code": "10001"
},
"pull_enabled": true,
"push_enabled": true
},
"purpose": "Offshore dev center",
"external_reference_id": "TW-9L1L2-UVV",
"ofac": {
"status": "pass",
"last_updated_at": "2024-04-01T21:00:00Z"
},
"attachments": [
{
"label": "Dev Contract",
"id": "att_a8d2b191fa0e960d8e49a4bfd320e07b",
"created_at": "2024-04-01T21:00:00Z"
}
],
"metadata": {
"vendor_id": "VID-0987ACR"
},
"status": "activated",
"timestamps": {
"created_at": "2024-04-01T21:00:00Z",
"updated_at": "2024-04-01T21:00:00Z"
}
}
}
],
"has_more": "true",
"starting_after": "Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky",
"ending_before": "Y2xpXzAxOGY4NjEzMDEyYjdlNTFiOTZjNmVlYWJiNmRiZTky"
}