AIairtm
Payments / Payouts

Create payout

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.

postpayouts

Request

Request body

emailstring email required

The recipient's email address that is associated with their Airtm account

descriptionstring 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.

amountnumber required

The payment amount in USD.

codestring

A unique idempotency key used to prevent duplicate payouts from being created.

Example request

{
  "email": "john.doe@gmail.com",
  "description": "Payout test",
  "amount": 1,
  "code": "1234abcd"
}

Response

OK

idstring uuid

This is the unique identifier for the payout.

partner_idstring uuid

This is the unique identifier of the partner associated with the payout.

statusstring

This field indicates the current status of the payout. For example, "created" means the payout has been successfully created.

amountunknown
descriptionstring

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_uristring

Deprecated. Airtm no longer calls this URL, and new payout requests that include it are rejected. Use webhooks instead.

cancel_uristring

Deprecated. Airtm no longer calls this URL, and new payout requests that include it are rejected. Use webhooks instead.

failure_uristring

Deprecated. Airtm no longer calls this URL, and new payout requests that include it are rejected. Use webhooks instead.

failure_reasonstring

This field will be populated if the payout fails, providing a reason for the failure.

callback_uristring

Deprecated. Airtm no longer calls this URL, and new payout requests that include it are rejected. Use webhooks instead.

airtm_operation_idstring

Unique identifier for the payout operation within the Airtm system.

created_atstring

Timestamp of when the payout was created.

updated_atstring

Timestamp of the last update made to the payout.

airtm_user_emailstring

This is the email of the Airtm user who is associated with this payout.

airtm_user_idstring

This is the unique identifier for the AirTM user who is associated with this payout.

operation_typestring

This field indicates the type of operation. In this case, it's a "payout".

airtm_operation_hashstring

Unique hash for the payout operation within the Airtm system.

reason_codestring

This field will be populated if the payout failed or canceled, providing a code to referenced in the codes catalog.

Example response

{
  "id": "57f384ac-c5f7-492a-aaf7-daa928de9b40",
  "partner_id": "2abf29df-4c6d-4de4-ae55-d26556ac5475",
  "status": "created",
  "amount": 1,
  "description": "Payout test",
  "confirmation_uri": "https://your.site/success",
  "cancel_uri": "http://your.site/payout/cancel",
  "failure_uri": "https://your.site/failure",
  "created_at": "2019-03-05T18:48:07.000Z",
  "updated_at": "2019-03-05T18:48:07.000Z",
  "airtm_user_email": "john.doe@gmail.com",
  "airtm_user_id": "d2f17c25-4aa2-46c2-aecb-498ffdd23aa2",
  "operation_type": "payout"
}

Changes

No recorded changes to this operation across all 1 revision of this API.