--- title: "Get the events for a single payout" method: GET path: "/payouts/{id}/events" tags: ["Payouts"] --- # Get the events for a single payout `GET /payouts/{id}/events` ## Request - Base URL: `https://api.enterprise.airtm.com/v2` - URL: `https://api.enterprise.airtm.com/v2/payouts/{id}/events` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Every time a payout transitions to a new status, an event is created. This endpoint allows you to retrieve the events for a single payout. ## Path parameters - `id` string, required ## Response `200` Ok - OperationEvent[] - `updatedAt` string, date-time, required: Date when the event was last updated. - `createdAt` string, date-time, required: Date when the event was created. - `metadata` object, required: Metadata associated with the event. - `transitionMessage` string - `transitionCode` string - `availableBalance` number, double, nullable: Available balance for the enterprise. - `fboBalance` number, double, nullable: Total balance available in the FBO account. - `pendingBalance` number, double, nullable: Balance that is committed in pending payouts. - `newStatus` union, required: New status of the operation. - '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': 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). - 'CREATED' | 'CONFIRMED' | 'CANCELED' | 'PROCESSING' | 'FAILED' | 'BRIDGE_FAILED' | 'BRIDGE_CANCELED': The current status of the payin - `CREATED`: The payin has been created but not yet confirmed. - `CONFIRMED`: The payin has been confirmed and is ready for processing. - `CANCELED`: The payin has been canceled by the user or system. - `PROCESSING`: The payin is currently being processed. - `FAILED`: The payin has failed due to an error. - `BRIDGE_FAILED`: The payin has failed due to an error in Bridge. - `BRIDGE_CANCELED`: The payin has been canceled due to an error in Bridge. - `previousStatus` union, required: Previous status of the operation. - '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': 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). - 'CREATED' | 'CONFIRMED' | 'CANCELED' | 'PROCESSING' | 'FAILED' | 'BRIDGE_FAILED' | 'BRIDGE_CANCELED': The current status of the payin - `CREATED`: The payin has been created but not yet confirmed. - `CONFIRMED`: The payin has been confirmed and is ready for processing. - `CANCELED`: The payin has been canceled by the user or system. - `PROCESSING`: The payin is currently being processed. - `FAILED`: The payin has failed due to an error. - `BRIDGE_FAILED`: The payin has failed due to an error in Bridge. - `BRIDGE_CANCELED`: The payin has been canceled due to an error in Bridge. - `eventType` string, required: Type of the event. - `operationType` string, required: Type of the operation associated with the event. It could be either 'PAYOUT' or 'PAYIN'. - `operationId` string, uuid, required: Unique identifier for the operation associated with the event. - `userId` string, uuid, required: Unique identifier for the user associated with the event. - `id` string, uuid, required: Unique identifier for the event. ## Other responses - `default`: Error --- [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)