API ReferenceIntegrationsKnowledge Base

Payout Links Life Cycle

A Payout Link can have the following statuses during its life cycle:

Issued🔗

This is the first state a Payout Link acquires when you create and send it to your Contact. The Payout Link remains in the issued state until your Contact takes any action.

From the issued state, a Payout Link can move to the following states:

  • processing: moves to this state when your Contact provides their Fund account details.
  • cancelled: moves to this state when you cancel the Payout Link.

Processing🔗

A Payout Link moves to this state from the issued state when your Contact provides their Fund account details. From the processing state, a Payout Link moves to the following states:

  • processed: moves to this state when the payout to your contact is completed.
  • issued: moves to this state if the underlying Payout fails. The Contact can try to enter their Fund account details again. No action is required by you.

Processed🔗

A Payout Link moves to this state from the processing state when the payout to your contact is completed. This is the last state of the Payout Link.

Cancelled🔗

A Payout Link moves to this state if you cancel it. A Payout Link can move to this state from the issued state.

This is a last state for the Payout Link.

Expired🔗

A payout link moves to this state when the payout amount is not claimed by your contact within the stipulated date and time. A payout link that has expired can be duplicated to create another payout link without having to enter contact or amount details.

Payout Life Cycle🔗

Once your contact clicks on a payout link and enters their details, a payout is created. These payouts an have the following statuses during its life cycle:

  • pending
  • queued
  • processing
  • processed
  • reversed
  • cancelled
  • rejected
  • failed

Refer to Payout Life Cycle and States for more information.

×