The payment resource may exist in different states according to the progress of the transaction:
| Status | Definition |
|---|---|
authorization_required |
The payment has been created successfully and no further action has been taken. |
authorizing |
The end-user has started the authorization journey by interacting with the Hosted Payments Page or the client's UI and has not completed the journey yet. |
authorized |
The end-user has completed the authorization journey and the payment has successfully completed its authorization flow. |
executed |
TrueLayer has submitted the payment to the bank and the payment has been accepted successfully. The payment will be executed by the bank, not TrueLayer.
|
failed |
The payment has failed to transition to the next status. This is a terminal status. |
settled |
The payment has settled into the client's merchant account held by TrueLayer. This status only applies to closed-loop payments (i.e. when the beneficiary account is a merchant account created and held by TrueLayer). This is a terminal status. See our documentation to find out how to make payments into merchant accounts. |
Note that after a payment has been executed, it may take some time for it to be settled, although, for transactions executed via Faster Payments in the UK, this normally happens very quickly.
Different banks may take different amounts of time to show a payment as executed in their customer banking interfaces e.g. mobile banking app, online banking, depending upon how often they refresh this data.
Need any help with failed payments? Check out this section of our Documentation.
Need support? Raise a ticket with us following the instructions in this article.