Collect

Following are the collect events for which you will receive webhooks

📘

How can you configure an endpoint on your server to listen to collect event webhooks from Tazapay?

You can drop an email to [email protected] with the required details. The details include your email ID, the business name and the endpoint you would like configured.

Collect status specific events

EventDescriptionDefault (On / Off)
collect.succeededTriggered when the status is succeededOn
collect.failedTriggered when the status is failedOn
collect.on_holdTriggered when the status is on_holdOn

collect.succeeded

{
  "type": "collect.succeeded",
  "id": "evt_cn1m86nnt3hkq7385qd0",
  "object": "event",
  "created_at": "2024-02-07T11:06:02.538953779Z",
  "data": {
    "metadata": {},
    "created_at": "2024-02-07T11:06:00.421853Z",
    "payer_details": {
      "name": "Hrithik Agarwal",
      "payer_bank": {
        "account_number":"9876542321",
        "name":"State Bank of Mars",
        "address":{
          "line1":"Address Line 1",
          "line2":"Address Line 2",
          "city":"City",
          "state":"state",
          "country":"country",
          "postal_code":"postal code"
        },
        "bank_codes":{
          "swift_code":"SBM001"
        }
      },
      "reference_id": "reffffff",
      "additional_information": "Additional Information for the transaction"
    },
    "id": "col_cn1m8651ed8dn2517esg",
    "object": "collect",
    "currency": "USD",
    "status": "succeeded",
    "type": "wire_transfer",
    "destination": "cca_uafanfianknon792nfak",
    "amount": 100000
  }
}

collect.failed

{
  "type": "collect.failed",
  "id": "evt_cn1m86nnt3jbkq7385qd0",
  "object": "event",
  "created_at": "2024-02-07T11:06:02.538953779Z",
  "data": {
    "metadata": {},
    "created_at": "2024-02-07T11:06:00.421853Z",
    "payer_details": {
      "name": "Hrithik Agarwal",
      "payer_bank": {
        "account_number":"9876542321",
        "name":"State Bank of Mars",
        "address":{
          "line1":"Address Line 1",
          "line2":"Address Line 2",
          "city":"City",
          "state":"state",
          "country":"country",
          "postal_code":"postal code"
        },
        "bank_codes":{
          "swift_code":"SBM001"
        }
      },
      "reference_id": "reffffff",
      "additional_information": "Additional Information for the transaction"
    },
    "id": "col_cn1m8651ed8dn2517esg",
    "object": "collect",
    "currency": "USD",
    "status": "failed",
    "type": "wire_transfer",
    "destination": "cca_uafanfianknon792nfak",
    "amount": 100000
  }
}

collect.on_hold

{
  "type": "collect.on_hold",
  "id": "evt_cn1m86nnt3jbkq7385qd0",
  "object": "event",
  "created_at": "2024-02-07T11:06:02.538953779Z",
  "data": {
    "metadata": {},
    "created_at": "2024-02-07T11:06:00.421853Z",
    "payer_details": {
      "name": "Hrithik Agarwal",
      "payer_bank": {
        "account_number":"9876542321",
        "name":"State Bank of Mars",
        "address":{
          "line1":"Address Line 1",
          "line2":"Address Line 2",
          "city":"City",
          "state":"state",
          "country":"country",
          "postal_code":"postal code"
        },
        "bank_codes":{
          "swift_code":"SBM001"
        }
      },
      "reference_id": "reffffff",
      "additional_information": "Additional Information for the transaction"
    },
    "id": "col_cn1m8651ed8dn2517esg",
    "object": "collect",
    "currency": "USD",
    "status": "on_hold",
    "type": "wire_transfer",
    "destination": "cca_uafanfianknon792nfak",
    "amount": 100000
  }
}

Other Events

EventDescriptionDefault (On / Off)
collect.createdTriggered when a collect is createdOff

collect.created

{
  "type": "collect.succeeded",
  "id": "evt_cn1m86nnt3hkq7385qd0",
  "object": "event",
  "created_at": "2024-02-07T11:06:02.538953779Z",
  "data": {
    "metadata": {},
    "created_at": "2024-02-07T11:06:00.421853Z",
    "payer_details": {
      "name": "Hrithik Agarwal",
      "payer_bank": {
        "account_number":"9876542321",
        "name":"State Bank of Mars",
        "address":{
          "line1":"Address Line 1",
          "line2":"Address Line 2",
          "city":"City",
          "state":"state",
          "country":"country",
          "postal_code":"postal code"
        },
        "bank_codes":{
          "swift_code":"SBM001"
        }
      },
      "reference_id": "reffffff",
      "additional_information": "Additional Information for the transaction"
    },
    "id": "col_cn1m8651ed8dn2517esg",
    "object": "collect",
    "currency": "USD",
    "status": "succeeded",
    "type": "wire_transfer",
    "destination": "cca_uafanfianknon792nfak",
    "amount": 100000
  }
}