Bank deposit webhooks

Txn sends a bank deposit webhook each time a bank deposit transaction's simplifiedState changes. The payload mirrors the Read bank deposit endpoint response.

The tabs below show example payloads for each state.

For configuring webhook URLs, retry behaviour, source IPs, and signature verification, see the general Webhooks section.

Pending

{
  "data": {
    "attributes": {
      "amount": "1.00",
      "createdAt": "2025-01-28T17:22:13.290Z",
      "reference": "26b7e971-e493-4e4c-86a1-a7a0f18c2444",
      "simplifiedState": "pending",
      "transactionType": "BankDepositTransaction"
    },
    "id": "a01776d7-30fb-4b13-98f1-fd635088f061",
    "relationships": {
      "account": {
        "meta": {
          "included": false
        }
      },
      "transactionDetails": {
        "data": {
          "id": "a01776d7-30fb-4b13-98f1-fd635088f061",
          "type": "bank_deposit_transactions"
        }
      }
    },
    "type": "transactions"
  },
  "included": [
    {
      "attributes": {
        "amount": "1.00",
        "createdAt": "2025-01-28T17:22:13.268Z",
        "currency": "EUR",
        "payerAddress": null,
        "payerBic": null,
        "payerIban": null,
        "payerName": null,
        "state": "confirmed",
        "updatedAt": "2025-01-28T17:22:13.268Z"
      },
      "id": "a01776d7-30fb-4b13-98f1-fd635088f061",
      "relationships": {
        "account": {
          "data": {
            "id": "13a85b45-8543-41c7-b963-394d4ea128ae",
            "type": "accounts"
          }
        }
      },
      "type": "bank_deposit_transactions"
    },
    {
      "attributes": {
        "balance": "32218.80",
        "currencyCode": "EUR",
        "currencyType": "fiat"
      },
      "id": "13a85b45-8543-41c7-b963-394d4ea128ae",
      "relationships": {
        "company": {
          "meta": {
            "included": false
          }
        },
        "networks": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "accounts"
    }
  ],
  "meta": {}
}

Completed

{
  "data": {
    "attributes": {
      "amount": "1.00",
      "createdAt": "2025-01-28T17:23:14.828Z",
      "reference": "26b7e971-e493-4e4c-86a1-a7a0f18c2444",
      "simplifiedState": "completed",
      "transactionType": "BankDepositTransaction"
    },
    "id": "a01776d7-30fb-4b13-98f1-fd635088f061",
    "relationships": {
      "account": {
        "meta": {
          "included": false
        }
      },
      "transactionDetails": {
        "data": {
          "id": "a01776d7-30fb-4b13-98f1-fd635088f061",
          "type": "bank_deposit_transactions"
        }
      }
    },
    "type": "transactions"
  },
  "included": [
    {
      "attributes": {
        "amount": "1.00",
        "createdAt": "2025-01-28T17:22:13.268Z",
        "currency": "EUR",
        "payerAddress": null,
        "payerBic": null,
        "payerIban": null,
        "payerName": null,
        "state": "completed",
        "updatedAt": "2025-01-28T17:22:13.268Z"
      },
      "id": "a01776d7-30fb-4b13-98f1-fd635088f061",
      "relationships": {
        "account": {
          "data": {
            "id": "13a85b45-8543-41c7-b963-394d4ea128ae",
            "type": "accounts"
          }
        }
      },
      "type": "bank_deposit_transactions"
    },
    {
      "attributes": {
        "balance": "32219.80",
        "currencyCode": "EUR",
        "currencyType": "fiat"
      },
      "id": "13a85b45-8543-41c7-b963-394d4ea128ae",
      "relationships": {
        "company": {
          "meta": {
            "included": false
          }
        },
        "networks": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "accounts"
    }
  ],
  "meta": {}
}

Cancelled

{
  "data": {
    "attributes": {
      "amount": "1.00",
      "createdAt": "2025-01-28T17:26:22.736Z",
      "reference": "344c23c1-f3d8-4a97-bcdf-d3d66a810103",
      "simplifiedState": "cancelled",
      "transactionType": "BankDepositTransaction"
    },
    "id": "09585b73-dfb9-41c0-a238-2e53d00f9608",
    "relationships": {
      "account": {
        "meta": {
          "included": false
        }
      },
      "transactionDetails": {
        "data": {
          "id": "09585b73-dfb9-41c0-a238-2e53d00f9608",
          "type": "bank_deposit_transactions"
        }
      }
    },
    "type": "transactions"
  },
  "included": [
    {
      "attributes": {
        "amount": "1.00",
        "createdAt": "2025-01-28T17:26:14.194Z",
        "currency": "EUR",
        "payerAddress": null,
        "payerBic": null,
        "payerIban": null,
        "payerName": null,
        "state": "cancelled",
        "updatedAt": "2025-01-28T17:26:14.194Z"
      },
      "id": "09585b73-dfb9-41c0-a238-2e53d00f9608",
      "relationships": {
        "account": {
          "data": {
            "id": "13a85b45-8543-41c7-b963-394d4ea128ae",
            "type": "accounts"
          }
        }
      },
      "type": "bank_deposit_transactions"
    },
    {
      "attributes": {
        "balance": "32218.79",
        "currencyCode": "EUR",
        "currencyType": "fiat"
      },
      "id": "13a85b45-8543-41c7-b963-394d4ea128ae",
      "relationships": {
        "company": {
          "meta": {
            "included": false
          }
        },
        "networks": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "accounts"
    }
  ],
  "meta": {}
}