Skip to content
GitHub

Enums

Alg

Values

ValueDescription
EdDSA

EdDSA cryptographic algorithm.

Crv

Values

ValueDescription
Ed25519

Elliptic curve Ed25519, used in EdDSA.

FeeType

Values

ValueDescription
SENDING

The sender is responsible for paying the fees.

RECEIVING

The receiver is responsible for paying the fees.

IncomingPaymentState

Values

ValueDescription
PENDING

The payment is pending when it is initially created and has not started processing.

PROCESSING

The payment is being processed after funds have started clearing into the account.

COMPLETED

The payment is completed automatically once the expected incomingAmount is received or manually via an API call.

EXPIRED

The payment has expired before completion, and no further funds will be accepted.

Kty

Values

ValueDescription
OKP

Octet Key Pair (OKP) key type.

LiquidityError

Values

ValueDescription
AlreadyPosted

The transfer has already been posted.

AlreadyVoided

The transfer has already been voided.

AmountZero

The amount specified for the transfer is zero.

InsufficientBalance

Insufficient balance to complete the transfer.

InvalidId

The provided ID for the transfer is invalid.

TransferExists

A transfer with the same ID already exists.

UnknownAsset

The specified asset could not be found.

UnknownIncomingPayment

The specified incoming payment could not be found.

UnknownPayment

The specified payment could not be found.

UnknownWalletAddress

The specified wallet address could not be found.

UnknownPeer

The specified peer could not be found.

UnknownTransfer

The specified transfer could not be found.

OutgoingPaymentState

Values

ValueDescription
FUNDING

The payment is reserving funds and will transition to SENDING once funds are secured.

SENDING

The payment is in progress and will transition to COMPLETED upon success.

COMPLETED

The payment has been successfully completed.

FAILED

The payment has failed.

CANCELLED

The payment has been canceled.

PaymentType

Values

ValueDescription
INCOMING

Represents an incoming payment.

OUTGOING

Represents an outgoing payment.

SortOrder

Values

ValueDescription
ASC

Sort the results in ascending order.

DESC

Sort the results in descending order.

TransferState

Values

ValueDescription
PENDING

The accounting transfer is pending

POSTED

The accounting transfer is posted

VOIDED

The accounting transfer is voided

TransferType

Values

ValueDescription
DEPOSIT

Represents a deposit transfer.

WITHDRAWAL

Represents a withdrawal transfer.

TRANSFER

Represents a generic transfer within Rafiki.

WalletAddressStatus

Values

ValueDescription
INACTIVE

The status after deactivating a wallet address.

ACTIVE

The default status of a wallet address.