---
title: "Escrow Payment Released Webhook"
source_url: https://docs.rapyd.net/en/escrow-payment-released-webhook.html
lang: en
---

# Escrow Payment Released Webhook

The **ESCROW_RELEASED** webhook is sent when money is released from an escrow when the time defined in `escrow_release_days` expires.

### Parameters

### Webhook Header Parameters

- - Content-Type
  - Indicates that the data appears in JSON format. Set to **application/json**.
- - salt
  - Random string.
- - signature
  - Signature calculated for each webhook individually.

    See [Webhook Authentication](https://docs.rapyd.net/en/webhook-authentication.md "Webhook Authentication").
- - timestamp
  - Timestamp for the webhook, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time") (seconds).

### Webhook Root Parameters

- - created_at
  - Time that the webhook was created, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time").

    > **Note:**
    >
    > Inside the `data` object, some webhooks have another `created_at` field that refers to a different event.
- - data
  - Contains the actual data of the webhook.

    For details, see below.
- - extended_timestamp
  - Time in milliseconds that the webhook was created, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time").
- - id
  - ID of the webhook. String starting with **wh_**.
- - status
  - Status of the webhook. One of the following:

    - **NEW**
    - **CLO** - Closed.
    - **ERR** - Error.
    - **RET** - Re-sent.

    > **Note:**
    >
    > Inside the `data` object, some webhooks have another `status` field that refers to a different event.
- - trigger_operation_id
  - ID of the operation that triggered the webhook. UUID.
- - type
  - Name of the webhook type.

    > **Note:**
    >
    > The name in the Client Portal is different.

### Webhook Data Parameters

- - amount_on_hold
  - Total amount of funds that are currently held in the escrow, in the currency defined in `currency_code` in the payment.
- - created_at
  - Date and time the escrow was created, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time").
- - currency
  - The currency of the escrow balance. Three-letter ISO 4217 code.
- - escrow_releases
  - Array of objects that describe individual releases.

    - - data
      - Array of objects that describe individual escrow releases.

        - - amount
          - The amount released.
        - - created_at
          - Date and time the escrow release was created, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time").
        - - currency
          - The currency of the escrow balance. Three-letter ISO 4217 code.
        - - ewallets
          - Array of objects that define a non-proportional release to multiple wallets.

            - - ewallet
              - ID of the wallet, a string starting with **ewallet_**.
            - - amount
              - The amount to release to this wallet. Relevant when `percentage` is not set.
            - - percentage
              - The percentage of this escrow to release to this wallet. Relevant when `amount` is not set. On a partial release after the first, this refers to the percentage of the original amount of the escrow.
        - - id
          - ID of the escrow release, a string starting with **er_**.
        - - proportional_release
          - Indicates that the wallets were released in the same proportion that was defined in the [Create Payment](https://docs.rapyd.net/en/create-payment.md "Create Payment") request.
        - - trigger
          - Indicates what triggered the escrow release. One of the following:

            - **event** - Funds were released due to an API request.
            - **time** - Funds were automatically released at 5:00 p.m. GMT (17:00 GMT) on the day indicated in the[Create Payment](https://docs.rapyd.net/en/create-payment.md "Create Payment") request.
            - **cancel_escrow** - Escrow was canceled.
    - - has_more
      - Indicates that the number of escrow releases is greater than the number returned in the response.
    - - total_count
      - Number of escrow releases.
    - - url
      - URL for the record of all escrow releases for this payment.
- - id
  - ID of the escrow, a string starting with **escrow_**.
- - last_payment_completion
  - Date and time of the completion of the last payment or partial payment, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time").
- - payment
  - ID of the payment, a string starting with **payment_**.
- - status
  - Status of the escrow. One of the following:

    - **pending** - The payment and escrow were created, but the payment is not completed and the funds are not in the escrow.
    - **on_hold** - The payment is completed and the funds are in escrow.
    - **canceled** - The escrow is canceled.
    - **released** - All or part of the funds have been released to the wallets.
- - total_amount_released
  - Total amount of funds that were released to the wallets, in the currency defined in `currency_code` in the payment response.
- - updated_at
  - Date and time of the last update to the escrow, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time").

- ESCROW_RELEASED Webhook
- ```json
  {
      "id": "wh_eb48b49713a2948b4f3a6bbeb9e56541",
      "type": "ESCROW_RELEASED",
      "data": {
          "id": "escrow_0be82db18cb63d748bf99138b4d07570",
          "status": "released",
          "payment": "payment_fd0915ccb1163d3572a89f51c317d116",
          "currency": "USD",
          "created_at": 1653526966,
          "updated_at": 1653699639,
          "amount_on_hold": 0,
          "escrow_releases": {
              "url": "/v1/payments/payment_fd0915ccb1163d3572a89f51c317d116/escrows/escrow_0be82db18cb63d748bf99138b4d07570/escrow_releases",
              "data":
              [{
                      "id": "er_fe4234e5387a8d11d1b882d13d3a0050",
                      "amount": 10,
                      "trigger": "time",
                      "currency": "USD",
                      "ewallets":
                      [{
                              "amount": 10,
                              "ewallet": "ewallet_9f63aaf076f06c7529e67ec3d08179b2"
                          }
                      ],
                      "created_at": 1653699639,
                      "proportional_release": true
                  }
              ],
              "has_more": false,
              "total_count": 1
          },
          "escrow_release_days": 1,
          "total_amount_released": 10,
          "last_payment_completion": 1653526966
      },
      "trigger_operation_id": "50439b18-96e2-450d-8155-b268d0ae1435",
      "status": "NEW",
      "created_at": 1653699641,
      "extended_timestamp": 1653699641534
  }
  ```