# Payout webhooks

**Webhook events**

| Event type                | Description                                                                     |
| ------------------------- | ------------------------------------------------------------------------------- |
| PAYOUT\_CHANGE\_STATUS    | Payout has changed state to In Progress, Canceled, Failed, Partial or Completed |
| PAYOUT\_CONFIRMED         | Payout has changed state to Confirmed                                           |
| PAYOUT\_VALIDATION\_ERROR | Validation error has occurred during payout processing                          |

**Payload description**

**PAYOUT\_CHANGE\_STATUS**

| Parameter        | Type   | Description                                                              |
| ---------------- | ------ | ------------------------------------------------------------------------ |
| hash             | string | transaction hash.                                                        |
| type             | string | event type: PAYOUT\_CHANGE\_STATUS.                                      |
| parentExternalId | number | system id of the payout.                                                 |
| createdDate      | string | date and time of payout creation.                                        |
| payoutStatus     | string | current state of the payout.                                             |
| idempotencyKey   | string | the external id that was generated while payout creating through api.    |
| currency         | string | currency of the payout.                                                  |
| externalId       | string | External identifier passed by the merchant when creating the transaction |

**PAYOUT\_CONFIRMED**

| Parameter        | Type   | Description                                                              |
| ---------------- | ------ | ------------------------------------------------------------------------ |
| type             | string | event type: PAYOUT\_CONFIRMED.                                           |
| parentExternalId | number | system id of the payout.                                                 |
| createdDate      | string | date and time of payout creation.                                        |
| approved         | array  | list of users who approved the payout.                                   |
| idempotencyKey   | string | the external id that was generated while payout creating through api.    |
| currency         | string | currency of the payout                                                   |
| externalId       | string | External identifier passed by the merchant when creating the transaction |

**PAYOUT\_VALIDATION\_ERROR**

| Parameter        | Type   | Description                                                              |
| ---------------- | ------ | ------------------------------------------------------------------------ |
| type             | string | event type: PAYOUT\_VALIDATION\_ERROR.                                   |
| parentExternalId | number | system id of the payout.                                                 |
| message          | string | validation error message.                                                |
| createdDate      | string | date and time of payout creation.                                        |
| dealWithdrawalId | number | system id of withdrawal where validation error occured.                  |
| validationStatus | string | the reason of validation error.                                          |
| idempotencyKey   | string | the external id that was generated while payout creating through api.    |
| currency         | string | currency of the payout.                                                  |
| externalId       | string | External identifier passed by the merchant when creating the transaction |
