AIairtm
Payments / Payouts

One step payout

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

postpayouts/one-step

Request

Request body

emailstring 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

Unique identifier automatically generated on payout creation.

partner_idstring

ID of the partner who created and committed the payout.

statusstring

Payout is commited and is the process of being executed

amountstring

Amount in USD that was committed.

descriptionstring

Description of the payout, inputted in the creation.

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": "COMMITTED",
  "amount": "1.00",
  "description": "Payout test",
  "confirmation_uri": "https://your.site/success",
  "cancel_uri": "http://your.site/payout/cancel",
  "failure_uri": "https://your.site/failure",
  "airtm_operation_id": "a8bc79c2-cde3-4906-b3f5-5af028b3a57e",
  "created_at": "2019-03-05T18:48:07.000Z",
  "updated_at": "2019-03-05T18:48:21.000Z",
  "airtm_user_email": "john.doe@gmail.com",
  "airtm_user_id": "d2f17c25-4aa2-46c2-aecb-498ffdd23aa2",
  "operation_type": "payout",
  "airtm_operation_hash": "4AA2FV46C2CDAECB"
}

Changes

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