Documentation Index
Fetch the complete documentation index at: https://docs.conduit.financial/llms.txt
Use this file to discover all available pages before exploring further.
This guide walks you through creating your first counterparty and adding their payment methods.
Pre-requisites
- Active Conduit account with API access.
- API credentials (API Key and Secret).
- Completed onboarding for your first customer as shown in our Onboarding Your First Customer guide.
- You have reviewed our Counterparties Core Concepts.
Create a counterparty
Request Example
curl --request POST \
--url https://api.conduit.financial/counterparties \
--header "X-API-Key: your_api_key" \
--header "X-API-Secret: your_api_secret" \
--header "Content-Type: application/json" \
--header "Api-Version: 2024-12-01" \
--data '{
"type": "business",
"businessName": "Office Supplies Inc.",
"website": "https://officesupplies.com",
"address": {
"streetLine1": "123 Vendor Street",
"streetLine2": "Suite 500",
"city": "Los Angeles",
"state": "CA",
"postalCode": "90001",
"country": "USA"
},
"email": "[email protected]",
"phone": "+13105551234",
"identificationType": "tin",
"identificationNumber": "98-7654321",
"customerId": "cus_30V7EQpemfcgMctQUjDKf1sQLtA",
"paymentMethods": [
{
"type": "bank",
"accountOwnerName": "Office Supplies Inc.",
"bankName": "Chase Bank",
"currency": "USD",
"rail": ["ach"],
"routingNumber": "123456789",
"accountNumber": "98765432101234",
"accountType": "checking",
"address": {
"country": "USA"
}
}
]
}'
Response Example
{
"id": "cpty_2nqjHpNLK6wSNlFyMvZgX8SYeAO",
"type": "business",
"businessName": "Office Supplies Inc.",
"email": "[email protected]",
"phone": "+13105551234",
"website": "https://officesupplies.com",
"customerId": "cus_30V7EQpemfcgMctQUjDKf1sQLtA",
"identificationType": "tin",
"identificationNumber": "98-7654321",
"address": {
"streetLine1": "123 Vendor Street",
"streetLine2": "Suite 500",
"city": "Los Angeles",
"state": "CA",
"postalCode": "90001",
"country": "USA"
},
"paymentMethods": [
{
"id": "bank_1234",
"type": "bank",
"rail": ["ach"],
"bankName": "Chase Bank",
"accountType": "checking",
"accountOwnerName": "Office Supplies Inc.",
"accountNumber": "98765432101234",
"routingNumber": "123456789",
"currency": "USD",
"address": {
"country": "USA"
}
}
],
"status": "active",
"createdAt": "2024-01-01T10:00:00.000Z",
"updatedAt": "2024-02-15T15:45:00.000Z"
}
Summary
You have successfully created your first counterparty. They must be verified before they can send or receive funds. Use webhooks to track their verification status.
What’s next?
API Reference
See the API Reference to view request/response schemas and available fields.
Support
Reach out to our support team to get help and share your feedback.
