AIairtm
Payments / Payouts

Cancel pending payouts

This endpoint allows users to cancel specific PENDING individual payouts—those that have been created and committed but where the recipient has not yet signed up on Airtm.com.

To manually cancel a pending payout, users must provide the transaction id, which can be retrieved when creating the payout through either the Create & Commit or One-Step payout flows. Pending payouts will automatically cancel after 90 days (by default, other time periods are avilable in dashboard settings) from the creation date.

Once canceled:

  • Funds are automatically returned to the user's Airtm balance.

  • The individual payout status is updated to CANCELED.

  • The response will include all relevant details of the canceled payout.

Additional information about canceled payouts can be accessed through the Enterprise Portal (enterprise.airtm.com) or by querying Operations .

Note: This feature is only available for partners who have migrated to the new infrastructure solution based on Bridge Ventures.

postpayouts/{payoutId}/cancel

Request

Path parameters

payoutIdstring required

Request body

object required

Response

OK

idstring
amountstring
confirmation_uristring
failure_uristring
failure_reasonstring
airtm_user_idstring
airtm_user_emailstring
created_atstring
updated_atstring
statusstring
descriptionstring
airtm_operation_idstring
operation_typestring
airtm_operation_hashstring
partner_idstring

Example response

{
  "id": "5d8950c9-63f6-481f-a2b1-719ebe62ac74",
  "amount": "0.02",
  "confirmation_uri": "http://your.site/payout/success",
  "failure_uri": "http://your.site/payout/failure",
  "airtm_user_id": "d2f17c25-4aa2-46c2-aecb-498ffdd23aa2",
  "airtm_user_email": "john.doe@gmail.com",
  "created_at": "2024-05-16T15:53:12.016Z",
  "updated_at": "2025-02-17T17:34:39.051Z",
  "status": "CANCELED",
  "description": "Testing",
  "airtm_operation_id": "5d8950c9-63f6-481f-a2b1-719ebe62ac74",
  "operation_type": "payout",
  "airtm_operation_hash": "63F6ZU481FQEA2B1",
  "partner_id": "a78a2be5-cdec-4480-b40c-eb3c33a4f8f2"
}

Changes

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