Adding counterparties

A counterparty is a record of a business that a user sends money to or receives money from outside their own accounts. Registering one gives Fuze the identity and destination details it needs to screen a transaction before funds move. See Counter Parties for the full data model.

Counterparty types

SELF - the counterparty is the business's own account elsewhere, such as an account held at another bank or a wallet the business controls.
THIRD_PARTY - a different business entirely, such as a supplier, vendor, or partner business.

For example:

{
  "code": 200,
  "error": null,
  "data": {
    "orgUserId": "sherlock_holmes",
    "counterPartyId": "john_watson",
    "name": "John Watson",
    "email": "[email protected]",
    "type": "THIRD_PARTY", //SELF or THIRD_PARTY
    "status": "ACTIVE",
    "createdAt": "2023-10-01T00:00:00Z",
    "updatedAt": "2023-10-01T00:00:00Z",
    "address": {
      "addressLine1": "221B Baker St",
      "addressLine2": "London",
      "city": "London",
      "state": "Greater London",
      "country": "GB",
      "postalCode": "NW1 6XE"
    }
  }
}

Why register counterparties

Registering counterparties up front improves compliance screening, lets you reuse a saved destination across many payments, and keeps reconciliation consistent even if account details change later.

Managing counterparties

Call Create counter-party with the owning orgUserId, a counterPartyId, and a type, then attach a destination by linking it to an external account or wallet. Manage it going forward with Get counter-party, List counter-parties, or Delete counter-party.