Create a Counterparty or Transfer recipient

Creates a new recipient counterparty for the authenticated user or entity.

curl --request POST \
  --url https://api.nuvion.tech/recipient-counterparties \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
  },
  "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"
  }
}
'

{
  "message": "Recipient counterparty created successfully",
  "status": 201,
  "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"
  }
}

POST

recipient-counterparties

Creates a new recipient counterparty for the authenticated user or entity.

curl --request POST \
  --url https://api.nuvion.tech/recipient-counterparties \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
  },
  "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"
  }
}
'

{
  "message": "Recipient counterparty created successfully",
  "status": 201,
  "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"
  }
}

Headers

Authorization

string

required

Authorization header: Bearer {jwt or Secretkey}

Body

application/json

type

string

required

The type of counterparty being created

entity_relationship

string

required

The relationship between the entity and the counterparty

name

string

required

The name of the counterparty

string

required

The email address of the counterparty

address

object

required

The address information of the counterparty

Show child attributes

address.city

string

required

The city part of the address

address.state

string

required

The state or province part of the address

address.postal_code

string

required

The postal or zip code part of the address

address.country_code

string

required

The country code part of the address

address.line_1

string

required

The first line of the address

address.line_2

string

The second line of the address (optional)

address.line_3

string

The third line of the address (optional)

account_details

object

The bank account or payment details for the counterparty

Show child attributes

account_details.issuer

object

Information about the bank or financial institution

Show child attributes

account_details.issuer.code

string

The code of the financial institution

account_details.issuer.name

string

The full name of the financial institution

account_details.issuer.short_name

string

The abbreviated name of the financial institution

account_details.account_number

string

The account number for the counterparty

account_details.routing_number

string

The routing number for the bank

account_details.account_type

string

The type of bank account

account_details.country

string

The country where the account is located

account_details.payment_rails

string

The payment system to be used

Response

Created successfully

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

Contains the created counterparty details

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

required

Preferred method of contact

data.created_at

string

required

Timestamp when the counterparty was created

data.updated_at

string

required

Timestamp when the counterparty was last updated

Retrieve an Account Number List Counterparties

⌘I

Business Entities

Individual Entities

Entities

Documents

Entity Documents

Accounts

Accounts Details

Counterparties

Counterparty Lookup

Bank Transfers

Mobile Money Transfers

Issuers

Create a Counterparty or Transfer recipient

Headers

Body

Response