PSP settlement statuses
This page describes the status transitions for the PSP settlement objects, namely PSP settlement intent, PSP settlement split, and PSP settlement deposit, when you process settlements received from acquiring PSPs into seller's connected accounts.
PSP settlement intent
Status transitions for a PSP settlement intent object during settlement handling.
| Status | Description | Emitted webhook | Next steps |
|---|---|---|---|
| NEW | The PSP settlement intent has been successfully created on the server. | psp_settlement_intent.new | You can proceed to define the splits using Split a PSP settlement intent. For more information, see Share settlement data. |
| SUBMITTED | The PSP settlement intent has been submitted and is available for matching with PSP settlement deposits. | psp_settlement_intent.submitted | Wait for the acquiring PSP to deposit the funds described in the PSP settlement intent. |
| ACTION_REQUIRED | Unsuccessful match between the PSP settlement intent and deposit(s). | psp_settlement_intent.action_required | See Failure notifications. |
| MATCHED | The amount of the PSP settlement intent, i.e., the sum of the amounts of all its PSP settlement splits, matches the amount of the associated PSP settlement deposit(s). | psp_settlement_intent.matched | You can proceed to release settlement splits comprising this intent. See Release settlement split. |
| SETTLED | Platform has successfully released all the PSP settlement splits comprising the intent and the funds have moved from the Holding Account into the sellers' connected account wallets. The platform may also have created splits to represent fees, which move funds from the Holding Account to the platform’s Wallet. |
psp_settlement_intent.settled | Pay out funds from the sellers’ connected accounts to their external bank accounts whenever you choose. |
| CANCELLED | The PSP settlement intent, and all of its PSP settlement splits, has been cancelled by the platform. | psp_settlement_intent.cancelled | If the intent was cancelled because incorrect data was shared by the platform then create a new PSP settlement intent and start over. See Share settlement data. |
You can subscribe to PSP Settlement Intent webhooks to receive notifications on these status transitions.
PSP settlement split
Status transitions for a PSP Settlement Split object during settlement handling.
| Status | Description | Emitted webhook | Next steps |
|---|---|---|---|
| NEW | The PSP settlement split has been successfully created on the server. | psp_settlement_split.new | No action needed. |
| MATCHED | The PSP settlement intent containing this split has been successfully matched with the associated PSP settlement deposit(s). | psp_settlement_split.matched | You can proceed to release the PSP settlement split. See Release settlement split. |
| PENDING | Platform has released the PSP settlement split but the funds are yet to be settled in the seller's connected account wallet. | psp_settlement_split.pending | Wait to receive notification on the success or failure of the settlement. |
| SETTLED | Platform has successfully released a PSP settlement split and the funds have moved from the Holding Account into the seller's connected account wallet (CREDIT split) or vice versa (DEBIT split). | psp_settlement_split.settled | No action needed. |
| FAILED | Platform has released a PSP settlement split but the settlement has failed. | psp_settlement_split.failed | See Release settlement split for information on how to handle release failure notifications. |
| CANCELLED | The PSP settlement split has been cancelled as the platform shared incorrect data with Airwallex or because it was a duplicate. | psp_settlement_split.cancelled | If cancelled due to incorrect data then you can create a new settlement split immediately after cancellation. See Cancel a PSP settlement split. |
You can subscribe to PSP Settlement Split webhooks to receive notifications on these status transitions.
PSP settlement deposit
Status transitions for a PSP settlement deposit object during settlement handling.
| Status | Description | Emitted webhook | Next steps |
|---|---|---|---|
| NEW | Airwallex has successfully created the PSP settlement deposit object. This occurs when the acquiring PSP deposits the funds to a Global Account connected to the platform's Holding Account using a predetermined settlement reference in the bank transfer description. | psp_settlement_deposit.new | No action needed. |
| ACTION_REQUIRED | Unsuccessful match between the deposit and PSP settlement intents. | psp_settlement_deposit.action_required | For information on the types of unsuccessful matches and how to troubleshoot, see Failure notifications. |
| MATCHED | The amount of the PSP settlement deposits matches the amount of the associated PSP settlement intent. | psp_settlement_deposit.matched | You can proceed to release settlement splits comprising this intent. See Release settlement split. |
| SETTLED | Platform has successfully released all the PSP settlement splits comprising the intent and the funds have moved from the Holding Account into the sellers' connected account wallets. | psp_settlement_deposit.settled | Pay out funds from the sellers’ connected accounts to their external bank accounts whenever you choose. |
You can subscribe to PSP Settlement Deposit webhooks to receive notifications on these status transitions.
Linked statuses
- When a PSP settlement intent is cancelled (status
CANCELLED), the associated PSP settlement splits are also set toCANCELLEDbut thepsp_settlement_split.cancelledwebhook is not sent. - When the amount of the PSP settlement deposits matches the associated PSP settlement intent, the status of the matched intent, splits, and deposits will all be simultaneously changed to
MATCHED, and webhooks of typematchedwill be sent for all objects. - When all PSP settlement splits are settled, the intent and deposit statuses simultaneously change to
SETTLED.