List Counterparties

Retrieves a list of recipient counterparties for the authenticated user or entity.

curl --request GET \
  --url https://api.nuvion.tech/recipient-counterparties \
  --header 'Authorization: <authorization>'

{
  "message": "Recipient counterparties retrieved successfully",
  "status": 200,
  "data": [
    {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F3",
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "type": "individual",
      "entity_relationship": "customer",
      "name": "John Doe",
      "email": "[email protected]",
      "address": {
        "city": "New York",
        "state": "NY",
        "postal_code": "10001",
        "country_code": "US",
        "line_1": "123 Main St",
        "line_2": "Apt 4B",
        "line_3": null
      },
      "account_details": {
        "issuer": {
          "code": "CHASE",
          "name": "JPMorgan Chase Bank",
          "short_name": "Chase"
        },
        "account_number": "1234567890",
        "routing_number": "021000021",
        "account_type": "checking",
        "country": "US",
        "payment_rails": "ach"
      },
      "meta": {
        "preferred_contact_method": "email"
      },
      "created_at": "2025-09-12T08:00:00.000Z",
      "updated_at": "2025-09-12T08:00:00.000Z"
    },
    {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6",
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "type": "business",
      "entity_relationship": "vendor",
      "name": "Acme Corporation",
      "email": "[email protected]",
      "address": {
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94105",
        "country_code": "US",
        "line_1": "555 Market St",
        "line_2": "Suite 1000",
        "line_3": null
      },
      "account_details": {
        "issuer": {
          "code": "BOFA",
          "name": "Bank of America",
          "short_name": "BofA"
        },
        "account_number": "9876543210",
        "routing_number": "026009593",
        "account_type": "checking",
        "country": "US",
        "payment_rails": "ach"
      },
      "meta": {
        "tax_id": "123456789"
      },
      "created_at": "2025-09-10T15:30:00.000Z",
      "updated_at": "2025-09-10T15:30:00.000Z"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 20,
      "total_count": 2,
      "has_next": false,
      "has_previous": false,
      "next_cursor": null
    },
    "filters_applied": {
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "type": null,
      "search": null,
      "sort": "created_desc"
    }
  }
}

GET

recipient-counterparties

Retrieves a list of recipient counterparties for the authenticated user or entity.

curl --request GET \
  --url https://api.nuvion.tech/recipient-counterparties \
  --header 'Authorization: <authorization>'

{
  "message": "Recipient counterparties retrieved successfully",
  "status": 200,
  "data": [
    {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F3",
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "type": "individual",
      "entity_relationship": "customer",
      "name": "John Doe",
      "email": "[email protected]",
      "address": {
        "city": "New York",
        "state": "NY",
        "postal_code": "10001",
        "country_code": "US",
        "line_1": "123 Main St",
        "line_2": "Apt 4B",
        "line_3": null
      },
      "account_details": {
        "issuer": {
          "code": "CHASE",
          "name": "JPMorgan Chase Bank",
          "short_name": "Chase"
        },
        "account_number": "1234567890",
        "routing_number": "021000021",
        "account_type": "checking",
        "country": "US",
        "payment_rails": "ach"
      },
      "meta": {
        "preferred_contact_method": "email"
      },
      "created_at": "2025-09-12T08:00:00.000Z",
      "updated_at": "2025-09-12T08:00:00.000Z"
    },
    {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6",
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "type": "business",
      "entity_relationship": "vendor",
      "name": "Acme Corporation",
      "email": "[email protected]",
      "address": {
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94105",
        "country_code": "US",
        "line_1": "555 Market St",
        "line_2": "Suite 1000",
        "line_3": null
      },
      "account_details": {
        "issuer": {
          "code": "BOFA",
          "name": "Bank of America",
          "short_name": "BofA"
        },
        "account_number": "9876543210",
        "routing_number": "026009593",
        "account_type": "checking",
        "country": "US",
        "payment_rails": "ach"
      },
      "meta": {
        "tax_id": "123456789"
      },
      "created_at": "2025-09-10T15:30:00.000Z",
      "updated_at": "2025-09-10T15:30:00.000Z"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 20,
      "total_count": 2,
      "has_next": false,
      "has_previous": false,
      "next_cursor": null
    },
    "filters_applied": {
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "type": null,
      "search": null,
      "sort": "created_desc"
    }
  }
}

Headers

Authorization

string

required

Authorization header: Bearer {jwt or Secretkey}

Query Parameters

type

string

Filter counterparties by type

created_from

number

Filter counterparties created on or after this timestamp (Unix epoch in milliseconds)

created_to

number

Filter counterparties created on or before this timestamp (Unix epoch in milliseconds)

limit

number

Number of results to return per page

cursor

string

Cursor for pagination (the ID of the last item in the previous page)

sort

string

Sort direction for results

string

Search term to filter counterparties by name, email, or account number

Response

Successful operation

message

string

required

A descriptive message indicating the result of the operation

status

string

required

The status of the API operation (successful, error, failed, pending)

data

object

required

Array of counterparties

Show child attributes

data.id

string

required

Unique identifier for the counterparty

data.entity_id

string

required

Identifier of the entity the counterparty belongs to

data.type

string

required

The type of counterparty

data.entity_relationship

string

required

Relationship between the entity and counterparty

data.name

string

required

Name of the counterparty

data.email

string

required

Email address of the counterparty

data.address

object

required

Physical address of the counterparty

Show child attributes

data.address.city

string

required

City name

data.address.state

string

required

State or province code

data.address.postal_code

string

required

Postal or ZIP code

data.address.country_code

string

required

ISO country code

data.address.line_1

string

required

First line of address

data.address.line_2

string

Second line of address

data.address.line_3

string

Third line of address

data.account_details

object

required

Banking details of the counterparty

Show child attributes

data.account_details.issuer

object

required

Bank or financial institution details

Show child attributes

data.account_details.issuer.code

string

required

Unique code of the financial institution

data.account_details.issuer.name

string

required

Full name of the financial institution

data.account_details.issuer.short_name

string

required

Abbreviated name of the financial institution

data.account_details.account_number

string

required

Account number at the financial institution

data.account_details.routing_number

string

required

Bank routing number

data.account_details.account_type

string

required

Type of bank account

data.account_details.country

string

required

Country code where the account is located

data.account_details.payment_rails

string

required

Payment network type

data.meta

object

required

Additional metadata for the counterparty

Show child attributes

data.meta.preferred_contact_method

string

Preferred method of contact

data.meta.tax_id

string

Tax identification number

data.created_at

string

required

Timestamp when the counterparty was created

data.updated_at

string

required

Timestamp when the counterparty was last updated

Business Entities

Individual Entities

Entities

Documents

Entity Documents

Accounts

Accounts Details

Counterparties

Counterparty Lookup

Bank Transfers

Mobile Money Transfers

Issuers

List Counterparties

Headers

Query Parameters

Response