Skip to main content

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.

​
Settlement Status Specific Events:

These are the events created and triggered when the status of the settlement object changes.
EventDescriptionDefault (on/off)
settlement.createdWhen the settlement is createdOff
settlement.processingWhen the settlement is initiated from TazapayOff
settlement.succeededWhen the settlement reaches the destination bank account (using local rails) or is initiated from Tazapay (using the SWIFT network)Off
settlement.failedWhen a settlement failsOff

​
settlement.created

JSON
{
  "type": "settlement.created",
  "created_at": "2025-04-29T12:34:56+05:30",
  "data": {
    "id": "stl_ahfafooi7ibakbfahoan",
    "object": "settlement",
    "account_id": "acc_d3inm6ami8u10oqfm",
    "status": "created",
    "status_description": "",
    "currency": "USD",
    "amount": 100123,
    "fee": 123,
    "net_amount": 100000,
    "type": "wire_transfer",
    "count": {
      "payins": 100,
      "refunds": 10,
      "adjustments": 25,
      "collects": 30,
      "payouts": 10
    },
    "tracking_details": {
      "tracking_number": "",
      "tracking_type": ""
    },
    "mt103": null,
    "balance_transaction": "btr_1234",
    "confirmation_documents": [],
    "created_at": "2025-04-29T12:34:56+05:30",
    "updated_at": "2025-04-29T12:34:56+05:30"
  },
  "id": "evt_auigfianfoangohuehg",
  "object": "event"
}

​
settlement.processing

JSON
{
  "type": "settlement.processing",
  "created_at": "2025-04-29T13:00:00+05:30",
  "data": {
    "id": "stl_ahfafooi7ibakbfahoan",
    "object": "settlement",
    "account_id": "acc_d3inm6ami8u10oqfm",
    "status": "processing",
    "status_description": "",
    "currency": "USD",
    "amount": 100123,
    "fee": 123,
    "net_amount": 100000,
    "type": "wire_transfer",
    "count": {
      "payins": 100,
      "refunds": 10,
      "adjustments": 25,
      "collects": 30,
      "payouts": 10
    },
    "tracking_details": {
      "tracking_number": "8937589hfoiha98h",
      "tracking_type": "uetr"
    },
    "mt103": null,
    "balance_transaction": "btr_1234",
    "confirmation_documents": [],
    "created_at": "2025-04-29T12:34:56+05:30",
    "updated_at": "2025-04-29T13:00:00+05:30"
  },
  "id": "evt_auigfianfoangohuehg",
  "object": "event"
}

​
settlement.succeeded

JSON
{
  "type": "settlement.succeeded",
  "created_at": "2025-04-30T09:15:22+05:30",
  "data": {
    "id": "stl_ahfafooi7ibakbfahoan",
    "object": "settlement",
    "account_id": "acc_d3inm6ami8u10oqfm",
    "status": "succeeded",
    "status_description": "",
    "currency": "USD",
    "amount": 100123,
    "fee": 123,
    "net_amount": 100000,
    "type": "wire_transfer",
    "count": {
      "payins": 100,
      "refunds": 10,
      "adjustments": 25,
      "collects": 30,
      "payouts": 10
    },
    "tracking_details": {
      "tracking_number": "8937589hfoiha98h",
      "tracking_type": "uetr"
    },
    "mt103": "{1:F01BANKUS33AXXX0000000000}\n{2:O1031205050425BANKGB2LXXXX22221234560504251205N}\n{3:{108:20250408ABC12345}}\n{4:\n:20:ABC1234567890\n:23B:CRED\n:32A:250408USD100000,00\n:50K:/1234567890\nMERCHANT NAME\n123 MAIN STREET\nSINGAPORE 049483\n:59:/0987654321\nJANE SMITH\n456 ELM STREET\nLONDON SW1A 1AA\nUNITED KINGDOM\n:70:SETTLEMENT PAYMENT\n:71A:OUR\n-}\n",
    "balance_transaction": "btr_1234",
    "confirmation_documents": [],
    "created_at": "2025-04-29T12:34:56+05:30",
    "updated_at": "2025-04-30T09:15:22+05:30"
  },
  "id": "evt_auigfianfoangohuehg",
  "object": "event"
}

​
settlement.failed

JSON
{
  "type": "settlement.failed",
  "created_at": "2025-04-30T09:15:22+05:30",
  "data": {
    "id": "stl_ahfafooi7ibakbfahoan",
    "object": "settlement",
    "account_id": "acc_d3inm6ami8u10oqfm",
    "status": "failed",
    "status_description": "Beneficiary account details incorrect",
    "currency": "USD",
    "amount": 100123,
    "fee": 123,
    "net_amount": 100000,
    "type": "wire_transfer",
    "count": {
      "payins": 100,
      "refunds": 10,
      "adjustments": 25,
      "collects": 30,
      "payouts": 10
    },
    "tracking_details": {
      "tracking_number": "8937589hfoiha98h",
      "tracking_type": "uetr"
    },
    "mt103": null,
    "balance_transaction": "btr_1234",
    "confirmation_documents": [],
    "created_at": "2025-04-29T12:34:56+05:30",
    "updated_at": "2025-04-30T09:15:22+05:30"
  },
  "id": "evt_auigfianfoangohuehg",
  "object": "event"
}