Skip to content
GitHub

Mutations

Type: ApproveIncomingPaymentResponse!

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

Arguments

NameDescription
input
ApproveIncomingPaymentInput!

Type: CancelIncomingPaymentResponse!

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

Arguments

NameDescription
input
CancelIncomingPaymentInput!

Type: OutgoingPaymentResponse!

Cancel an outgoing payment.

Arguments

NameDescription
input
CancelOutgoingPaymentInput!

Type: AssetMutationResponse!

Create a new asset.

Arguments

NameDescription
input
CreateAssetInput!

Type: LiquidityMutationResponse

Withdraw asset liquidity.

Arguments

NameDescription
input
CreateAssetLiquidityWithdrawalInput!

Type: IncomingPaymentResponse!

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

Arguments

NameDescription
input
CreateIncomingPaymentInput!

Type: LiquidityMutationResponse

Withdraw incoming payment liquidity.

Arguments

NameDescription
input
CreateIncomingPaymentWithdrawalInput!

Type: CreateOrUpdatePeerByUrlMutationResponse!

Create or update a peer using a URL.

Arguments

NameDescription
input
CreateOrUpdatePeerByUrlInput!

Type: OutgoingPaymentResponse!

Create an Open Payments outgoing payment.

Arguments

NameDescription
input
CreateOutgoingPaymentInput!

Type: OutgoingPaymentResponse!

Create an Open Payments outgoing payment from an incoming payment.

Arguments

NameDescription
input
CreateOutgoingPaymentFromIncomingPaymentInput!

Type: LiquidityMutationResponse

Withdraw outgoing payment liquidity.

Arguments

NameDescription
input
CreateOutgoingPaymentWithdrawalInput!

Type: CreatePeerMutationResponse!

Create a new peer.

Arguments

NameDescription
input
CreatePeerInput!

Type: LiquidityMutationResponse

Withdraw peer liquidity.

Arguments

NameDescription
input
CreatePeerLiquidityWithdrawalInput!

Type: QuoteResponse!

Create an Open Payments quote.

Arguments

NameDescription
input
CreateQuoteInput!

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

NameDescription
input
CreateReceiverInput!

Type: CreateWalletAddressMutationResponse!

Create a new wallet address.

Arguments

NameDescription
input
CreateWalletAddressInput!

Type: CreateWalletAddressKeyMutationResponse

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

Arguments

NameDescription
input
CreateWalletAddressKeyInput!

Type: WalletAddressWithdrawalMutationResponse

Withdraw liquidity from a wallet address received via Web Monetization.

Arguments

NameDescription
input
CreateWalletAddressWithdrawalInput!

Type: DeleteAssetMutationResponse!

Delete an asset.

Arguments

NameDescription
input
DeleteAssetInput!

Type: DeletePeerMutationResponse!

Delete a peer.

Arguments

NameDescription
input
DeletePeerInput!

Type: LiquidityMutationResponse

Deposit asset liquidity.

Arguments

NameDescription
input
DepositAssetLiquidityInput!

Type: LiquidityMutationResponse

Deprecated: Use depositOutgoingPaymentLiquidity

Deposit webhook event liquidity (deprecated).

Arguments

NameDescription
input
DepositEventLiquidityInput!

Type: LiquidityMutationResponse

Deposit outgoing payment liquidity.

Arguments

NameDescription
input
DepositOutgoingPaymentLiquidityInput!

Type: LiquidityMutationResponse

Deposit peer liquidity.

Arguments

NameDescription
input
DepositPeerLiquidityInput!

Type: LiquidityMutationResponse

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

Arguments

NameDescription
input
PostLiquidityWithdrawalInput!

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

NameDescription
input
RevokeWalletAddressKeyInput!

Type: SetFeeResponse!

Set the fee structure on an asset.

Arguments

NameDescription
input
SetFeeInput!

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

NameDescription
input
TriggerWalletAddressEventsInput!

Type: AssetMutationResponse!

Update an existing asset.

Arguments

NameDescription
input
UpdateAssetInput!

Type: IncomingPaymentResponse!

Update an existing incoming payment.

Arguments

NameDescription
input
UpdateIncomingPaymentInput!

Type: UpdatePeerMutationResponse!

Update an existing peer.

Arguments

NameDescription
input
UpdatePeerInput!

Type: UpdateWalletAddressMutationResponse!

Update an existing wallet address.

Arguments

NameDescription
input
UpdateWalletAddressInput!

Type: LiquidityMutationResponse

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

Arguments

NameDescription
input
VoidLiquidityWithdrawalInput!

Type: LiquidityMutationResponse

Deprecated: Use createOutgoingPaymentWithdrawal, createIncomingPaymentWithdrawal, or createWalletAddressWithdrawal

Withdraw webhook event liquidity (deprecated).

Arguments

NameDescription
input
WithdrawEventLiquidityInput!