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

# Collect

> Collects represent incoming payments to your global collection accounts. A collect is created whenever there is a credit in the collection accounts.

## Object Structure

<CodeGroup>
  ```json Fiat Collect expandable theme={null}
  {
    "amount": 12829,
    "balance_transaction": "btr_u7ftrgipu69og2qj1j1pg",
    "created_at": "2027-08-15T03:43:46.980214Z",
    "currency": "SGD",
    "destination": "cva_d2dgk0ka772psfuj1he0",
    "destination_details": {
      "type": "virtual_account",
      "virtual_account": {
        "account_holder_name": "OM Grand Limited",
        "account_number": "0109866363",
        "bank_address": {
                "address_line_1": "",
                "address_line_2": "",
                "city": "",
                "country": "Singapore",
                "postal_code": "",
                "state": ""
              },
        "bank_branch": "8 MARINA BOULEVARD, 27-01, MARINA BAY FINANCIAL CENTRE",
        "bank_codes": {
                "swift_code": "SLSGO2XXX"
              },
        "bank_name": "STANDARD BANK LIMITED",
        "currencies": [
                "SGD"
              ],
        "iban": "",
        "id": "cva_d2dgk0552psfuj1he0",
        "object": "virtual_account"
      }
    },
    "holding_currency": "SGD",
    "id": "col_d2fapsh76og2qj0ej5g",
    "metadata": {},
    "object": "collect",
    "on_behalf_of": "",
    "payer_details": {
      "additional_information": "CM Payment for Order 56",
      "name": "CMC COMPANY",
      "payer_bank": {
        "account_number": "1112019837840",
        "address": null,
        "bank_codes": {
                "swift_code": "AJUM7CHBKXXX"
              },
        "name": "C Bank"
      },
      "reference_id": ""
    },
    "status": "succeeded",
    "tracking_details": null,
    "type": "wire_transfer"
  }
  }
  ```

  ```json Crypto Collect expandable theme={null}
  {
    "status": "success",
    "message": "",
    "data": {
      "amount": 480000,
      "balance_transaction": "btr_d35s1lt7gtugq24427g",
      "created_at": "2025-09-18T08:20:33.090433Z",
      "currency": "USD",
      "destination": "cwa_jhrv4sad4tf55jrvp0",
      "destination_details": {
        "type": "wallet",
        "wallet": {
          "currencies": [
            "USD"
          ],
          "deposit_address": "0x5gtj035ad25fnhioerfujhguri587y43894hfie2",
          "id": "cwa_jhrv4sad4tf55jrvp0",
          "object": "wallet",
          "type": "polygon pos"
        }
      },
      "holding_currency": "USD",
      "id": "col_24rtg5gtugq2t3h0bg",
      "metadata": {},
      "object": "collect",
      "on_behalf_of": "",
      "payer_details": {
        "additional_information": "",
        "name": "",
        "payer_bank": null,
        "payer_wallet": {
          "deposit_address": "0x48eb007deaebafmerdogn8470rjm32afa",
          "type": "ethereum"
        },
        "reference_id": ""
      },
      "status": "succeeded",
      "tracking_details": {
        "transaction_hash": "0x444b716efrg4b2a23224tf4gcedc91024f25c5bbb0530e99f09930769a"
      },
      "type": "stablecoin_usdc"
    }
  }
  ```

  ```json Crypto Collect (Detected) expandable theme={null}
  {
    "status": "success",
    "message": "",
    "data": {
      "amount": 1000,
      "balance_transaction": "",
      "created_at": "2025-02-21T12:29:09.412049Z",
      "currency": "USD",
      "destination": "cwa_cuivfrvkk61qlul7c8g0",
      "destination_details": {
        "type": "wallet",
        "wallet": {
          "currencies": [
            "USD"
          ],
          "deposit_address": "wead",
          "id": "cwa_cuivfrvkk61qlul7c8g0",
          "object": "wallet",
          "type": "ethereum"
        }
      },
      "holding_currency": "USD",
      "id": "col_cus735e5ainf6ati9dlg",
      "metadata": {},
      "object": "collect",
      "on_behalf_of": "",
      "payer_details": {
        "additional_information": "",
        "name": "",
        "payer_bank": null,
        "payer_wallet": {
          "deposit_address": "addrss23423423",
          "type": "Ethereum"
        },
        "reference_id": ""
      },
      "status": "detected",
      "tracking_details": {
        "transaction_hash": "fhjkdfi9823720@#"
      },
      "type": "stablecoin_usdc"
    }
  }
  ```
</CodeGroup>

## Object Parameters

