The Counterparties API allows for the seamless management of entities that can receive payments. This includes the ability to create, retrieve, list, and disable counterparties, ensuring that payment processes are efficient and secure. The API supports multiple payment methods, including ACH, SWIFT, and FEDWIRE, providing flexibility and global reach.

Core Features

Create Counterparty

Easily add new counterparties for receiving payments by providing detailed information such as name, description, type, and payment network. This ensures that each counterparty is properly configured to receive funds through the desired payment method.

Retrieve Counterparty

Access detailed information about a specific counterparty using its unique identifier. This allows for quick verification and management of counterparty details, ensuring that all necessary information is up-to-date and accurate.

List Counterparties

Retrieve a comprehensive list of all counterparties under your account with support for pagination. This feature is essential for managing large numbers of counterparties, providing a clear overview of all entities configured to receive payments.

Disable Counterparty

Temporarily or permanently disable a counterparty to prevent further transactions. This is crucial for maintaining control over your payment network and ensuring that only authorized counterparties can receive funds.

Payment Methods

ACH (Automated Clearing House)

ACH payments are used for domestic transfers within the United States. This method is ideal for cost-effective and reliable transactions, making it suitable for routine payments such as payroll, vendor payments, and more.

SWIFT

SWIFT (Society for Worldwide Interbank Financial Telecommunication) enables international payments. This method is essential for global transactions, offering a secure and standardized way to transfer funds across borders.

FEDWIRE

FEDWIRE is used for real-time gross settlement of domestic transfers within the United States. It is suitable for large-value payments that require immediate settlement, providing a high level of security and reliability.

Safe and Secure

Data Encryption

All data transmitted through the API is encrypted using industry-standard protocols, ensuring that sensitive information is protected from unauthorized access.

Authentication and Authorization

The API employs robust authentication and authorization mechanisms to ensure that only authorized users can access and manage counterparty information. This includes the use of API keys and OAuth tokens.

Compliance

The Counterparties API is designed to comply with regulatory standards, ensuring that all transactions meet the necessary legal and financial requirements.

Subaccount Integration

Integrators can pass an additional header called x-subaccount-id when making API calls on behalf of subaccounts created as part of the Enterprise flow. This allows for streamlined management and operation of subaccounts, ensuring that all transactions and interactions are accurately attributed to the correct subaccount.