---
title: "One step payout"
method: POST
path: "payouts/one-step"
tags: ["Payments / Payouts"]
---

# One step payout

`POST payouts/one-step`

## Request

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

This endpoint is a combination of the Create Payout and the Commit
Payout endpoints. If you want to do a payout in just one API call
instead of a two-step process outlined in Create / Commit Payout, you
can now use this one-step endpoint.

The usage is exactly the same as the **Create payout** endpoint at POST
/payouts with the only difference being that the second step (commit
payout) will immediately be executed and there is no need to make a call
to the commit endpoint. The RESPONSE of this endpoint will indicate
whether the payout instruction was received and incorporated
successfully (`committed` / `pending`) or if the creation instruction
failed (`failed`). Identically as in the payouts/{payoutId}/commit
endpoint, the effective result of the executed payout is reported on the
callbacks URI

## Request body

- object
  - `email` string, 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: Unique identifier automatically generated on payout creation.
  - `partner_id` string: ID of the partner who created and committed the payout.
  - `status` string: Payout is commited and is the process of being executed
  - `amount` string: Amount in USD that was committed.
  - `description` string: Description of the payout, inputted in the creation.
  - `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)