{
"status": "active",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "counterparty",
"name": "Acme Sandbox Ltd.",
"entity_type": "business",
"physical_address": {
"line_1": "548 Market St",
"line_2": "Apartment 4B",
"city": "San Francisco",
"postal_code": "94103",
"state": "CA",
"country_code": "US"
},
"financial_address": {
"type": "aba",
"routing_number": "110000000",
"account_number": "000123456789",
"account_holder_name": "Acme Sandbox Ltd.",
"account_type": "checking"
},
"date_of_birth": "1990-01-15",
"phone": "+55 11 91234 5678",
"email": "finance@example.com",
"legal_id": "12.345.678/0001-95",
"is_self_owned": false,
"blocked": false,
"metadata": {
"invoice_id": "INV-2026-0042"
}
}The counterparty object
A saved beneficiary: name, address and the financial address that payouts are sent to.
aba for ACH and Fedwire, iban for SEPA in EUR and SWIFT in USD, bic for SWIFT in USD, sort_code for Faster Payments, and crypto_wallet for its blockchain. See Financial address types.
SWIFT payouts also need a physical_address with line 1, city, postal code and country. A counterparty without one cannot be paid by SWIFT. See Counterparty details.Counterparty lifecycle status. Blocking is separate.
pending, active, rejected "active"
Unique identifier of the counterparty.
Resource type discriminator.
counterparty Name of the counterparty, or null if not recorded.
"Acme Sandbox Ltd."
Classification of the counterparty.
business, individual, non_profit, sole_proprietor "business"
Physical address of the counterparty, or null if not recorded.
Show child attributes
Show child attributes
Financial address of the counterparty.
- ABA
- IBAN
- UK Sort Code
- BIC
- Wallet
Show child attributes
Show child attributes
{
"type": "aba",
"routing_number": "110000000",
"account_number": "000123456789",
"account_holder_name": "Acme Sandbox Ltd.",
"account_type": "checking"
}
Date of birth in YYYY-MM-DD format, or null if not recorded.
"1990-01-15"
Phone number of the counterparty, or null if not recorded.
"+55 11 91234 5678"
Email address of the counterparty, or null if not recorded.
"finance@example.com"
National tax or identity number of the counterparty, or null if not recorded.
"12.345.678/0001-95"
Whether the counterparty is self-owned. false if the counterparty is not owned by you, true if it is.
false
Whether payments to or from this counterparty are currently blocked.
false
Set of up to 50 key-value string pairs you can attach to store structured information, such as correlating this resource with an object in your own system. Keys may be up to 40 characters and values up to 500 characters.
Show child attributes
Show child attributes
{ "invoice_id": "INV-2026-0042" }
Was this page helpful?