Skip to main content

Mutations

addAssetLiquidity

Type: LiquidityMutationResponse

Add asset liquidity

Arguments

NameDescription
input
AddAssetLiquidityInput!

addKeyToClient

Type: AddKeyToClientMutationResponse

Add Key to Client

Arguments

NameDescription
input
AddKeyToClientInput!

addPeerLiquidity

Type: LiquidityMutationResponse

Add peer liquidity

Arguments

NameDescription
input
AddPeerLiquidityInput!

createApiKey

Type: CreateApiKeyMutationResponse

Create API Key

Arguments

NameDescription
input
CreateApiKeyInput!

createAsset

Type: AssetMutationResponse!

Create asset

Arguments

NameDescription
input
CreateAssetInput!

createAssetLiquidityWithdrawal

Type: LiquidityMutationResponse

Create liquidity withdrawal from asset

Arguments

NameDescription
input
CreateAssetLiquidityWithdrawalInput!

createClient

Type: CreateClientMutationResponse

Create Client

Arguments

NameDescription
input
CreateClientInput!

createIncomingPayment

Type: IncomingPaymentResponse!

Arguments

NameDescription
input
CreateIncomingPaymentInput!

createOutgoingPayment

Type: OutgoingPaymentResponse!

Arguments

NameDescription
input
CreateOutgoingPaymentInput!

createPaymentPointer

Type: CreatePaymentPointerMutationResponse!

Arguments

NameDescription
input
CreatePaymentPointerInput!

createPaymentPointerWithdrawal

Type: PaymentPointerWithdrawalMutationResponse

Create liquidity withdrawal from Open Payments payment pointer

Arguments

NameDescription
input
CreatePaymentPointerWithdrawalInput!

createPeer

Type: CreatePeerMutationResponse!

Create peer

Arguments

NameDescription
input
CreatePeerInput!

createPeerLiquidityWithdrawal

Type: LiquidityMutationResponse

Create liquidity withdrawal from peer

Arguments

NameDescription
input
CreatePeerLiquidityWithdrawalInput!

createQuote

Type: QuoteResponse!

Arguments

NameDescription
input
CreateQuoteInput!

deleteAllApiKeys

Type: DeleteAllApiKeysMutationResponse

Delete all API Keys

Arguments

NameDescription
input
DeleteAllApiKeysInput!

deletePeer

Type: DeletePeerMutationResponse!

Delete peer

Arguments

NameDescription
id
String!

depositEventLiquidity

Type: LiquidityMutationResponse

Deposit webhook event liquidity

Arguments

NameDescription
eventId
String!

finalizeLiquidityWithdrawal

Type: LiquidityMutationResponse

Finalize liquidity withdrawal

Arguments

NameDescription
withdrawalId
String!

The id of the liquidity withdrawal to finalize.

redeemApiKey

Type: RedeemApiKeyMutationResponse

Redeem API Key

Arguments

NameDescription
input
RedeemApiKeyInput!

refreshSession

Type: RefreshSessionMutationResponse

Refresh Session

Arguments

NameDescription
input
RefreshSessionInput!

revokeClientKey

Type: RevokeClientKeyMutationResponse

Arguments

NameDescription
keyId
String!

revokeSession

Type: RevokeSessionMutationResponse

Revoke Session

Arguments

NameDescription
input
RevokeSessionInput!

rollbackLiquidityWithdrawal

Type: LiquidityMutationResponse

Rollback liquidity withdrawal

Arguments

NameDescription
withdrawalId
String!

The id of the liquidity withdrawal to rollback.

triggerPaymentPointerEvents

Type: TriggerPaymentPointerEventsMutationResponse!

Arguments

NameDescription
limit
Int!

updateAssetWithdrawalThreshold

Type: AssetMutationResponse!

Update asset withdrawal threshold

Arguments

NameDescription
input
UpdateAssetInput!

updatePeer

Type: UpdatePeerMutationResponse!

Update peer

Arguments

NameDescription
input
UpdatePeerInput!

withdrawEventLiquidity

Type: LiquidityMutationResponse

Withdraw webhook event liquidity

Arguments

NameDescription
eventId
String!