Collect Object

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

Object Structure

{
  "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"
}
}
{
  "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"
  }
}

Object Parameters

Collect

FieldSubfieldTypeDescription
amountnumberThe total amount of the collect transaction.
balance_transactionstringThe ID of the balance transaction associated with this collect.
created_atstring (ISO timestamp)The timestamp when the collect transaction was created.
currencystringThe transaction currency (e.g., SGD).
destinationstringThe destination ID for the collected funds.
destination_detailsobjectDetails about the destination account where the funds are collected. Destination details Object.
holding_currencystringThe holding currency used for the transaction.
idstringThe unique Tazapay identifier for the collect transaction.
metadataobjectSet of key-value pairs attached to the transaction.
objectstringThe type of object, which is "collect".
on_behalf_ofstringThe party on whose behalf the funds are collected, if applicable.
payer_detailsobjectDetails about the payer who initiated the transfer. Payer Details Object
statusstringThe current status of the collect transaction (e.g., succeeded).
tracking_detailsobjectTracking details for the transaction, if available.
transaction_hashstringTransaction hash for a crypto transaction
typestringThe type of payment method used (e.g., wire_transfer).