Skip Navigation
Log In Sign Up

Recipient Object

·

The Recipient object represents a payment destination in the Tupel system. Recipients are used to specify where funds should be disbursed for loans and other financial transactions.

Attributes

  • uid string
    Unique identifier for the recipient.

  • entity object
    The Entity object representing the organization associated with this recipient.

  • type string
    The type of account. Possible values: CHECKING, SAVINGS, CURRENT.

  • recipient_type string
    The type of recipient. Possible values: BUSINESS, PRIVATE.

  • owner string
    The name of the account owner. Maximum length: 100 characters.

  • currency string
    Three-letter ISO currency code of the account which can be any of the accepted currency codes. Maximum length: 3 characters. Example: USD.

  • bank_code nullable string
    Bank identifier code. Maximum length: 15 characters.

  • branch_code nullable string
    Branch identifier code. Maximum length: 15 characters.

  • account_number string
    The recipient's account number. Maximum length: 45 characters.

  • is_owned boolean
    Whether the recipient account is owned by the same entity. Default: true.

  • email string
    Contact email for the recipient. Maximum length: 128 characters.

  • created_at timestamp
    Time at which the recipient was created.

  • updated_at timestamp
    Time at which the recipient was last updated.

Recipient Types

Recipients can be categorized as:

  • BUSINESS - A business account
  • PRIVATE - A personal/private account

Account Types

Tupel supports the following account types:

  • CHECKING - Checking account (primarily used in the US)
  • SAVINGS - Savings account
  • CURRENT - Current account (primarily used in the UK and Europe)

Bank Information

The recipient object includes several fields to identify the banking details:

  • bank_code - The identifier for the bank (such as routing number in the US)
  • branch_code - The identifier for the specific branch (if applicable)
  • account_number - The actual account number

Different banking systems across jurisdictions may use these fields differently. For currency specific validation rules you should refer to our validation rule endpoint.

Recipient Operations

The API provides several endpoints for managing recipients:

  • Create a Recipient - Create a new recipient with all its information
  • Get a Specific Recipient - Retrieve a single recipient by its UID
  • List All Recipients - Retrieve a paginated list of recipients with filtering options
  • Recipient Validation - Recipient validation rules for all supported currencies

For detailed information about these operations, refer to the Recipients documentation.

Example Recipient Object

{
  "uid": "Ab3D9f2c",
  "entity": {
    "uid": "7Ba9c2E4f",
    "name": "Acme Corporation",
    "jurisdiction": "US",
    "incorporated_at": "2018-05-12",
    "status": "ACTIVE",
    "type": "LTD",
    "registration_number": "US12345678",
    "tax_number": "987654321",
    "email": "finance@acmecorp.com",
    "created_at": "2023-01-15T14:32:17Z",
    "updated_at": "2023-01-15T14:32:17Z"
  },
  "type": "CHECKING",
  "recipient_type": "BUSINESS",
  "owner": "Acme Corporation",
  "currency": "USD",
  "bank_code": "021000021",
  "branch_code": null,
  "account_number": "9876543210",
  "is_owned": true,
  "email": "finance@acmecorp.com",
  "created_at": "2023-01-20T09:15:23Z",
  "updated_at": "2023-01-20T09:15:23Z"
}

Using Recipients

Recipients are primarily used when creating loans to specify where the funds should be disbursed:

{
  "entity": "7Ba9c2E4f",
  "currency": "USD",
  "principal": "50000.00",
  "pay_at": "2023-04-01T12:00:00Z",
  "due_at": "2023-10-01T23:59:59Z",
  "recipient": "Ab3D9f2c",
  "payment_method": "2qP3oN4m"
}

When a loan is disbursed, the funds are sent to the specified recipient account.