Skip to main content

Enums

IncomingPaymentState

Values

ValueDescription
PENDING

The payment has a state of PENDING when it is initially created.

PROCESSING

As soon as payment has started (funds have cleared into the account) the state moves to PROCESSING

COMPLETED

The payment is either auto-completed once the received amount equals the expected incomingAmount, or it is completed manually via an API call.

EXPIRED

If the payment expires before it is completed then the state will move to EXPIRED and no further payments will be accepted.

LiquidityError

Values

ValueDescription
AlreadyCommitted
AlreadyRolledBack
AmountZero
InsufficientBalance
InvalidId
TransferExists
UnknownAsset
UnknownIncomingPayment
UnknownPayment
UnknownPaymentPointer
UnknownPeer
UnknownTransfer

OutgoingPaymentState

Values

ValueDescription
FUNDING

Will transition to SENDING once payment funds are reserved

SENDING

Paying, will transition to COMPLETED on success

COMPLETED

Successful completion

FAILED

Payment failed