AIairtm
Payments / Payouts

Commit payout

After calling this endpoint, Airtm will execute/process the previously received payout instruction. The RESPONSE confirms the reception and incorporation of the payout instruction for processing. Funds will be deducted from your balance while the payout execution process is being carried out.

Please note that a 200 response doesn't necessarily mean the money moved, it simply means the system is now trying to send the amount. Use webhooks OR call /operations/:id to get an update.

The status of the payout will either be committed, pending or failed, A committed status means that the recipient's email has been identified as an active Airtm user and the payout process has successfully started. A pending status means that the recipient's email does not have an Airtm account. The payout process will be completed when the user signs up at Airtm. A committed payout will eventually move on to completed once the payout execution process finishes. Extra information of the recently completed payout can be queried by calling /operations/:id

postpayouts/{payoutId}/commit

Request

Path parameters

payoutIdstring
Example:ed7ce4ce-53c2-43f8-aaa8-4afb6cf90cfc

Request body

object required

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

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

code_reasonstring

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",
  "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"
}

Changes

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