| Collect              | Field             | Subfield               | Type                                                                                                                                                                                     | Description |
| :------------------- | :---------------- | :--------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------- |
| amount               |                   | number                 | The total amount of the collect transaction.                                                                                                                                             |             |
| balance\_transaction |                   | string                 | The ID of the balance transaction associated with this collect.                                                                                                                          |             |
| created\_at          |                   | string (ISO timestamp) | The timestamp when the collect transaction was created.                                                                                                                                  |             |
| currency             |                   | string                 | The transaction currency (e.g., SGD).                                                                                                                                                    |             |
| destination          |                   | string                 | The destination ID for the collected funds.                                                                                                                                              |             |
| destination\_details |                   | object                 | Details about the destination account where the funds are collected. [Destination details Object.](/reference/collect-object#destination-details---virtual-account)                      |             |
| holding\_currency    |                   | string                 | The holding currency used for the transaction.                                                                                                                                           |             |
| id                   |                   | string                 | The unique Tazapay identifier for the collect transaction.                                                                                                                               |             |
| metadata             |                   | object                 | Set of key-value pairs attached to the transaction.                                                                                                                                      |             |
| object               |                   | string                 | The type of object, which is "collect".                                                                                                                                                  |             |
| on\_behalf\_of       |                   | string                 | The party on whose behalf the funds are collected, if applicable.                                                                                                                        |             |
| payer\_details       |                   | object                 | Details about the payer who initiated the transfer. [Payer Details Object](/reference/collect-object#payer-details)                                                                      |             |
| status               |                   | string                 | The current status of the collect transaction. Possible values: `detected`, `on_hold`, `succeeded`, `failed`. The `detected` status applies to crypto (stablecoin wallet) collects only. |             |
| tracking\_details    |                   | object                 | Tracking details for the transaction, if available.                                                                                                                                      |             |
|                      | transaction\_hash | string                 | Transaction hash for a crypto transaction                                                                                                                                                |             |
| type                 |                   | string                 | The type of payment method used (e.g., wire\_transfer).                                                                                                                                  |             |

## Destination Details - Virtual Account

| Field                 | Type   | Description                                           |
| :-------------------- | :----- | :---------------------------------------------------- |
| account\_holder\_name | string | The name of the virtual account holder.               |
| account\_number       | string | The account number for the virtual account.           |
| bank\_address         | object | The bank’s address details. (See Bank Address Table). |
| bank\_branch          | string | The branch address of the bank.                       |
| bank\_codes           | object | The bank codes associated with the bank.              |
| bank\_name            | string | The name of the bank.                                 |
| currencies            | array  | The list of currencies supported by the account.      |
| iban                  | string | The IBAN of the account, if applicable.               |
| id                    | string | The unique identifier of the virtual account.         |
| object                | string | The type of object, which is "virtual\_account".      |

### Bank Address

| Field            | Type   | Description                                  |
| :--------------- | :----- | :------------------------------------------- |
| address\_line\_1 | string | The first line of the bank’s address.        |
| address\_line\_2 | string | The second line of the bank’s address.       |
| city             | string | The city where the bank is located.          |
| country          | string | The country where the bank is located.       |
| postal\_code     | string | The postal code of the bank’s address.       |
| state            | string | The state or province of the bank’s address. |

## Destination Details - Wallet

| Field            | Type   | Description                                     |
| :--------------- | :----- | :---------------------------------------------- |
| id               | string | The unique identifier of the wallet.            |
| type             | string | The blockchain or wallet type (e.g., ethereum). |
| deposit\_address | string | The deposit address of the wallet.              |
| currencies       | array  | The list of currencies supported by the wallet. |

## Payer Details

| Field                   | Type   | Description                                                         |
| :---------------------- | :----- | :------------------------------------------------------------------ |
| additional\_information | string | Additional information about the payment (e.g., payment reference). |
| name                    | string | Name of the payer.                                                  |
| payer\_bank             | object | Payer’s bank details (See Payer Bank Table).                        |
| reference\_id           | string | Reference identifier for the payer’s transaction.                   |
| payer\_wallet           | object | Payer's wallet details (See Payer's wallet table)                   |

### Payer Bank

| Field           | Type        | Description                            |
| :-------------- | :---------- | :------------------------------------- |
| account\_number | string      | The payer’s bank account number.       |
| address         | object/null | The payer’s bank address, if provided. |
| bank\_codes     | object      | The payer’s bank codes.                |
| name            | string      | The payer’s bank name.                 |

### Payer Wallet

| id               | string | The unique identifier of the wallet.            |
| :--------------- | :----- | :---------------------------------------------- |
| type             | string | The blockchain or wallet type (e.g., ethereum). |
| deposit\_address | string | The deposit address of the wallet.              |
