Skip to content
Rafiki
GitHub

Mutations

addAssetLiquidity

Type: LiquidityMutationResponse

Add asset liquidity

Arguments

NameDescription
input
AddAssetLiquidityInput!

addPeerLiquidity

Type: LiquidityMutationResponse

Add peer liquidity

Arguments

NameDescription
input
AddPeerLiquidityInput!

createAsset

Type: AssetMutationResponse!

Create an asset

Arguments

NameDescription
input
CreateAssetInput!

createAssetLiquidityWithdrawal

Type: LiquidityMutationResponse

Withdraw asset liquidity

Arguments

NameDescription
input
CreateAssetLiquidityWithdrawalInput!

createIncomingPayment

Type: IncomingPaymentResponse!

Create an internal Open Payments Incoming Payment. The receiver has a payment pointer on this Rafiki instance.

Arguments

NameDescription
input
CreateIncomingPaymentInput!

createOrUpdatePeerByUrl

Type: CreateOrUpdatePeerByUrlMutationResponse!

Create a peer using a URL

Arguments

NameDescription
input
CreateOrUpdatePeerByUrlInput!

createOutgoingPayment

Type: OutgoingPaymentResponse!

Create an Open Payments Outgoing Payment

Arguments

NameDescription
input
CreateOutgoingPaymentInput!

createPaymentPointer

Type: CreatePaymentPointerMutationResponse!

Create a payment pointer

Arguments

NameDescription
input
CreatePaymentPointerInput!

createPaymentPointerKey

Type: CreatePaymentPointerKeyMutationResponse

Add a public key to a payment pointer that is used to verify Open Payments requests.

Arguments

NameDescription
input
CreatePaymentPointerKeyInput!

createPaymentPointerWithdrawal

Type: PaymentPointerWithdrawalMutationResponse

Withdraw liquidity from a payment pointer received via Web Monetization.

Arguments

NameDescription
input
CreatePaymentPointerWithdrawalInput!

createPeer

Type: CreatePeerMutationResponse!

Create a peer

Arguments

NameDescription
input
CreatePeerInput!

createPeerLiquidityWithdrawal

Type: LiquidityMutationResponse

Withdraw peer liquidity

Arguments

NameDescription
input
CreatePeerLiquidityWithdrawalInput!

createQuote

Type: QuoteResponse!

Create an Open Payments Quote

Arguments

NameDescription
input
CreateQuoteInput!

createReceiver

Type: CreateReceiverResponse!

Create an internal or external Open Payments Incoming Payment. The receiver has a payment pointer on either this or another Open Payments resource server.

Arguments

NameDescription
input
CreateReceiverInput!

deletePeer

Type: DeletePeerMutationResponse!

Delete a peer

Arguments

NameDescription
input
DeletePeerInput!

depositEventLiquidity

Type: LiquidityMutationResponse

Deposit webhook event liquidity

Arguments

NameDescription
input
DepositEventLiquidityInput!

postLiquidityWithdrawal

Type: LiquidityMutationResponse

Post liquidity withdrawal. Withdrawals are two-phase commits and are committed via this mutation.

Arguments

NameDescription
input
PostLiquidityWithdrawalInput!

revokePaymentPointerKey

Type: RevokePaymentPointerKeyMutationResponse

Revoke a public key associated with a payment pointer. Open Payment requests using this key for request signatures will be denied going forward.

Arguments

NameDescription
input
RevokePaymentPointerKeyInput!

setFee

Type: SetFeeResponse!

Set the fee on an asset

Arguments

NameDescription
input
SetFeeInput!

triggerPaymentPointerEvents

Type: TriggerPaymentPointerEventsMutationResponse!

If automatic withdrawal of funds received via Web Monetization by the payment pointer are disabled, this mutation can be used to trigger up to n withdrawal events.

Arguments

NameDescription
input
TriggerPaymentPointerEventsInput!

updateAsset

Type: AssetMutationResponse!

Update an asset

Arguments

NameDescription
input
UpdateAssetInput!

updatePaymentPointer

Type: UpdatePaymentPointerMutationResponse!

Update a payment pointer

Arguments

NameDescription
input
UpdatePaymentPointerInput!

updatePeer

Type: UpdatePeerMutationResponse!

Update a peer

Arguments

NameDescription
input
UpdatePeerInput!

voidLiquidityWithdrawal

Type: LiquidityMutationResponse

Void liquidity withdrawal. Withdrawals are two-phase commits and are rolled back via this mutation.

Arguments

NameDescription
input
VoidLiquidityWithdrawalInput!

withdrawEventLiquidity

Type: LiquidityMutationResponse

Withdraw webhook event liquidity

Arguments

NameDescription
input
WithdrawEventLiquidityInput!