Mutations

approveIncomingPayment

Type: ApproveIncomingPaymentResponse!

Approves the incoming payment if the incoming payment is in the PENDING state

Arguments

Name	Description
input ApproveIncomingPaymentInput!

cancelIncomingPayment

Type: CancelIncomingPaymentResponse!

Cancel the incoming payment if the incoming payment is in the PENDING state

Arguments

Name	Description
input CancelIncomingPaymentInput!

cancelOutgoingPayment

Type: OutgoingPaymentResponse!

Cancel an outgoing payment.

Arguments

Name	Description
input CancelOutgoingPaymentInput!

createAsset

Type: AssetMutationResponse!

Create a new 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!

createIncomingPaymentWithdrawal

Type: LiquidityMutationResponse

Withdraw incoming payment liquidity.

Arguments

Name	Description
input CreateIncomingPaymentWithdrawalInput!

createOrUpdatePeerByUrl

Type: CreateOrUpdatePeerByUrlMutationResponse!

Create or update 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!

createOutgoingPaymentWithdrawal

Type: LiquidityMutationResponse

Withdraw outgoing payment liquidity.

Arguments

Name	Description
input CreateOutgoingPaymentWithdrawalInput!

createPeer

Type: CreatePeerMutationResponse!

Create a new 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!

createTenant

Type: TenantMutationResponse!

As an operator, create a tenant.

Arguments

Name	Description
input CreateTenantInput!

createTenantSettings

Type: CreateTenantSettingsMutationResponse

Arguments

Name	Description
input CreateTenantSettingsInput!

createWalletAddress

Type: CreateWalletAddressMutationResponse!

Create a new 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!

deleteAsset

Type: DeleteAssetMutationResponse!

Delete an asset.

Arguments

Name	Description
input DeleteAssetInput!

deletePeer

Type: DeletePeerMutationResponse!

Delete a peer.

Arguments

Name	Description
input DeletePeerInput!

deleteTenant

Type: DeleteTenantMutationResponse!

Delete a tenant.

Arguments

Name	Description
id String!

depositAssetLiquidity

Type: LiquidityMutationResponse

Deposit asset liquidity.

Arguments

Name	Description
input DepositAssetLiquidityInput!

depositEventLiquidity

Type: LiquidityMutationResponse

Deprecated: Use depositOutgoingPaymentLiquidity

Deposit webhook event liquidity (deprecated).

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 structure 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 existing asset.

Arguments

Name	Description
input UpdateAssetInput!

updateIncomingPayment

Type: IncomingPaymentResponse!

Update an existing incoming payment.

Arguments

Name	Description
input UpdateIncomingPaymentInput!

updatePeer

Type: UpdatePeerMutationResponse!

Update an existing peer.

Arguments

Name	Description
input UpdatePeerInput!

updateTenant

Type: TenantMutationResponse!

Update a tenant.

Arguments

Name	Description
input UpdateTenantInput!

updateWalletAddress

Type: UpdateWalletAddressMutationResponse!

Update an existing 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 createOutgoingPaymentWithdrawal, createIncomingPaymentWithdrawal, or createWalletAddressWithdrawal

Withdraw webhook event liquidity (deprecated).

Arguments

Name	Description
input WithdrawEventLiquidityInput!