Skip to main content

Documentation

Escrow Finite State Diagram

Statuses and transitions for escrows.

States

  • pending (initial)

  • on_hold

  • released (final)

  • canceled (final)

Transitions

Transition number

Start state

End state

Description

1

start

pending

The escrow is created with 'Create Payment'.

2

pending

on_hold

The payment is completed and funds are placed into the received balance of the wallet.

3

on_hold

released

The escrow is released by 'Release Funds from Escrow' or expiration of time set in escrow_release_days when the payment was created. The funds are transferred from received balance to available balance.

4

pending

canceled

The payment fails to complete because of cancellation, error, expiration or reversal.