Create a Counterparty
How to create a Counterparty
This guide details the various methods for creating a Counterparty.
TAB-API
Pre-Requisites
- Organization ID: Found in your developer settings
- API Key: Found in API Keys in your developer settings
1. Collect Counterparty details
You may already have the Counterparty details, having collected them perhaps in your own UI or other means. Once these details are collected, you will create a Counterparty using the API.
2. Create Counterparty
Creating a Counterparty without an account
If you do not know your Counterparty's account information, you can still create a counterparty record and add an account later.
{
"name": "Kenner, Bach & Ledeen",
"email": "[email protected]"
}
{
"id": "74a11899-d0fc-42d2-8a53-0c382d1ec74b",
"object": "counterparty",
"live_mode": false,
"name": "Kenner, Bach & Ledeen",
"email": "[email protected]",
"send_remittance_advice": false,
"verification_status": "unverified",
"legal_entity_id": null,
"metadata": {},
"accounts": [],
"discarded_at": null,
"created_at": "2024-04-25T23:59:44Z",
"updated_at": "2024-04-25T23:59:44Z"
}
Creating a Counterparty with an account
The following request will create a counterparty with just a name and a single account.
{
"name": "Kenner, Bach & Ledeen",
"accounts": [
{
"account_details": [
{
"account_number": "123456789"
}
],
"routing_details": [
{
"routing_number": "026009593",
"routing_number_type": "aba"
}
]
}
]
}
{
"id": "37ab9632-642b-40cc-8771-80b38b8ede83",
"object": "counterparty",
"live_mode": false,
"name": "Kenner, Bach & Ledeen",
"email": null,
"send_remittance_advice": false,
"verification_status": "unverified",
"legal_entity_id": null,
"metadata": {},
"accounts": [
{
"id": "b99b3d43-a431-4f2f-838f-92d6b289fdfa",
"object": "external_account",
"live_mode": false,
"account_type": "other",
"party_name": "Kenner, Bach & Ledeen",
"party_type": null,
"party_address": null,
"account_details": [
{
"id": "3ca53c69-e06d-4a6a-818a-0c680744dd3f",
"object": "account_detail",
"live_mode": false,
"account_number": "123456789",
"account_number_safe": "6789",
"account_number_type": "other",
"discarded_at": null,
"created_at": "2024-04-26T00:11:02Z",
"updated_at": "2024-04-26T00:11:02Z"
}
],
"routing_details": [
{
"id": "32e17572-cb4a-49d0-8631-c6542fcc203a",
"object": "routing_detail",
"live_mode": false,
"payment_type": null,
"routing_number": "026009593",
"routing_number_type": "aba",
"bank_name": "Bank of America National Association",
"bank_address": {
"id": "882bb03d-dd51-4a97-92cc-032d7326e3f8",
"object": "address",
"live_mode": false,
"line1": "115 W 42nd St",
"line2": "One Bryant Park",
"locality": "New York",
"region": "NY",
"postal_code": "10036",
"country": "US",
"created_at": "2024-04-26T00:11:02Z",
"updated_at": "2024-04-26T00:11:02Z"
},
"discarded_at": null,
"created_at": "2024-04-26T00:11:02Z",
"updated_at": "2024-04-26T00:11:02Z"
}
],
"name": null,
"metadata": {},
"verification_status": "unverified",
"contact_details": [],
"ledger_account_id": null,
"discarded_at": null,
"created_at": "2024-04-26T00:11:02Z",
"updated_at": "2024-04-26T00:11:02Z"
}
],
"discarded_at": null,
"created_at": "2024-04-26T00:11:02Z",
"updated_at": "2024-04-26T00:11:02Z"
}
For more examples, see the section on Counterparty Example Requests .
TAB-Dashboard
How to create a Counterparty
- Log in to Modern Treasury
- Navigate to Counterparties
- Click “Create New” and select “Counterparty”
- Complete the form with the Counterparty's information
- Required fields:
- Counterparty Name
- Optional Fields:
- Email: required for sending notifications, and allows for easier searching
- Bank Account(s)
- Metadata
- Documents
- Required fields:
- Click "Create" to finish creating the Counterparty
Frequently Asked Questions
What do I do if I don't have a Counterparty's bank information?
If you do not already have a Counterparty's bank account information then you can send them an invitation, which prompts them to enter if themselves. You can learn more about how to do this here.
Updated 8 months ago