Skip to main content

Input objects

AddAssetLiquidityInput

Arguments

NameDescription
assetId
String!

The id of the asset to add liquidity.

amount
UInt64!

Amount of liquidity to add.

id
String!

The id of the transfer.

AddKeyToClientInput

Arguments

NameDescription
id
String!
clientId
String!
jwk
String!

AddPeerLiquidityInput

Arguments

NameDescription
peerId
String!

The id of the peer to add liquidity.

amount
UInt64!

Amount of liquidity to add.

id
String!

The id of the transfer.

AmountInput

Arguments

NameDescription
value
UInt64!
assetCode
String!
assetScale
Int!

AssetInput

Arguments

NameDescription
code
String!
scale
Int!

CreateApiKeyInput

Arguments

NameDescription
paymentPointerId
String!

Payment pointer API key is created for.

CreateAssetInput

Arguments

NameDescription
code
String!
scale
Int!
withdrawalThreshold
UInt64

CreateAssetLiquidityWithdrawalInput

Arguments

NameDescription
assetId
String!

The id of the asset to create the withdrawal for.

amount
UInt64!

Amount of withdrawal.

id
String!

The id of the withdrawal.

CreateClientInput

Arguments

NameDescription
name
String!
uri
String!
image
String!
email
String!

CreateIncomingPaymentInput

Arguments

NameDescription
paymentPointerId
String!
expiresAt
String
description
String
incomingAmount
AmountInput
externalRef
String

CreateOutgoingPaymentInput

Arguments

NameDescription
paymentPointerId
String!
quoteId
String!
description
String
externalRef
String

CreatePaymentPointerInput

Arguments

NameDescription
asset
AssetInput!
url
String!
publicName
String

CreatePaymentPointerWithdrawalInput

Arguments

NameDescription
paymentPointerId
String!

The id of the Open Payments payment pointer to create the withdrawal for.

id
String!

The id of the withdrawal.

CreatePeerInput

Arguments

NameDescription
maxPacketAmount
UInt64
http
HttpInput!
asset
AssetInput!
staticIlpAddress
String!

CreatePeerLiquidityWithdrawalInput

Arguments

NameDescription
peerId
String!

The id of the peer to create the withdrawal for.

amount
UInt64!

Amount of withdrawal.

id
String!

The id of the withdrawal.

CreateQuoteInput

Arguments

NameDescription
paymentPointerId
String!
sendAmount
AmountInput
receiveAmount
AmountInput
receiver
String!

DeleteAllApiKeysInput

Arguments

NameDescription
paymentPointerId
String!

Payment pointer API keys are deleted from.

HttpIncomingInput

Arguments

NameDescription
authTokens
[String!]!

HttpInput

Arguments

NameDescription
incoming
HttpIncomingInput
outgoing
HttpOutgoingInput!

HttpOutgoingInput

Arguments

NameDescription
authToken
String!
endpoint
String!

RedeemApiKeyInput

Arguments

NameDescription
key
String!

API key

paymentPointerId
String!

Payment pointer API key was issued for.

RefreshSessionInput

Arguments

NameDescription
key
String!

Session key

RevokeSessionInput

Arguments

NameDescription
key
String!

Session key

UpdateAssetInput

Arguments

NameDescription
id
String!
withdrawalThreshold
UInt64

UpdatePeerInput

Arguments

NameDescription
id
String!
maxPacketAmount
UInt64
http
HttpInput
staticIlpAddress
String