¿Can you provide a list of all possible transaction statuses?
This is a full list of all the possible statuses that API operations might have at any given moment:
All purchase statuses: created, confirmed, canceled, failed
All payout statuses: created, completed, pending, canceled, failed
All bulk payments 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 final?
Purchase API
NOT FINAL
Created: A purchase order has been created and is awaiting action from the recipient. Once created a purchase order has to be either “confirmed” or “canceled” by the recipient. Non-completed purchases expire after 15 days.
FINAL
Confirmed: A purchase order has been confirmed (paid) by the recipient and the funds have been credited to your account.
Canceled: A purchase order has been 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 know the exact location of the funds.
Payout API
NOT FINAL
Created: A payment order has been created, when using the two-step payout process and is awaiting for you to call the commit endpoint
Pending: A guest account has been created for the end user with the recipient's email, and the money will be held in Airtm's escrow until the recipient activates its Airtm account
FINAL
Completed: The payout has been completed successfully, and funds have been credited to the end user's Airtm account.
Canceled: Payout has been canceled by you and funds have been returned to your account balance (Only applies if the payout was previously in “pending” status).
Failed: Something went wrong when we attempted to process the payout. Please contact your Account Manager to know the exact location of 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 contained in the bulk payment.
FINAL
Done: Bulk Payment tasks with status “DONE” mean that the processing, validations, and creation of operations related to that task are completed. This doesn't mean all the individual payments were completed successfully.
Failed: Something went wrong when processing one or more individual payments. Please check the errors endpoint to know what happened and contact your Account Manager if necessary.
Statuses of individual payments within a Bulk Payment:
NOT FINAL
Queued: The payment has been queued and is awaiting its turn to be processed.
Pending: A guest account has been created for the end user with the recipient's email, and the money will be held in Airtm's escrow until the recipient activates its Airtm account.
FINAL
Completed: The payout has been completed successfully, and funds have been credited to the end user's Airtm account.
Canceled: Payout has been canceled by you and funds have been returned to your account balance (Only applies if the payout was previously in “pending” status).
Failed: Something went wrong when we attempted to process the payment. Please check the errors endpoint to know what happened and contact your Account Manager if necessary.
Do you have a status request endpoint to check transaction status and details?
Yes, if the transaction has been already made you can check it out using this endpoint for pay-ins and pay-outs https://docs.airtm.com/operations/get-operation-detail or https://docs.airtm.com/bulk-payments/get-bulk-payments-by-id for bulk payments. Also, you are able to receive callbacks when using the Purchase API (pay-ins) as well as the payments/pay-outs API, so you can know the status of transactions without having to check one by one.