---
title: "Payout completed"
method: POST
path: "payout.completed"
tags: ["Webhooks"]
---

# Payout completed

`POST payout.completed` (webhook)

A payout has completed

## Payload

- object
  - `data` PayoutResponse, required: Represents a Payout Object
    - `id` string, uuid, required
    - `bulkPayoutId` string, uuid
    - `hash` string: Unique hash for the payout operation within the Airtm system.
    - `code` string: A unique code used to identify the payout.
    - `airtmUserId` string, uuid, required
    - `airtmUserEmail` string, required
    - `requireIdVerified` boolean: Whether the recipient must be ID-verified to receive the funds
    - `notes` string: An arbitrary string describing the payment. This information is displayed to the recipient.
    - `internalNote` string: The description of the payout; visible to internal users
    - `status` 'BRIDGE_COMPLETED' | 'BRIDGE_CREATED' | 'BRIDGE_FAILED' | 'BRIDGE_MAX_RETRIES_REACHED' | 'BRIDGE_USER_SIGNUP_PENDING' | 'CANCELED' | 'CANCEL_REQUESTED' | 'COMMITTED' | 'COMPLETED' | 'COSMOEM_COMPLETED' | 'CREATED' | 'ERROR' | 'FAILED' | 'PENDING' | 'PENDING_SIGNATURE' | 'SIGNED' | 'PENDING_USER_ACTION' | 'PROCESSING', required: The current status of the payout. - `CREATED`: The payout instruction has been registered and is awaiting you to call the commit endpoint. - `COMMITTED`: The payout was committed and is in the process of being executed. - `PENDING`: Funds have been placed in escrow and waiting for the recipient to take the following action to complete the payout 1. If a new user, create an Airtm account. 2. If a user receiving an amount taking them over the $1,000 inflow threshold requiring KYC. 3. If a US user, complete KYC and configure payment method. - `COMPLETED`: The payout has been completed successfully, funds have been credited to the customer's account. - `CANCELED`: Payout has been canceled and funds have been returned to your account. - `FAILED`: The payout has failed and funds have been returned to your account. - `ERROR`: A temporary error state. Payouts in this state should be fixed and retried until they reach a final state (COMPLETED or CANCELED).
    - `grossAmount` number, double, required: amount originally intended for the payout
    - `amount` number, double, required: amount to be deducted from the enterprise account (grossAmount - enterpriseFee)
    - `netAmount` number, double, required: amount received by the user (grossAmount - enterpriseFee - airtmFee)
    - `airtmFee` number, double: The airtm fee applied to the payout
    - `enterpriseFee` number, double: The enterprise fee applied to the payout
    - `reasonCode` string: Machine-friendly code relating to the reason why the payout has the current status
    - `reasonDescription` string: Human-readable message describing the reason why the payout has the current status
    - `kycInformation` KycInformation: Represents the user's KYC information for a payout. > [!TIP] > Only available in `payout.completed` webhook and only if ID verification is enabled in your account. > If you want access to this information, please contact [enterprise@airtm.io](mailto:enterprise@airtm.io) Represents the user's KYC information for a payout. > [!TIP] > Only available in `payout.completed` webhook and only if ID verification is enabled in your account. > If you want access to this information, please contact [enterprise@airtm.io](mailto:enterprise@airtm.io)
      - `fullName` string, nullable, required
      - `birthDate` string, nullable, required
      - `identificationNumber` string, nullable, required
      - `countryCode` string, nullable, required
      - `state` string, nullable
    - `createdAt` string, date-time, required: Timestamp of when the payout was created.
    - `updatedAt` string, date-time, required: Timestamp of the last update made to the payout.
  - `type` string, required: payout.completed

---

[API](https://skmtc.dev/airtm/apis/airtm-enterprise-api-v2.md) - [All operations](https://skmtc.dev/airtm/apis/airtm-enterprise-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/airtm/apis/airtm-enterprise-api-v2/revisions/c9ed13d4c5c0?raw)