---
title: "Create payout"
method: POST
path: "payouts"
tags: ["Payments / Payouts"]
---

# Create payout

`POST payouts`

## Request

- Base URL: `https://payments.air-pay.io`
- URL: `https://payments.air-pay.io/payouts`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/airtm/apis/airtm-enterprise-api-v1/docs/payouts/post.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint allows you to create a payout instruction. In the request
body, information about the payout such as the recipient's email,
description, amount, and any URLs needed for confirmation or failure
redirects should be provided. Upon successful creation, the API returns
a response containing the details of the newly created payout, including
a unique ID.

After making a call to this endpoint, no money is moved yet. To finish
moving the money to a user you must call the payouts/:id/commit endpoint
with the id from this response.

## Request body

- object
  - `email` string, email, required: The recipient's email address that is associated with their Airtm account
  - `description` string, required: An arbitrary string describing the payment. This information is displayed to the recipient. It's recommended that the string summarizes the purpose of the payment.
  - `amount` number, required: The payment amount in USD.
  - `code` string: A unique idempotency key used to prevent duplicate payouts from being created.

## Response `200`

OK

- object
  - `id` string, uuid: This is the unique identifier for the payout.
  - `partner_id` string, uuid: This is the unique identifier of the partner associated with the payout.
  - `status` string: This field indicates the current status of the payout. For example, "created" means the payout has been successfully created.
  - `amount` unknown
  - `description` string: An arbitrary string describing the payment. This information is displayed to the recipient. It's recommended that the string summarizes the purpose of the payment.
  - `confirmation_uri` string: Deprecated. Airtm no longer calls this URL, and new payout requests that include it are rejected. Use webhooks instead.
  - `cancel_uri` string: Deprecated. Airtm no longer calls this URL, and new payout requests that include it are rejected. Use webhooks instead.
  - `failure_uri` string: Deprecated. Airtm no longer calls this URL, and new payout requests that include it are rejected. Use webhooks instead.
  - `failure_reason` string: This field will be populated if the payout fails, providing a reason for the failure.
  - `callback_uri` string: Deprecated. Airtm no longer calls this URL, and new payout requests that include it are rejected. Use webhooks instead.
  - `airtm_operation_id` string: Unique identifier for the payout operation within the Airtm system.
  - `created_at` string: Timestamp of when the payout was created.
  - `updated_at` string: Timestamp of the last update made to the payout.
  - `airtm_user_email` string: This is the email of the Airtm user who is associated with this payout.
  - `airtm_user_id` string: This is the unique identifier for the AirTM user who is associated with this payout.
  - `operation_type` string: This field indicates the type of operation. In this case, it's a "payout".
  - `airtm_operation_hash` string: Unique hash for the payout operation within the Airtm system.
  - `reason_code` string: This field will be populated if the payout failed or canceled, providing a code to referenced in the codes catalog.

---

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