> ## Documentation Index
> Fetch the complete documentation index at: https://docs.busha.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Recipients Reference

> See the Recipient object.

The Recipient object represents a payment destination with a unified structure across all payment methods. Unused fields are returned as `null`.

<table style={{ width: "100%", borderCollapse: "collapse" }}>
  <thead>
    <tr>
      <th style={{ width: "30%", textAlign: "left", padding: "12px" }}>
        Field
      </th>

      <th style={{ width: "30%", textAlign: "left", padding: "12px" }}>Type</th>

      <th style={{ width: "50%", textAlign: "left", padding: "12px" }}>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td style={{ padding: "12px" }}>
        <code>object</code>
      </td>

      <td style={{ padding: "12px" }}>string</td>
      <td style={{ padding: "12px" }}>Always "recipient"</td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>id</code>
      </td>

      <td style={{ padding: "12px" }}>string (UUID)</td>
      <td style={{ padding: "12px" }}>Unique identifier for the recipient</td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>user\_id</code>
      </td>

      <td style={{ padding: "12px" }}>string (UUID)</td>

      <td style={{ padding: "12px" }}>
        ID of the user who owns this recipient
      </td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>profile\_id</code>
      </td>

      <td style={{ padding: "12px" }}>string (UUID)</td>
      <td style={{ padding: "12px" }}>ID of the associated profile</td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>active</code>
      </td>

      <td style={{ padding: "12px" }}>boolean</td>
      <td style={{ padding: "12px" }}>Whether the recipient is active</td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>owned\_by\_customer</code>
      </td>

      <td style={{ padding: "12px" }}>boolean</td>

      <td style={{ padding: "12px" }}>
        Whether the recipient is owned by the customer
      </td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>created\_at</code>
      </td>

      <td style={{ padding: "12px" }}>string (ISO 8601)</td>
      <td style={{ padding: "12px" }}>When the recipient was created</td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>updated\_at</code>
      </td>

      <td style={{ padding: "12px" }}>string (ISO 8601)</td>
      <td style={{ padding: "12px" }}>When the recipient was last updated</td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>currency\_id</code>
      </td>

      <td style={{ padding: "12px" }}>string</td>

      <td style={{ padding: "12px" }}>
        Currency code (NGN, USD, GBP, KES, BTC, ETH, USDT, XLM, etc.)
      </td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>country\_id</code>
      </td>

      <td style={{ padding: "12px" }}>string</td>

      <td style={{ padding: "12px" }}>
        ISO country code (NG, US, GB, KE, null for crypto)
      </td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>type</code>
      </td>

      <td style={{ padding: "12px" }}>string (enum)</td>

      <td style={{ padding: "12px" }}>
        Specific recipient type (see Types section)
      </td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>category</code>
      </td>

      <td style={{ padding: "12px" }}>string (enum)</td>

      <td style={{ padding: "12px" }}>
        General category: <code>bank</code>, <code>mobile\_money</code>,{" "}
        <code>crypto</code>
      </td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>entity\_type</code>
      </td>

      <td style={{ padding: "12px" }}>string</td>

      <td style={{ padding: "12px" }}>
        Entity type: <code>personal</code> or <code>business</code> (nullable,
        used for US/GB)
      </td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>transfer\_type</code>
      </td>

      <td style={{ padding: "12px" }}>string</td>

      <td style={{ padding: "12px" }}>
        Transfer method: <code>ach</code>, <code>wire</code>, <code>swift</code>{" "}
        (nullable, used for US)
      </td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>account\_name</code>
      </td>

      <td style={{ padding: "12px" }}>string</td>

      <td style={{ padding: "12px" }}>
        Account holder name or wallet label (nullable)
      </td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>bank\_name</code>
      </td>

      <td style={{ padding: "12px" }}>string</td>
      <td style={{ padding: "12px" }}>Name of the bank (nullable)</td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>bank\_code</code>
      </td>

      <td style={{ padding: "12px" }}>string</td>

      <td style={{ padding: "12px" }}>
        Bank code (nullable, used for Nigeria)
      </td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>sort\_code</code>
      </td>

      <td style={{ padding: "12px" }}>string</td>
      <td style={{ padding: "12px" }}>Sort code (nullable, used for UK)</td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>routing\_number</code>
      </td>

      <td style={{ padding: "12px" }}>string</td>

      <td style={{ padding: "12px" }}>
        Routing number (nullable, used for US ACH/Wire)
      </td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>swift\_code</code>
      </td>

      <td style={{ padding: "12px" }}>string</td>

      <td style={{ padding: "12px" }}>
        SWIFT code (nullable, used for international transfers)
      </td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>account\_number</code>
      </td>

      <td style={{ padding: "12px" }}>string</td>
      <td style={{ padding: "12px" }}>Domestic account number (nullable)</td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>iban</code>
      </td>

      <td style={{ padding: "12px" }}>string</td>

      <td style={{ padding: "12px" }}>
        International account number (nullable, used for SWIFT)
      </td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>phone\_number</code>
      </td>

      <td style={{ padding: "12px" }}>string</td>
      <td style={{ padding: "12px" }}>Mobile money phone number (nullable)</td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>network</code>
      </td>

      <td style={{ padding: "12px" }}>string</td>

      <td style={{ padding: "12px" }}>
        Blockchain network (nullable, used for crypto)
      </td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>crypto\_address</code>
      </td>

      <td style={{ padding: "12px" }}>string</td>

      <td style={{ padding: "12px" }}>
        Wallet address (nullable, used for crypto)
      </td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>memo</code>
      </td>

      <td style={{ padding: "12px" }}>string</td>

      <td style={{ padding: "12px" }}>
        Memo/tag for crypto transfers (nullable)
      </td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>recipient\_address</code>
      </td>

      <td style={{ padding: "12px" }}>string</td>

      <td style={{ padding: "12px" }}>
        Recipient address for international transfers (nullable)
      </td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>intermediary\_bank\_name</code>
      </td>

      <td style={{ padding: "12px" }}>string</td>

      <td style={{ padding: "12px" }}>
        Intermediary bank name (nullable, used for SWIFT)
      </td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>intermediary\_bank\_address</code>
      </td>

      <td style={{ padding: "12px" }}>string</td>

      <td style={{ padding: "12px" }}>
        Intermediary bank address (nullable, used for SWIFT)
      </td>
    </tr>

    <tr>
      <td style={{ padding: "12px" }}>
        <code>intermediary\_swift\_code</code>
      </td>

      <td style={{ padding: "12px" }}>string</td>

      <td style={{ padding: "12px" }}>
        Intermediary bank SWIFT code (nullable, used for SWIFT)
      </td>
    </tr>
  </tbody>
</table>