Skip to main content

Interface: IEscrowStatus

Full status of a payment

Example

// A returned object might look e.g. like this:
{
   state: "Paid",
   latestChallengeBy: null,
   latestSettlementOfferBy: null,
   claimed: false
},

Properties​

claimed​

• claimed: boolean

True if the payment was already withdrawn from the escrow

Defined in​

typing/index.ts:88

latestChallengeBy​

• latestChallengeBy: tEscrowParty

Who sent the latest challenge ('buyer', 'seller', or null when there's been no challenge)

Defined in​

typing/index.ts:90

latestSettlementOfferBy​

• latestSettlementOfferBy: tEscrowParty

Who sent the latest settlement offer ('buyer', 'seller', or null if there's been no offer)

Defined in​

typing/index.ts:92

state​

• state: EscrowStatus

The current state of an escrow ('Paid' | 'Unpaid' | 'Released' | 'Period Expired' | 'Refunded' | 'Challenged' | 'Settled').

Defined in​

typing/index.ts:86