Mutations

createAsset

Create an asset

Arguments

Name	Description
input `CreateAssetInput!`

createAssetLiquidityWithdrawal

Type: LiquidityMutationResponse

Withdraw asset liquidity

Arguments

Name	Description
input `CreateAssetLiquidityWithdrawalInput!`

createIncomingPayment

Type: IncomingPaymentResponse!

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

Arguments

Name	Description
input `CreateIncomingPaymentInput!`

createOrUpdatePeerByUrl

Type: CreateOrUpdatePeerByUrlMutationResponse!

Create a peer using a URL

Arguments

Name	Description
input `CreateOrUpdatePeerByUrlInput!`

createOutgoingPayment

Type: OutgoingPaymentResponse!

Create an Open Payments Outgoing Payment

Arguments

Name	Description
input `CreateOutgoingPaymentInput!`

createOutgoingPaymentFromIncomingPayment

Type: OutgoingPaymentResponse!

Create an Open Payments Outgoing Payment from an incoming payment

Arguments

Name	Description
input `CreateOutgoingPaymentFromIncomingPaymentInput!`

createPeer

Type: CreatePeerMutationResponse!

Create a peer

Arguments

Name	Description
input `CreatePeerInput!`

createPeerLiquidityWithdrawal

Type: LiquidityMutationResponse

Withdraw peer liquidity

Arguments

Name	Description
input `CreatePeerLiquidityWithdrawalInput!`

createQuote

Type: QuoteResponse!

Create an Open Payments Quote

Arguments

Name	Description
input `CreateQuoteInput!`

createReceiver

Type: CreateReceiverResponse!

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

Arguments

Name	Description
input `CreateReceiverInput!`

createWalletAddress

Type: CreateWalletAddressMutationResponse!

Create a wallet address

Arguments

Name	Description
input `CreateWalletAddressInput!`

createWalletAddressKey

Type: CreateWalletAddressKeyMutationResponse

Add a public key to a wallet address that is used to verify Open Payments requests.

Arguments

Name	Description
input `CreateWalletAddressKeyInput!`

createWalletAddressWithdrawal

Type: WalletAddressWithdrawalMutationResponse

Withdraw liquidity from a wallet address received via Web Monetization.

Arguments

Name	Description
input `CreateWalletAddressWithdrawalInput!`

deletePeer

Type: DeletePeerMutationResponse!

Delete a peer

Arguments

Name	Description
input `DeletePeerInput!`

depositAssetLiquidity

Type: LiquidityMutationResponse

Deposit asset liquidity

Arguments

Name	Description
input `DepositAssetLiquidityInput!`

depositEventLiquidity

Type: LiquidityMutationResponse

Deprecated: Use depositOutgoingPaymentLiquidity

Deposit webhook event liquidity

Arguments

Name	Description
input `DepositEventLiquidityInput!`

depositOutgoingPaymentLiquidity

Type: LiquidityMutationResponse

Deposit outgoing payment liquidity

Arguments

Name	Description
input `DepositOutgoingPaymentLiquidityInput!`

depositPeerLiquidity

Type: LiquidityMutationResponse

Deposit peer liquidity

Arguments

Name	Description
input `DepositPeerLiquidityInput!`

postLiquidityWithdrawal

Type: LiquidityMutationResponse

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

Arguments

Name	Description
input `PostLiquidityWithdrawalInput!`

revokeWalletAddressKey

Type: RevokeWalletAddressKeyMutationResponse

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

Arguments

Name	Description
input `RevokeWalletAddressKeyInput!`

setFee

Type: SetFeeResponse!

Set the fee on an asset

Arguments

Name	Description
input `SetFeeInput!`

triggerWalletAddressEvents

Type: TriggerWalletAddressEventsMutationResponse!

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

Arguments

Name	Description
input `TriggerWalletAddressEventsInput!`

updateAsset

Type: AssetMutationResponse!

Update an asset

Arguments

Name	Description
input `UpdateAssetInput!`

updatePeer

Type: UpdatePeerMutationResponse!

Update a peer

Arguments

Name	Description
input `UpdatePeerInput!`

updateWalletAddress

Type: UpdateWalletAddressMutationResponse!

Update a wallet address

Arguments

Name	Description
input `UpdateWalletAddressInput!`

voidLiquidityWithdrawal

Type: LiquidityMutationResponse

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

Arguments

Name	Description
input `VoidLiquidityWithdrawalInput!`

withdrawEventLiquidity

Type: LiquidityMutationResponse

Deprecated: Use withdrawOutgoingPaymentLiquidity, withdrawIncomingPaymentLiquidity, or createWalletAddressWithdrawal

Withdraw webhook event liquidity

Arguments

Name	Description
input `WithdrawEventLiquidityInput!`

withdrawIncomingPaymentLiquidity

Type: LiquidityMutationResponse

Withdraw incoming payment liquidity

Arguments

Name	Description
input `WithdrawIncomingPaymentLiquidityInput!`

withdrawOutgoingPaymentLiquidity

Type: LiquidityMutationResponse

Withdraw outgoing payment liquidity

Arguments

Name	Description
input `WithdrawOutgoingPaymentLiquidityInput!`