Can you provide a list of all possible transaction statuses?
This is the full list of possible statuses for API operations:
- All purchase statuses: created, confirmed, canceled, failed
- All payout statuses: created, completed, pending, canceled, failed
- All bulk payment statuses: pending, running, done, failed, completed, queued, canceled
Note: We recommend that API implementors perform case-insensitive comparisons when checking statuses.
What statuses are considered final and which ones are not?
Purchase API
NOT FINAL
- Created: A purchase order has been created and is awaiting action from the recipient. It must be "confirmed" or "canceled" by the recipient. Non-completed purchases expire after 15 days.
FINAL
- Confirmed: The purchase order has been confirmed (paid) by the recipient and funds have been credited to your account.
- Canceled: The purchase order was canceled (declined) by the recipient. No funds were credited to your account.
- Failed: Something went wrong when the recipient attempted to confirm or cancel the purchase order. Please contact your Account Manager to locate the funds.
Payout API
NOT FINAL
- Created: A payment order has been created using the two-step payout process and is awaiting your call to the commit endpoint.
- Pending: A guest account has been created for the end user with the recipient's email, and the money is held in Airtm's escrow until the recipient activates their Airtm account.
FINAL
- Completed: The payout completed successfully and funds have been credited to the end user's Airtm account.
- Canceled: You canceled the payout and funds were returned to your account balance (only applies if the payout was previously in "pending" status).
- Failed: Something went wrong when processing the payout. Please contact your Account Manager to locate the funds.
Bulk Payments API
Statuses of a Bulk Payment Task:
NOT FINAL
- Pending: A Bulk Payment task has been created but has not started yet.
- Running: Our system is currently processing all the individual payments in the bulk payment.
FINAL
- Done: Processing, validations, and creation of operations related to that task are complete. This does not mean all individual payments completed successfully.
- Failed: Something went wrong processing one or more individual payments. Check the errors endpoint and contact your Account Manager if necessary.
Statuses of individual payments within a Bulk Payment:
NOT FINAL
- Queued: The payment is queued and awaiting its turn to be processed.
- Pending: A guest account has been created for the end user and the money is held in Airtm's escrow until the recipient activates their Airtm account.
FINAL
- Completed: The payment completed successfully and funds have been credited to the end user's Airtm account.
- Canceled: You canceled the payment and funds were returned to your account balance (only applies if the payment was previously in "pending" status).
- Failed: Something went wrong. Check the errors endpoint and contact your Account Manager if necessary.
Do you have an endpoint to check transaction status and details?
Yes. For pay-ins and pay-outs use https://docs.airtm.com/operations/get-operation-detail. For bulk payments: https://docs.airtm.com/bulk-payments/get-bulk-payments-by-id. You can also receive callbacks when using the Purchase API (pay-ins) and Payments API (pay-outs) to track transaction statuses without polling individually.