diff --git a/packages/documentation/package.json b/packages/documentation/package.json
index e3cfbed54f..4b83dcad06 100644
--- a/packages/documentation/package.json
+++ b/packages/documentation/package.json
@@ -5,7 +5,7 @@
"scripts": {
"start": "astro dev",
"build:docs": "astro build",
- "build:docs:graphql": "spectaql config-auth.yml && spectaql config-backend.yml",
+ "build:docs:graphql": "spectaql ./spectaql/config-auth.yml && spectaql ./spectaql/config-auth-es.yml && spectaql ./spectaql/config-backend.yml && spectaql ./spectaql/config-backend-es.yml",
"preview": "astro preview",
"astro": "astro",
"format": "prettier --write '**/*.{js,mjs,ts,tsx,json,md,mdx,astro}' && eslint --max-warnings=0 --fix .",
diff --git a/packages/documentation/spectaql/config-auth-es.yml b/packages/documentation/spectaql/config-auth-es.yml
new file mode 100644
index 0000000000..bf1eb4663b
--- /dev/null
+++ b/packages/documentation/spectaql/config-auth-es.yml
@@ -0,0 +1,31 @@
+spectaql:
+ oneFile: true
+ targetDir: ./src/pages/es/apis/graphql/auth
+ logoFile: ./public/img/logo.png
+ embedLogo: true
+ faviconUrl: /favicon.svg
+ displayAllServers: true
+
+introspection:
+ removeTrailingPeriodFromDescriptions: false
+ schemaFile: '../auth/src/graphql/schema.graphql'
+ queryNameStrategy: capitalizeFirst
+ fieldExpansionDepth: 2
+
+ spectaqlDirective:
+ enable: true
+
+extensions:
+ graphqlScalarExamples: true
+
+info:
+ title: Auth Admin API
+ description: The Auth Admin API allows you to get information about a grant, such as its status, state, related payment details, and the wallet address of the grantee’s account. The API also allows you to revoke grants.
+ x-introItems:
+ - title: Back to documentation
+ url: /es/overview/overview
+ x-hidePoweredBy: true
+
+servers:
+ - url: https://staging.example.com/graphql
+ description: Staging
diff --git a/packages/documentation/config-auth.yml b/packages/documentation/spectaql/config-auth.yml
similarity index 100%
rename from packages/documentation/config-auth.yml
rename to packages/documentation/spectaql/config-auth.yml
diff --git a/packages/documentation/spectaql/config-backend-es.yml b/packages/documentation/spectaql/config-backend-es.yml
new file mode 100644
index 0000000000..bf3970bc8e
--- /dev/null
+++ b/packages/documentation/spectaql/config-backend-es.yml
@@ -0,0 +1,31 @@
+spectaql:
+ oneFile: true
+ targetDir: ./src/pages/es/apis/graphql/backend
+ logoFile: ./public/img/logo.png
+ embedLogo: true
+ faviconUrl: /favicon.svg
+ displayAllServers: true
+
+introspection:
+ removeTrailingPeriodFromDescriptions: false
+ schemaFile: '../backend/src/graphql/schema.graphql'
+ queryNameStrategy: capitalizeFirst
+ fieldExpansionDepth: 2
+
+ spectaqlDirective:
+ enable: true
+
+extensions:
+ graphqlScalarExamples: true
+
+info:
+ title: Backend Admin API
+ description: The Backend Admin API provides you with comprehensive capabilities to manage your Rafiki instance. Core functionality includes managing peering relationships, assets, wallet addresses and their public keys, as well as liquidity management through deposits and withdrawals. Another important aspect of the Backend Admin API is to manage Open Payments resources like payments and quotes.
+ x-introItems:
+ - title: Back to documentation
+ url: /es/overview/overview
+ x-hidePoweredBy: true
+
+servers:
+ - url: https://staging.example.com/graphql
+ description: Staging
diff --git a/packages/documentation/config-backend.yml b/packages/documentation/spectaql/config-backend.yml
similarity index 100%
rename from packages/documentation/config-backend.yml
rename to packages/documentation/spectaql/config-backend.yml
diff --git a/packages/documentation/src/pages/apis/graphql/auth/index.html b/packages/documentation/src/pages/apis/graphql/auth/index.html
index b1e3723fcd..63dd3c61e6 100644
--- a/packages/documentation/src/pages/apis/graphql/auth/index.html
+++ b/packages/documentation/src/pages/apis/graphql/auth/index.html
@@ -845,6 +845,8 @@ Types
SortOrder String Subject SubjectItem UInt64 UInt8 Query
}
createdAt
}
+ subject {
+ sub_ids {
+ ...SubjectItemFragment
+ }
+ }
state
finalizationReason
createdAt
@@ -969,7 +976,7 @@ Query
class="example-section example-section-is-code operation-variables-example"
>
Variables
- { "id" : "4" }
+ { "id" : 4 }
Response
"id" : "4" ,
"client" : "xyz789" ,
"access" : [ Access ] ,
+
"subject" : Subject ,
"state" : "PROCESSING" ,
"finalizationReason" : "ISSUED" ,
"createdAt" : "xyz789" ,
-
"tenantId" : 4
+
"tenantId" : "4"
}
}
}
@@ -1191,13 +1199,13 @@
Query
>
Variables
{
- "after" : "xyz789" ,
- "before" : "xyz789" ,
+ "after" : "abc123" ,
+ "before" : "abc123" ,
"first" : 987 ,
- "last" : 987 ,
+ "last" : 123 ,
"filter" : GrantFilter ,
"sortOrder" : "ASC" ,
- "tenantId" : 4
+ "tenantId" : "4"
}
Variables
class="example-section example-section-is-code operation-response-example"
>
Response
- { "data" : { "revokeGrant" : { "id" : "4" } } }
+ { "data" : { "revokeGrant" : { "id" : 4 } } }
Fields
Example
{
- "id" : "4" ,
- "identifier" : "abc123" ,
+ "id" : 4 ,
+ "identifier" : "xyz789" ,
"type" : "abc123" ,
- "actions" : [ "xyz789" ] ,
+ "actions" : [ "abc123" ] ,
"limits" : LimitData ,
- "createdAt" : "xyz789"
+ "createdAt" : "abc123"
}
@@ -1615,7 +1623,7 @@ Fields
Example
-
{ "in" : [ "xyz789" ] }
+ { "in" : [ "abc123" ] }
@@ -1675,6 +1683,20 @@ Fields
Details of the access provided by the grant.
+
+
+ subjectSubject
+ Details of the subject provided by the grant.
+
stateFields
Example
{
- "id" : "4" ,
- "client" : "abc123" ,
+ "id" : 4 ,
+ "client" : "xyz789" ,
"access" : [ Access ] ,
+ "subject" : Subject ,
"state" : "PROCESSING" ,
"finalizationReason" : "ISSUED" ,
- "createdAt" : "xyz789" ,
- "tenantId" : "4"
+ "createdAt" : "abc123" ,
+ "tenantId" : 4
}
@@ -2218,10 +2241,10 @@ Fields
Example
{
- "receiver" : "xyz789" ,
+ "receiver" : "abc123" ,
"debitAmount" : PaymentAmount ,
"receiveAmount" : PaymentAmount ,
- "interval" : "xyz789"
+ "interval" : "abc123"
}
@@ -2302,6 +2325,15 @@ Possible Types
+
+
+
+ SubjectItem
+
+
@@ -2414,8 +2446,8 @@ Example
{
"endCursor" : "xyz789" ,
"hasNextPage" : false ,
- "hasPreviousPage" : false ,
- "startCursor" : "abc123"
+ "hasPreviousPage" : true ,
+ "startCursor" : "xyz789"
}
Fields
Example
-
{ "grantId" : "abc123" }
+ { "grantId" : "xyz789" }
@@ -2595,7 +2627,7 @@ Fields
Example
-
{ "id" : "4" }
+ { "id" : 4 }
@@ -2672,6 +2704,142 @@ Description
+
+
+
+
+
+ Subject
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ sub_ids[SubjectItem!]!
+
+
+
+
+
+
+
+
Example
+
{ "sub_ids" : [ SubjectItem ] }
+
+
+
+
+
+
+ SubjectItem
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ idID!
+ Unique identifier of the subject object.
+
+
+
+ subIdString!
+ Wallet address of the subject's account.
+
+
+
+ subIdFormatString!
+ Format of the subject identifier
+
+
+
+ createdAtString!
+ The date and time when the subject was created.
+
+
+
+
+
+
+
+
Example
+
{
+ "id" : "4" ,
+ "subId" : "xyz789" ,
+ "subIdFormat" : "xyz789" ,
+ "createdAt" : "abc123"
+}
diff --git a/packages/documentation/src/pages/apis/graphql/backend/index.html b/packages/documentation/src/pages/apis/graphql/backend/index.html
index 35b628dbf3..ebb5aa69c7 100644
--- a/packages/documentation/src/pages/apis/graphql/backend/index.html
+++ b/packages/documentation/src/pages/apis/graphql/backend/index.html
@@ -799,6 +799,9 @@
assets incomingPayment
+
+ incomingPayments
+
outgoingPayment
outgoingPayments
@@ -844,6 +847,9 @@
>cancelOutgoingPayment
+
+ completeReceiver
+
createAsset
Types
>CancelOutgoingPaymentInput
+
+ CardDetailsInput
+
+
+ CardPaymentFailureReason
+
+
+ CompleteReceiverInput
+
+
+ CompleteReceiverResponse
+
CreateAssetInput
@@ -1209,6 +1233,11 @@
Types
>IncomingPaymentEdge
+
+ IncomingPaymentFilter
+
IncomingPaymentResponse Query
class="example-section example-section-is-code operation-variables-example"
>
Variables
- { "id" : "abc123" , "limit" : 987 }
+ { "id" : "abc123" , "limit" : 123 }
Query
}
}
createdAt
-
tenantId
+
tenant {
+ id
+ email
+ apiSecret
+ idpConsentUrl
+ idpSecret
+ publicName
+ createdAt
+ deletedAt
+ settings {
+ ...TenantSettingFragment
+ }
+ }
}
}
@@ -1700,7 +1741,7 @@
Response
"data" : {
"asset" : {
"id" : 4 ,
-
"code" : "abc123" ,
+
"code" : "xyz789" ,
"scale" : UInt8 ,
"liquidity" : UInt64 ,
"withdrawalThreshold" : UInt64 ,
@@ -1709,7 +1750,7 @@
Response
"sendingFee" : Fee ,
"fees" : FeesConnection ,
"createdAt" : "xyz789" ,
-
"tenantId" : "4"
+
"tenant" : Tenant
}
}
}
@@ -1835,7 +1876,19 @@
Query
}
}
createdAt
-
tenantId
+
tenant {
+ id
+ email
+ apiSecret
+ idpConsentUrl
+ idpSecret
+ publicName
+ createdAt
+ deletedAt
+ settings {
+ ...TenantSettingFragment
+ }
+ }
}
}
@@ -1845,7 +1898,7 @@
Query
>
Variables
{
- "code" : "abc123" ,
+ "code" : "xyz789" ,
"scale" : UInt8
}
@@ -1857,8 +1910,8 @@
Response
{
"data" : {
"assetByCodeAndScale" : {
- "id" : 4 ,
- "code" : "xyz789" ,
+ "id" : "4" ,
+ "code" : "abc123" ,
"scale" : UInt8 ,
"liquidity" : UInt64 ,
"withdrawalThreshold" : UInt64 ,
@@ -1867,7 +1920,7 @@ Response
"sendingFee" : Fee ,
"fees" : FeesConnection ,
"createdAt" : "abc123" ,
- "tenantId" : 4
+ "tenant" : Tenant
}
}
}
@@ -2059,10 +2112,10 @@ Query
>
Variables
{
- "after" : "xyz789" ,
+ "after" : "abc123" ,
"before" : "xyz789" ,
- "first" : 123 ,
- "last" : 123 ,
+ "first" : 987 ,
+ "last" : 987 ,
"sortOrder" : "ASC" ,
"tenantId" : "xyz789"
}
@@ -2149,6 +2202,7 @@ Query
query IncomingPayment($id : String! ) {
incomingPayment(id: $id ) {
id
+ url
walletAddressId
client
liquidity
@@ -2166,7 +2220,20 @@ Query
}
metadata
createdAt
- tenantId
+ senderWalletAddress
+ tenant {
+ id
+ email
+ apiSecret
+ idpConsentUrl
+ idpSecret
+ publicName
+ createdAt
+ deletedAt
+ settings {
+ ...TenantSettingFragment
+ }
+ }
} Query
class="example-section example-section-is-code operation-variables-example"
>
Variables
- { "id" : "xyz789" }
+ { "id" : "abc123" }
+
+
Response
+
{
+ "data" : {
+ "incomingPayment" : {
+ "id" : 4 ,
+ "url" : "xyz789" ,
+ "walletAddressId" : "4" ,
+ "client" : "xyz789" ,
+ "liquidity" : UInt64 ,
+ "state" : "PENDING" ,
+ "expiresAt" : "abc123" ,
+ "incomingAmount" : Amount ,
+ "receivedAmount" : Amount ,
+ "metadata" : { } ,
+ "createdAt" : "abc123" ,
+ "senderWalletAddress" : "xyz789" ,
+ "tenant" : Tenant
+ }
+ }
+}
+
+
+
+
+
+ incomingPayments
+
+
+
+
+
Description
+
Fetch a paginated list of incoming payments.
+
+
+
+
+
+
+
Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ afterString
+
+ Forward pagination: Cursor (incoming payment ID) to
+ start retrieving incoming payments after this point.
+
+
+
+
+ beforeString
+
+ Backward pagination: Cursor (outgoing payment ID) to
+ start retrieving incoming payments before this point.
+
+
+
+
+ firstInt
+
+ Forward pagination: Limit the result to the first
+ n incoming payments after the
+ after cursor.
+
+
+
+
+ lastInt
+
+ Backward pagination: Limit the result to the last
+ n incoming payments before the
+ before cursor.
+
+
+
+
+ sortOrderSortOrder
+
+ Specify the sort order of incoming payments based on
+ their creation date, either ascending or descending.
+
+
+
+
+ filterIncomingPaymentFilter
+
+ Filter incoming payments based on specific criteria
+ such as initiation reason.
+
+
+
+
+ tenantIdString
+
+ Unique identifier of the tenant associated with the
+ incoming payment. Optional, if not provided, the
+ tenantId will be obtained from the signature.
+
+
+
+
+
+
+
+
Example
+
+
Query
+
query IncomingPayments(
+ $after : String,
+ $before : String,
+ $first : Int,
+ $last : Int,
+ $sortOrder : SortOrder,
+ $filter : IncomingPaymentFilter,
+ $tenantId : String
+ ) {
+ incomingPayments(
+ after: $after ,
+ before: $before ,
+ first: $first ,
+ last: $last ,
+ sortOrder: $sortOrder ,
+ filter: $filter ,
+ tenantId: $tenantId
+ ) {
+ pageInfo {
+ endCursor
+ hasNextPage
+ hasPreviousPage
+ startCursor
+ }
+ edges {
+ node {
+ ...IncomingPaymentFragment
+ }
+ cursor
+ }
+ }
+}
+
+
+
Variables
+
{
+ "after" : "abc123" ,
+ "before" : "xyz789" ,
+ "first" : 123 ,
+ "last" : 987 ,
+ "sortOrder" : "ASC" ,
+ "filter" : IncomingPaymentFilter ,
+ "tenantId" : "xyz789"
+}
Variables
Response
{
"data" : {
- "incomingPayment" : {
- "id" : "4" ,
- "walletAddressId" : "4" ,
- "client" : "abc123" ,
- "liquidity" : UInt64 ,
- "state" : "PENDING" ,
- "expiresAt" : "xyz789" ,
- "incomingAmount" : Amount ,
- "receivedAmount" : Amount ,
- "metadata" : { } ,
- "createdAt" : "xyz789" ,
- "tenantId" : "abc123"
+ "incomingPayments" : {
+ "pageInfo" : PageInfo ,
+ "edges" : [ IncomingPaymentEdge ]
}
}
}
@@ -2308,7 +2604,19 @@ Query
}
createdAt
grantId
- tenantId
+ tenant {
+ id
+ email
+ apiSecret
+ idpConsentUrl
+ idpSecret
+ publicName
+ createdAt
+ deletedAt
+ settings {
+ ...TenantSettingFragment
+ }
+ }
}
}
@@ -2317,7 +2625,7 @@
Query
class="example-section example-section-is-code operation-variables-example"
>
Variables
-
{ "id" : "xyz789" }
+ { "id" : "abc123" }
Response
"data" : {
"outgoingPayment" : {
"id" : 4 ,
-
"walletAddressId" : "4" ,
+
"walletAddressId" : 4 ,
"client" : "xyz789" ,
"liquidity" : UInt64 ,
"state" : "FUNDING" ,
-
"error" : "xyz789" ,
-
"stateAttempts" : 987 ,
+
"error" : "abc123" ,
+
"stateAttempts" : 123 ,
"debitAmount" : Amount ,
"receiveAmount" : Amount ,
"receiver" : "xyz789" ,
@@ -2342,7 +2650,7 @@
Response
"sentAmount" : Amount ,
"createdAt" : "abc123" ,
"grantId" : "xyz789" ,
-
"tenantId" : "abc123"
+
"tenant" : Tenant
}
}
}
@@ -2554,12 +2862,12 @@
Query
Variables
{
"after" : "abc123" ,
- "before" : "abc123" ,
+ "before" : "xyz789" ,
"first" : 987 ,
"last" : 987 ,
"sortOrder" : "ASC" ,
"filter" : OutgoingPaymentFilter ,
- "tenantId" : "abc123"
+ "tenantId" : "xyz789"
}
@@ -2783,13 +3091,13 @@
Query
>
Variables
{
- "after" : "abc123" ,
- "before" : "abc123" ,
+ "after" : "xyz789" ,
+ "before" : "xyz789" ,
"first" : 123 ,
"last" : 123 ,
"sortOrder" : "ASC" ,
"filter" : PaymentFilter ,
- "tenantId" : "abc123"
+ "tenantId" : "xyz789"
}
@@ -2894,14 +3202,29 @@
Query
...FeesConnectionFragment
}
createdAt
-
tenantId
+
tenant {
+ ...TenantFragment
+ }
}
staticIlpAddress
name
liquidityThreshold
liquidity
createdAt
-
tenantId
+
routes
+
tenant {
+ id
+ email
+ apiSecret
+ idpConsentUrl
+ idpSecret
+ publicName
+ createdAt
+ deletedAt
+ settings {
+ ...TenantSettingFragment
+ }
+ }
}
}
@@ -2910,7 +3233,7 @@
Query
class="example-section example-section-is-code operation-variables-example"
>
Variables
-
{ "id" : "abc123" }
+ { "id" : "xyz789" }
Response
"http" : Http ,
"asset" : Asset ,
"staticIlpAddress" : "abc123" ,
-
"name" : "xyz789" ,
+
"name" : "abc123" ,
"liquidityThreshold" : UInt64 ,
"liquidity" : UInt64 ,
-
"createdAt" : "abc123" ,
-
"tenantId" : 4
+
"createdAt" : "xyz789" ,
+
"routes" : [ "xyz789" ] ,
+
"tenant" : Tenant
}
}
}
@@ -3048,14 +3372,29 @@
Query
...FeesConnectionFragment
}
createdAt
-
tenantId
+
tenant {
+ ...TenantFragment
+ }
}
staticIlpAddress
name
liquidityThreshold
liquidity
createdAt
-
tenantId
+
routes
+
tenant {
+ id
+ email
+ apiSecret
+ idpConsentUrl
+ idpSecret
+ publicName
+ createdAt
+ deletedAt
+ settings {
+ ...TenantSettingFragment
+ }
+ }
}
}
@@ -3077,16 +3416,17 @@
Response
{
"data" : {
"peerByAddressAndAsset" : {
- "id" : "4" ,
+ "id" : 4 ,
"maxPacketAmount" : UInt64 ,
"http" : Http ,
"asset" : Asset ,
"staticIlpAddress" : "abc123" ,
- "name" : "xyz789" ,
+ "name" : "abc123" ,
"liquidityThreshold" : UInt64 ,
"liquidity" : UInt64 ,
"createdAt" : "abc123" ,
- "tenantId" : 4
+ "routes" : [ "abc123" ] ,
+ "tenant" : Tenant
}
}
}
@@ -3275,10 +3615,10 @@ Query
>
Variables
{
- "after" : "xyz789" ,
+ "after" : "abc123" ,
"before" : "abc123" ,
"first" : 123 ,
- "last" : 987 ,
+ "last" : 123 ,
"sortOrder" : "ASC" ,
"tenantId" : 4
}
@@ -3386,7 +3726,7 @@ Query
class="example-section example-section-is-code operation-variables-example"
>
Variables
- { "id" : "xyz789" }
+ { "id" : "abc123" }
Response
{
"data" : {
"quote" : {
- "id" : "4" ,
- "tenantId" : "4" ,
+ "id" : 4 ,
+ "tenantId" : 4 ,
"walletAddressId" : "4" ,
"receiver" : "xyz789" ,
"debitAmount" : Amount ,
"receiveAmount" : Amount ,
- "createdAt" : "abc123" ,
- "expiresAt" : "abc123" ,
- "estimatedExchangeRate" : 123.45
+ "createdAt" : "xyz789" ,
+ "expiresAt" : "xyz789" ,
+ "estimatedExchangeRate" : 987.65
}
}
}
@@ -3505,7 +3845,7 @@ Query
class="example-section example-section-is-code operation-variables-example"
>
Variables
- { "id" : "xyz789" }
+ { "id" : "abc123" }
Response
"receiver" : {
"id" : "xyz789" ,
"walletAddressUrl" : "xyz789" ,
-
"completed" : true ,
+
"completed" : false ,
"incomingAmount" : Amount ,
"receivedAmount" : Amount ,
-
"expiresAt" : "abc123" ,
+
"expiresAt" : "xyz789" ,
"metadata" : { } ,
-
"createdAt" : "abc123"
+
"createdAt" : "xyz789"
}
}
}
@@ -3623,10 +3963,10 @@
Response
"data" : {
"tenant" : {
"id" : "4" ,
-
"email" : "abc123" ,
-
"apiSecret" : "xyz789" ,
+
"email" : "xyz789" ,
+
"apiSecret" : "abc123" ,
"idpConsentUrl" : "abc123" ,
-
"idpSecret" : "xyz789" ,
+
"idpSecret" : "abc123" ,
"publicName" : "abc123" ,
"createdAt" : "xyz789" ,
"deletedAt" : "abc123" ,
@@ -3807,8 +4147,8 @@
Variables
{
"after" : "xyz789" ,
"before" : "abc123" ,
- "first" : 123 ,
- "last" : 123 ,
+ "first" : 987 ,
+ "last" : 987 ,
"sortOrder" : "ASC"
}
@@ -3911,7 +4251,9 @@
Query
...FeesConnectionFragment
}
createdAt
-
tenantId
+
tenant {
+ ...TenantFragment
+ }
}
liquidity
address
@@ -3955,7 +4297,19 @@
Query
value
visibleInOpenPayments
}
-
tenantId
+
tenant {
+ id
+ email
+ apiSecret
+ idpConsentUrl
+ idpSecret
+ publicName
+ createdAt
+ deletedAt
+ settings {
+ ...TenantSettingFragment
+ }
+ }
}
}
@@ -3964,7 +4318,7 @@
Query
class="example-section example-section-is-code operation-variables-example"
>
Variables
-
{ "id" : "abc123" }
+ { "id" : "xyz789" }
Response
{
"data" : {
"walletAddress" : {
- "id" : 4 ,
+ "id" : "4" ,
"asset" : Asset ,
"liquidity" : UInt64 ,
- "address" : "abc123" ,
- "publicName" : "xyz789" ,
+ "address" : "xyz789" ,
+ "publicName" : "abc123" ,
"incomingPayments" : IncomingPaymentConnection ,
"quotes" : QuoteConnection ,
"outgoingPayments" : OutgoingPaymentConnection ,
@@ -3986,7 +4340,7 @@ Response
"status" : "INACTIVE" ,
"walletAddressKeys" : WalletAddressKeyConnection ,
"additionalProperties" : [ AdditionalProperty ] ,
- "tenantId" : "abc123"
+ "tenant" : Tenant
}
}
}
@@ -4076,7 +4430,9 @@ Query
...FeesConnectionFragment
}
createdAt
- tenantId
+ tenant {
+ ...TenantFragment
+ }
}
liquidity
address
@@ -4120,7 +4476,19 @@ Query
value
visibleInOpenPayments
}
- tenantId
+ tenant {
+ id
+ email
+ apiSecret
+ idpConsentUrl
+ idpSecret
+ publicName
+ createdAt
+ deletedAt
+ settings {
+ ...TenantSettingFragment
+ }
+ }
}
}
@@ -4147,11 +4515,11 @@
Response
"incomingPayments" : IncomingPaymentConnection ,
"quotes" : QuoteConnection ,
"outgoingPayments" : OutgoingPaymentConnection ,
-
"createdAt" : "xyz789" ,
+
"createdAt" : "abc123" ,
"status" : "INACTIVE" ,
"walletAddressKeys" : WalletAddressKeyConnection ,
"additionalProperties" : [ AdditionalProperty ] ,
-
"tenantId" : "abc123"
+
"tenant" : Tenant
}
}
}
@@ -4345,10 +4713,10 @@
Variables
{
"after" : "abc123" ,
"before" : "abc123" ,
- "first" : 123 ,
- "last" : 123 ,
+ "first" : 987 ,
+ "last" : 987 ,
"sortOrder" : "ASC" ,
- "tenantId" : "xyz789"
+ "tenantId" : "abc123"
}
Query
Variables
{
"after" : "abc123" ,
- "before" : "xyz789" ,
+ "before" : "abc123" ,
"first" : 123 ,
"last" : 123 ,
"sortOrder" : "ASC" ,
@@ -4730,6 +5098,7 @@ Query
approveIncomingPayment(input: $input ) {
payment {
id
+ url
walletAddressId
client
liquidity
@@ -4743,7 +5112,10 @@ Query
}
metadata
createdAt
- tenantId
+ senderWalletAddress
+ tenant {
+ ...TenantFragment
+ }
}
}
}
@@ -4839,6 +5211,7 @@ Query
cancelIncomingPayment(input: $input ) {
payment {
id
+ url
walletAddressId
client
liquidity
@@ -4852,7 +5225,10 @@ Query
}
metadata
createdAt
- tenantId
+ senderWalletAddress
+ tenant {
+ ...TenantFragment
+ }
}
}
}
@@ -4962,12 +5338,121 @@ Query
quote {
...QuoteFragment
}
- sentAmount {
+ sentAmount {
+ ...AmountFragment
+ }
+ createdAt
+ grantId
+ tenant {
+ ...TenantFragment
+ }
+ }
+ }
+}
+
+
Variables
+
{ "input" : CancelOutgoingPaymentInput }
+
+
+
Response
+
{
+ "data" : {
+ "cancelOutgoingPayment" : { "payment" : OutgoingPayment }
+ }
+}
+
+
+
+
+
+ completeReceiver
+
+
+
+
+
Description
+
+ Complete an internal or external Open Payments incoming
+ payment. The receiver has a wallet address on either this or
+ another Open Payments resource server.
+
+
+
+
+
+
+
Example
+
+
Query
+
mutation CompleteReceiver($input : CompleteReceiverInput! ) {
+ completeReceiver(input: $input ) {
+ receiver {
+ id
+ walletAddressUrl
+ completed
+ incomingAmount {
+ ...AmountFragment
+ }
+ receivedAmount {
...AmountFragment
}
+ expiresAt
+ metadata
createdAt
- grantId
- tenantId
}
}
} Query
class="example-section example-section-is-code operation-variables-example"
>
Variables
- { "input" : CancelOutgoingPaymentInput }
+ { "input" : CompleteReceiverInput }
Response
-
{
- "data" : {
- "cancelOutgoingPayment" : { "payment" : OutgoingPayment }
- }
-}
+ { "data" : { "completeReceiver" : { "receiver" : Receiver } } }
@@ -5075,7 +5556,9 @@
Query
...FeesConnectionFragment
}
createdAt
-
tenantId
+
tenant {
+ ...TenantFragment
+ }
}
}
}
@@ -5181,7 +5664,7 @@
Variables
class="example-section example-section-is-code operation-response-example"
>
Response
-
{ "data" : { "createAssetLiquidityWithdrawal" : { "success" : false } } }
+ { "data" : { "createAssetLiquidityWithdrawal" : { "success" : true } } }
Query
createIncomingPayment(input: $input ) {
payment {
id
+ url
walletAddressId
client
liquidity
@@ -5269,7 +5753,10 @@ Query
}
metadata
createdAt
- tenantId
+ senderWalletAddress
+ tenant {
+ ...TenantFragment
+ }
}
}
}
@@ -5464,7 +5951,10 @@ Query
liquidityThreshold
liquidity
createdAt
- tenantId
+ routes
+ tenant {
+ ...TenantFragment
+ }
}
}
}
@@ -5575,7 +6065,9 @@ Query
}
createdAt
grantId
- tenantId
+ tenant {
+ ...TenantFragment
+ }
}
}
}
@@ -5696,7 +6188,9 @@ Query
}
createdAt
grantId
- tenantId
+ tenant {
+ ...TenantFragment
+ }
}
}
}
@@ -5892,7 +6386,10 @@ Query
liquidityThreshold
liquidity
createdAt
- tenantId
+ routes
+ tenant {
+ ...TenantFragment
+ }
}
}
}
@@ -6479,7 +6976,9 @@ Query
additionalProperties {
...AdditionalPropertyFragment
}
- tenantId
+ tenant {
+ ...TenantFragment
+ }
}
}
}
@@ -6797,7 +7296,9 @@ Query
...FeesConnectionFragment
}
createdAt
- tenantId
+ tenant {
+ ...TenantFragment
+ }
}
}
}
@@ -6978,7 +7479,7 @@ Query
class="example-section example-section-is-code operation-variables-example"
>
Variables
- { "id" : "abc123" }
+ { "id" : "xyz789" }
Variables
class="example-section example-section-is-code operation-response-example"
>
Response
-
{ "data" : { "depositAssetLiquidity" : { "success" : false } } }
+ { "data" : { "depositAssetLiquidity" : { "success" : true } } }
Variables
class="example-section example-section-is-code operation-response-example"
>
Response
- { "data" : { "postLiquidityWithdrawal" : { "success" : false } } }
+ { "data" : { "postLiquidityWithdrawal" : { "success" : true } } }
Query
...FeesConnectionFragment
}
createdAt
- tenantId
+ tenant {
+ ...TenantFragment
+ }
}
}
}
@@ -7898,6 +8401,7 @@ Query
updateIncomingPayment(input: $input ) {
payment {
id
+ url
walletAddressId
client
liquidity
@@ -7911,7 +8415,10 @@ Query
}
metadata
createdAt
- tenantId
+ senderWalletAddress
+ tenant {
+ ...TenantFragment
+ }
}
}
}
@@ -8016,7 +8523,10 @@ Query
liquidityThreshold
liquidity
createdAt
- tenantId
+ routes
+ tenant {
+ ...TenantFragment
+ }
}
}
}
@@ -8226,7 +8736,9 @@ Query
additionalProperties {
...AdditionalPropertyFragment
}
- tenantId
+ tenant {
+ ...TenantFragment
+ }
}
}
}
@@ -8438,7 +8950,7 @@ Variables
class="example-section example-section-is-code operation-response-example"
>
Response
- { "data" : { "withdrawEventLiquidity" : { "success" : false } } }
+ { "data" : { "withdrawEventLiquidity" : { "success" : true } } }
Fields
Example
{
"id" : 4 ,
- "debitAccountId" : 4 ,
- "creditAccountId" : "4" ,
+ "debitAccountId" : "4" ,
+ "creditAccountId" : 4 ,
"amount" : UInt64 ,
"transferType" : "DEPOSIT" ,
"ledger" : UInt8 ,
- "createdAt" : "abc123" ,
+ "createdAt" : "xyz789" ,
"state" : "PENDING" ,
"expiresAt" : "xyz789"
}
@@ -8745,8 +9257,8 @@ Fields
Example
{
"key" : "abc123" ,
- "value" : "abc123" ,
- "visibleInOpenPayments" : true "value" : "xyz789" ,
+ "visibleInOpenPayments" : false }
Fields
Example
{
"key" : "xyz789" ,
- "value" : "xyz789" ,
- "visibleInOpenPayments" : true "value" : "abc123" ,
+ "visibleInOpenPayments" : false }
Fields
Example
-
{ "id" : "4" }
+ { "id" : 4 }
@@ -9409,15 +9921,15 @@
- tenantIdtenantID!Tenant
- The tenant that the asset belongs to.
@@ -9428,7 +9940,7 @@
Example
{
"id" : 4 ,
- "code" : "abc123" ,
+ "code" : "xyz789" ,
"scale" : UInt8 ,
"liquidity" : UInt64 ,
"withdrawalThreshold" : UInt64 ,
@@ -9436,8 +9948,8 @@ Example
"receivingFee" : Fee ,
"sendingFee" : Fee ,
"fees" : FeesConnection ,
- "createdAt" : "xyz789" ,
- "tenantId" : "4"
+ "createdAt" : "abc123" ,
+ "tenant" : Tenant
}
Fields
Example
{
"node" : Asset ,
- "cursor" : "xyz789"
+ "cursor" : "abc123"
}
Possible Types
-
- IncomingPayment
+
+ IncomingPayment
+
+
+
+
+
+ OutgoingPayment
+
+
+
+
+
+ Payment
+
+
+
+
+
+
+
+
+
Example
+
{
+ "id" : "4" ,
+ "walletAddressId" : "4" ,
+ "metadata" : { } ,
+ "createdAt" : "abc123" ,
+ "client" : "abc123"
+}
+
+
+
+
+
+ Boolean
+
+
+
+
Description
+
+ The Boolean scalar type represents
+ true or false.
+
+
+
+
+
+
+
+
+ CancelIncomingPaymentResponse
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ paymentIncomingPayment
+ The incoming payment that was canceled.
+
+
+
+
+
+
+
+
Example
+
{ "payment" : IncomingPayment }
+
+
+
+
+
+
+ CancelOutgoingPaymentInput
+
+
+
+
Fields
+
+
+
+ Input Field
+ Description
+
+
+
+
+
+ idID!
+
+ Unique identifier of the outgoing payment to cancel.
-
- OutgoingPayment
+ reasonString
+
+ Reason why this outgoing payment has been canceled.
+ This value will be publicly visible in the metadata
+ field if this outgoing payment is requested through
+ Open Payments.
-
- Payment
+ cardPaymentFailureReasonCardPaymentFailureReason
+
+ If card flow, optional machine-readable failure reason
@@ -9758,10 +10470,8 @@ Possible Types
Example
{
"id" : 4 ,
- "walletAddressId" : "4" ,
- "metadata" : { } ,
- "createdAt" : "xyz789" ,
- "client" : "xyz789"
+ "reason" : "abc123" ,
+ "cardPaymentFailureReason" : "invalid_signature"
}
Example
- Boolean
+ CardDetailsInput
-
-
Description
-
- The Boolean scalar type represents
- true or false.
-
+
+
Fields
+
+
+
+ Input Field
+ Description
+
+
+
+
+
+ dataJSONObject!
+
+
+
+ requestIdString!
+
+
+
+ initiatedAtString!
+
+
+
Example
-
true {
+ "data" : { } ,
+ "requestId" : "xyz789" ,
+ "initiatedAt" : "xyz789"
+}
@@ -10337,11 +11116,13 @@
Fields
Example
{
- "walletAddressId" : "abc123" ,
- "expiresAt" : "xyz789" ,
+ "walletAddressId" : "xyz789" ,
+ "expiresAt" : "abc123" ,
"metadata" : { } ,
"incomingAmount" : AmountInput ,
- "idempotencyKey" : "xyz789"
+ "idempotencyKey" : "abc123" ,
+ "isCardPayment" : true ,
+ "senderWalletAddress" : "xyz789"
}
@@ -10588,9 +11369,9 @@
Fields
Example
{
"maxPacketAmount" : UInt64 ,
- "assetId" : "abc123" ,
+ "assetId" : "xyz789" ,
"peerUrl" : "abc123" ,
- "name" : "abc123" ,
+ "name" : "xyz789" ,
"liquidityThreshold" : UInt64 ,
"liquidityToDeposit" : UInt64 ,
"idempotencyKey" : "xyz789"
@@ -10756,6 +11537,23 @@ Fields
>.
+
+
+ cardDetailsCardDetailsInput
+
+ Used for the card service to provide the card expiry
+ and signature
+
+
@@ -10765,10 +11563,11 @@
Fields
Example
{
"walletAddressId" : "xyz789" ,
- "incomingPayment" : "abc123" ,
+ "incomingPayment" : "xyz789" ,
"debitAmount" : AmountInput ,
"metadata" : { } ,
- "idempotencyKey" : "xyz789"
+ "idempotencyKey" : "abc123" ,
+ "cardDetails" : CardDetailsInput
}
Fields
Example
{
- "walletAddressId" : "abc123" ,
+ "walletAddressId" : "xyz789" ,
"quoteId" : "xyz789" ,
"metadata" : { } ,
"idempotencyKey" : "xyz789"
@@ -10973,7 +11772,7 @@ Fields
Example
{
- "outgoingPaymentId" : "abc123" ,
+ "outgoingPaymentId" : "xyz789" ,
"idempotencyKey" : "xyz789" ,
"timeoutSeconds" : UInt64
}
@@ -11124,6 +11923,18 @@ Fields
>.
+
+
+ routes[String!]
+ Routes for the peer.
+
@@ -11134,12 +11945,13 @@ Example
{
"maxPacketAmount" : UInt64 ,
"http" : HttpInput ,
- "assetId" : "abc123" ,
- "staticIlpAddress" : "abc123" ,
+ "assetId" : "xyz789" ,
+ "staticIlpAddress" : "xyz789" ,
"name" : "xyz789" ,
"liquidityThreshold" : UInt64 ,
"initialLiquidity" : UInt64 ,
- "idempotencyKey" : "abc123"
+ "idempotencyKey" : "abc123" ,
+ "routes" : [ "xyz789" ]
}
@@ -11254,9 +12066,9 @@ Fields
Example
{
- "peerId" : "abc123" ,
+ "peerId" : "xyz789" ,
"amount" : UInt64 ,
- "id" : "abc123" ,
+ "id" : "xyz789" ,
"idempotencyKey" : "xyz789" ,
"timeoutSeconds" : UInt64
}
@@ -11419,11 +12231,11 @@ Fields
Example
{
- "walletAddressId" : "abc123" ,
+ "walletAddressId" : "xyz789" ,
"debitAmount" : AmountInput ,
"receiveAmount" : AmountInput ,
"receiver" : "abc123" ,
- "idempotencyKey" : "xyz789"
+ "idempotencyKey" : "abc123"
}
@@ -11546,10 +12358,10 @@ Fields
Example
{
"walletAddressUrl" : "xyz789" ,
- "expiresAt" : "xyz789" ,
+ "expiresAt" : "abc123" ,
"incomingAmount" : AmountInput ,
"metadata" : { } ,
- "idempotencyKey" : "xyz789"
+ "idempotencyKey" : "abc123"
}
@@ -11736,7 +12548,7 @@ Fields
Example
{
- "id" : 4 ,
+ "id" : "4" ,
"email" : "abc123" ,
"apiSecret" : "abc123" ,
"idpConsentUrl" : "abc123" ,
@@ -11979,11 +12791,11 @@ Fields
Example
{
- "tenantId" : 4 ,
- "assetId" : "xyz789" ,
+ "tenantId" : "4" ,
+ "assetId" : "abc123" ,
"address" : "xyz789" ,
- "publicName" : "xyz789" ,
- "idempotencyKey" : "abc123" ,
+ "publicName" : "abc123" ,
+ "idempotencyKey" : "xyz789" ,
"additionalProperties" : [ AdditionalPropertyInput ]
}
@@ -12071,7 +12883,7 @@
Example
{
"walletAddressId" : "xyz789" ,
"jwk" : JwkInput ,
- "idempotencyKey" : "xyz789"
+ "idempotencyKey" : "abc123"
}
@@ -12278,7 +13090,7 @@ Example
{
"walletAddressId" : "xyz789" ,
"id" : "abc123" ,
- "idempotencyKey" : "xyz789" ,
+ "idempotencyKey" : "abc123" ,
"timeoutSeconds" : UInt64
}
Fields
Example
-
{
- "id" : "4" ,
- "idempotencyKey" : "xyz789"
-}
+ { "id" : 4 , "idempotencyKey" : "xyz789" }
@@ -12499,10 +13308,7 @@ Fields
Example
-
{
- "id" : "4" ,
- "idempotencyKey" : "xyz789"
-}
+ { "id" : 4 , "idempotencyKey" : "abc123" }
@@ -12600,7 +13406,7 @@ Fields
Example
-
{ "success" : true }
+ { "success" : false }
@@ -12699,7 +13505,7 @@ Example
"assetId" : "xyz789" ,
"amount" : UInt64 ,
"id" : "xyz789" ,
- "idempotencyKey" : "xyz789"
+ "idempotencyKey" : "abc123"
}
@@ -12774,7 +13580,7 @@ Fields
Example
{
"eventId" : "abc123" ,
- "idempotencyKey" : "xyz789"
+ "idempotencyKey" : "abc123"
}
Fields
Example
{
"id" : 4 ,
- "assetId" : "4" ,
+ "assetId" : 4 ,
"type" : "SENDING" ,
"fixed" : UInt64 ,
- "basisPoints" : 987 ,
+ "basisPoints" : 123 ,
"createdAt" : "abc123"
}
Fields
Example
-
{ "fixed" : UInt64 , "basisPoints" : 123 }
+ { "fixed" : UInt64 , "basisPoints" : 987 }
@@ -13342,11 +14148,23 @@ Fields
in[String!]![String!]Array of strings to include.
+
+
+
+ notIn[String!]
- Array of strings to filter by.
+ Array of strings to exclude.
@@ -13355,7 +14173,10 @@ Fields
Example
-
{ "in" : [ "abc123" ] }
+ {
+ "in" : [ "xyz789" ] ,
+ "notIn" : [ "abc123" ]
+}
@@ -13485,7 +14306,7 @@ Fields
Example
-
{ "authTokens" : [ "abc123" ] }
+ { "authTokens" : [ "xyz789" ] }
@@ -13616,8 +14437,8 @@ Fields
Example
{
- "authToken" : "xyz789" ,
- "endpoint" : "abc123"
+ "authToken" : "abc123" ,
+ "endpoint" : "xyz789"
}
@@ -13684,8 +14505,8 @@ Fields
Example
{
- "authToken" : "abc123" ,
- "endpoint" : "abc123"
+ "authToken" : "xyz789" ,
+ "endpoint" : "xyz789"
}
@@ -13719,7 +14540,7 @@ Description
@@ -13755,6 +14576,17 @@ Fields
Unique identifier of the incoming payment.
+
+
+ urlString!
+ The URL of the incoming payment.
+
Fields
tenantIdsenderWalletAddress
-
Fields
>
- The tenant UUID associated with the incoming payment.
- If not provided, it will be obtained from the
- signature.
+ The sender's wallet address URL. Applicable only to
+ card payments.
+
+
+
+
+ tenantTenant
+
+ The tenant associated with the incoming payment. If
+ not provided, it will be obtained from the signature.
@@ -13926,17 +14772,19 @@ Fields
Example
{
- "id" : 4 ,
+ "id" : "4" ,
+ "url" : "abc123" ,
"walletAddressId" : "4" ,
- "client" : "abc123" ,
+ "client" : "xyz789" ,
"liquidity" : UInt64 ,
"state" : "PENDING" ,
"expiresAt" : "xyz789" ,
"incomingAmount" : Amount ,
"receivedAmount" : Amount ,
"metadata" : { } ,
- "createdAt" : "xyz789" ,
- "tenantId" : "abc123"
+ "createdAt" : "abc123" ,
+ "senderWalletAddress" : "abc123" ,
+ "tenant" : Tenant
}
@@ -14068,6 +14916,57 @@ Example
"node" : IncomingPayment ,
"cursor" : "xyz789"
}
+
+
+
+
+
+
- tenantIdtenantStringTenant
- Tenant ID of the outgoing payment.
+ Tenant of the outgoing payment.
@@ -14977,13 +15874,13 @@ Fields
Example
{
- "id" : "4" ,
+ "id" : 4 ,
"walletAddressId" : "4" ,
"client" : "abc123" ,
"liquidity" : UInt64 ,
"state" : "FUNDING" ,
"error" : "abc123" ,
- "stateAttempts" : 987 ,
+ "stateAttempts" : 123 ,
"debitAmount" : Amount ,
"receiveAmount" : Amount ,
"receiver" : "xyz789" ,
@@ -14992,7 +15889,7 @@ Example
"sentAmount" : Amount ,
"createdAt" : "xyz789" ,
"grantId" : "abc123" ,
- "tenantId" : "abc123"
+ "tenant" : Tenant
}
@@ -15432,10 +16329,10 @@ Fields
Example
{
- "endCursor" : "xyz789" ,
- "hasNextPage" : false ,
+ "endCursor" : "abc123" ,
+ "hasNextPage" : true ,
"hasPreviousPage" : false ,
- "startCursor" : "xyz789"
+ "startCursor" : "abc123"
}
@@ -15577,6 +16474,18 @@ Fields
The date and time that the payment was created.
+
+
+ tenantTenant
+ The tenant associated with the payment.
+
@@ -15587,12 +16496,13 @@ Example
{
"id" : 4 ,
"type" : "INCOMING" ,
- "walletAddressId" : 4 ,
- "client" : "xyz789" ,
- "state" : "xyz789" ,
+ "walletAddressId" : "4" ,
+ "client" : "abc123" ,
+ "state" : "abc123" ,
"liquidity" : UInt64 ,
"metadata" : { } ,
- "createdAt" : "xyz789"
+ "createdAt" : "xyz789" ,
+ "tenant" : Tenant
}
Fields
- tenantIdroutes
+ -
+ [String!]!
+ Routes for the peer.
+
+
+
+ tenantID!Tenant
@@ -16004,7 +16926,8 @@ Example
"liquidityThreshold" : UInt64 ,
"liquidity" : UInt64 ,
"createdAt" : "abc123" ,
- "tenantId" : 4
+ "routes" : [ "abc123" ] ,
+ "tenant" : Tenant
}
@@ -16203,7 +17126,7 @@ Fields
Example
{
- "withdrawalId" : "xyz789" ,
+ "withdrawalId" : "abc123" ,
"idempotencyKey" : "xyz789"
}
@@ -16364,14 +17287,14 @@
Fields
Example
{
"id" : 4 ,
- "tenantId" : "4" ,
- "walletAddressId" : 4 ,
- "receiver" : "abc123" ,
+ "tenantId" : 4 ,
+ "walletAddressId" : "4" ,
+ "receiver" : "xyz789" ,
"debitAmount" : Amount ,
"receiveAmount" : Amount ,
- "createdAt" : "abc123" ,
+ "createdAt" : "xyz789" ,
"expiresAt" : "xyz789" ,
- "estimatedExchangeRate" : 123.45
+ "estimatedExchangeRate" : 987.65
}
@@ -16713,14 +17636,14 @@ Fields
Example
{
- "id" : "abc123" ,
- "walletAddressUrl" : "xyz789" ,
+ "id" : "xyz789" ,
+ "walletAddressUrl" : "abc123" ,
"completed" : false ,
"incomingAmount" : Amount ,
"receivedAmount" : Amount ,
- "expiresAt" : "abc123" ,
+ "expiresAt" : "xyz789" ,
"metadata" : { } ,
- "createdAt" : "abc123"
+ "createdAt" : "xyz789"
}
@@ -16790,7 +17713,7 @@ Fields
Example
{
- "id" : "abc123" ,
+ "id" : "xyz789" ,
"idempotencyKey" : "abc123"
}
@@ -16934,7 +17857,7 @@
Fields
Example
{
- "assetId" : "4" ,
+ "assetId" : 4 ,
"type" : "SENDING" ,
"fee" : FeeDetails ,
"idempotencyKey" : "abc123"
@@ -17221,14 +18144,14 @@ Fields
Example
{
- "id" : "4" ,
- "email" : "abc123" ,
- "apiSecret" : "xyz789" ,
+ "id" : 4 ,
+ "email" : "xyz789" ,
+ "apiSecret" : "abc123" ,
"idpConsentUrl" : "xyz789" ,
- "idpSecret" : "abc123" ,
- "publicName" : "xyz789" ,
- "createdAt" : "xyz789" ,
- "deletedAt" : "abc123" ,
+ "idpSecret" : "xyz789" ,
+ "publicName" : "abc123" ,
+ "createdAt" : "abc123" ,
+ "deletedAt" : "xyz789" ,
"settings" : [ TenantSetting ]
}
@@ -17395,7 +18318,7 @@
Fields
Example
{
"key" : "EXCHANGE_RATES_URL" ,
- "value" : "xyz789"
+ "value" : "abc123"
}
@@ -17455,7 +18378,7 @@ Fields
Example
{
"key" : "EXCHANGE_RATES_URL" ,
- "value" : "xyz789"
+ "value" : "abc123"
}
@@ -17763,7 +18686,7 @@
Fields
Example
-
{ "limit" : 123 , "idempotencyKey" : "xyz789" }
+ { "limit" : 987 , "idempotencyKey" : "abc123" }
@@ -17811,7 +18734,7 @@
Fields
Example
-
{ "count" : 123 }
+ { "count" : 987 }
@@ -17973,7 +18896,7 @@
Example
"id" : "xyz789" ,
"withdrawalThreshold" : UInt64 ,
"liquidityThreshold" : UInt64 ,
-
"idempotencyKey" : "xyz789"
+
"idempotencyKey" : "abc123"
}
@@ -18036,7 +18959,7 @@ Fields
Example
-
{ "id" : "4" , "metadata" : { } }
+ { "id" : 4 , "metadata" : { } }
@@ -18164,6 +19087,18 @@ Fields
>.
+
+
+ routes[String!]
+ New routes for the peer.
+
@@ -18175,10 +19110,11 @@ Example
"id" : "abc123" ,
"maxPacketAmount" : UInt64 ,
"http" : HttpInput ,
- "staticIlpAddress" : "abc123" ,
+ "staticIlpAddress" : "xyz789" ,
"name" : "abc123" ,
"liquidityThreshold" : UInt64 ,
- "idempotencyKey" : "xyz789"
+ "idempotencyKey" : "abc123" ,
+ "routes" : [ "abc123" ]
}
Fields
Example
{
- "id" : 4 ,
- "email" : "xyz789" ,
- "apiSecret" : "xyz789" ,
- "idpConsentUrl" : "xyz789" ,
- "idpSecret" : "abc123" ,
+ "id" : "4" ,
+ "email" : "abc123" ,
+ "apiSecret" : "abc123" ,
+ "idpConsentUrl" : "abc123" ,
+ "idpSecret" : "xyz789" ,
"publicName" : "xyz789"
}
@@ -18467,7 +19403,7 @@
Fields
Example
{
- "id" : "4" ,
+ "id" : 4 ,
"publicName" : "abc123" ,
"status" : "INACTIVE" ,
"idempotencyKey" : "abc123" ,
@@ -18595,7 +19531,7 @@ Fields
Example
{
"withdrawalId" : "xyz789" ,
- "idempotencyKey" : "xyz789"
+ "idempotencyKey" : "abc123"
}
@@ -18804,6 +19740,23 @@
or descending.
+
+
+
+ Filter incoming payments based on specific
+ criteria such as initiation reason.
+
+
- tenantIdtenantStringTenant
- Tenant ID of the wallet address.
+ Tenant of the wallet address.
@@ -19219,8 +20170,8 @@ Example
"id" : 4 ,
"asset" : Asset ,
"liquidity" : UInt64 ,
- "address" : "abc123" ,
- "publicName" : "xyz789" ,
+ "address" : "xyz789" ,
+ "publicName" : "abc123" ,
"incomingPayments" : IncomingPaymentConnection ,
"quotes" : QuoteConnection ,
"outgoingPayments" : OutgoingPaymentConnection ,
@@ -19228,7 +20179,7 @@ Example
"status" : "INACTIVE" ,
"walletAddressKeys" : WalletAddressKeyConnection ,
"additionalProperties" : [ AdditionalProperty ] ,
- "tenantId" : "abc123"
+ "tenant" : Tenant
}
Fields
Example
{
"node" : WalletAddress ,
- "cursor" : "abc123"
+ "cursor" : "xyz789"
}
Example
"id" : 4 ,
"walletAddressId" : 4 ,
"jwk" : Jwk ,
- "revoked" : false ,
- "createdAt" : "abc123"
+ "revoked" : true ,
+ "createdAt" : "xyz789"
}
@@ -19810,12 +20761,12 @@ Fields
- tenantIdtenantID!Tenant
Tenant of the webhook event.
@@ -19867,8 +20818,8 @@ Fields
Example
{
"id" : 4 ,
- "tenantId" : "4" ,
- "type" : "xyz789" ,
+ "tenant" : Tenant ,
+ "type" : "abc123" ,
"data" : { } ,
"createdAt" : "xyz789"
}
@@ -20043,7 +20994,7 @@ Fields
Example
{
"node" : WebhookEvent ,
- "cursor" : "abc123"
+ "cursor" : "xyz789"
}
Fields
Example
-
{ "id" : "abc123" , "isOperator" : true }
+ { "id" : "xyz789" , "isOperator" : false }
@@ -20176,7 +21127,7 @@ Fields
Example
{
- "eventId" : "xyz789" ,
+ "eventId" : "abc123" ,
"idempotencyKey" : "xyz789"
}
diff --git a/packages/documentation/src/pages/es/apis/graphql/auth/index.html b/packages/documentation/src/pages/es/apis/graphql/auth/index.html
new file mode 100644
index 0000000000..2f81da0b24
--- /dev/null
+++ b/packages/documentation/src/pages/es/apis/graphql/auth/index.html
@@ -0,0 +1,2914 @@
+
+
+
+
+
+
+
Auth Admin API
+
+
+
+
+
+
+
+
+
+
+
+ Auth Admin API
+
+
+
+
+ The Auth Admin API allows you to get information about a
+ grant, such as its status, state, related payment details, and
+ the wallet address of the grantee’s account. The API also
+ allows you to revoke grants.
+
+
+
+
+
API Endpoints
+
# Staging:
+https://staging.example.com/graphql
+
+
+
+
+
+ Queries
+
+
+
+ grant
+
+
+
+
+
Description
+
Fetch a specific grant by its ID.
+
+
+
+
+
+
Response
+
+ Returns a
+ Grant!
+
+
+
Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ idID!
+ Unique identifier of the grant.
+
+
+
+
+
+
+
Example
+
+
Query
+
query Grant($id : ID!) {
+ grant(id: $id ) {
+ id
+ client
+ access {
+ id
+ identifier
+ type
+ actions
+ limits {
+ ...LimitDataFragment
+ }
+ createdAt
+ }
+ subject {
+ sub_ids {
+ ...SubjectItemFragment
+ }
+ }
+ state
+ finalizationReason
+ createdAt
+ tenantId
+ }
+}
+
+
+
Variables
+
{ "id" : "4" }
+
+
+
+
Response
+
{
+ "data" : {
+ "grant" : {
+ "id" : "4" ,
+ "client" : "xyz789" ,
+ "access" : [ Access ] ,
+ "subject" : Subject ,
+ "state" : "PROCESSING" ,
+ "finalizationReason" : "ISSUED" ,
+ "createdAt" : "xyz789" ,
+ "tenantId" : 4
+ }
+ }
+}
+
+
+
+
+
+
+
+ grants
+
+
+
+
+
Description
+
Fetch a paginated list of grants.
+
+
+
+
+
+
+
Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ afterString
+
+ Forward pagination: Cursor (grant ID) to start
+ retrieving grants after this point.
+
+
+
+
+ beforeString
+
+ Backward pagination: Cursor (grant ID) to start
+ retrieving grants before this point.
+
+
+
+
+ firstInt
+
+ Forward pagination: Limit the result to the first
+ n grants after the
+ after cursor.
+
+
+
+
+ lastInt
+
+ Backward pagination: Limit the result to the last
+ n grants before the
+ before cursor.
+
+
+
+
+ filterGrantFilter
+
+ Filter grants based on specified criteria such as ID,
+ state, or finalization reason.
+
+
+
+
+ sortOrderSortOrder
+
+ Specify the sort order of grants based on their
+ creation date, either ascending or descending.
+
+
+
+
+ tenantIdID
+
+ Filter grants by a specific tenant. This can only be
+ performed by the operator.
+
+
+
+
+
+
+
+
Example
+
+
Query
+
query Grants(
+ $after : String,
+ $before : String,
+ $first : Int,
+ $last : Int,
+ $filter : GrantFilter,
+ $sortOrder : SortOrder,
+ $tenantId : ID
+) {
+ grants(
+ after: $after ,
+ before: $before ,
+ first: $first ,
+ last: $last ,
+ filter: $filter ,
+ sortOrder: $sortOrder ,
+ tenantId: $tenantId
+ ) {
+ pageInfo {
+ endCursor
+ hasNextPage
+ hasPreviousPage
+ startCursor
+ }
+ edges {
+ node {
+ ...GrantFragment
+ }
+ cursor
+ }
+ }
+}
+
+
+
Variables
+
{
+ "after" : "abc123" ,
+ "before" : "xyz789" ,
+ "first" : 987 ,
+ "last" : 987 ,
+ "filter" : GrantFilter ,
+ "sortOrder" : "ASC" ,
+ "tenantId" : "4"
+}
+
+
+
+
Response
+
{
+ "data" : {
+ "grants" : {
+ "pageInfo" : PageInfo ,
+ "edges" : [ GrantEdge ]
+ }
+ }
+}
+
+
+
+
+
+ Mutations
+
+
+
+ revokeGrant
+
+
+
+
+
Description
+
Revoke an existing grant.
+
+
+
+
+
+
Example
+
+
Query
+
mutation RevokeGrant($input : RevokeGrantInput! ) {
+ revokeGrant(input: $input ) {
+ id
+ }
+}
+
+
+
Variables
+
{ "input" : RevokeGrantInput }
+
+
+
+
Response
+
{ "data" : { "revokeGrant" : { "id" : "4" } } }
+
+
+
+
+
+ Types
+
+
+ Access
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ idID!
+ Unique identifier of the access object.
+
+
+
+ identifierString
+
+ Wallet address of the sub-resource (incoming payment,
+ outgoing payment, or quote).
+
+
+
+
+ typeString!
+
+ Type of access (incoming payment, outgoing payment, or
+ quote).
+
+
+
+
+ actions[String]!
+ Actions allowed with this access.
+
+
+
+ limitsLimitData
+
+ Limits for an outgoing payment associated with this
+ access.
+
+
+
+
+ createdAtString!
+ The date and time when the access was created.
+
+
+
+
+
+
+
+
Example
+
{
+ "id" : 4 ,
+ "identifier" : "xyz789" ,
+ "type" : "xyz789" ,
+ "actions" : [ "xyz789" ] ,
+ "limits" : LimitData ,
+ "createdAt" : "xyz789"
+}
+
+
+
+
+
+
+ Boolean
+
+
+
+
Description
+
+ The Boolean scalar type represents
+ true or false.
+
+
+
+
+
+
+
+
+
+
+ Grant
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ idID!
+ Unique identifier of the grant.
+
+
+
+ clientString!
+ Wallet address of the grantee's account.
+
+
+
+ access[Access!]!
+ Details of the access provided by the grant.
+
+
+
+ subjectSubject
+ Details of the subject provided by the grant.
+
+
+
+ stateGrantState!
+ Current state of the grant.
+
+
+
+ finalizationReasonGrantFinalization
+
+ Specific outcome of a finalized grant, indicating
+ whether the grant was issued, revoked, or rejected.
+
+
+
+
+ createdAtString!
+ The date and time when the grant was created.
+
+
+
+ tenantIdID!
+
+ Unique identifier of the tenant associated with the
+ grant.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "id" : 4 ,
+ "client" : "xyz789" ,
+ "access" : [ Access ] ,
+ "subject" : Subject ,
+ "state" : "PROCESSING" ,
+ "finalizationReason" : "ISSUED" ,
+ "createdAt" : "xyz789" ,
+ "tenantId" : "4"
+}
+
+
+
+
+
+
+ GrantEdge
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ nodeGrant!
+ A grant node in the list.
+
+
+
+ cursorString!
+ A cursor for paginating through the grants.
+
+
+
+
+
+
+
+
Example
+
{
+ "node" : Grant ,
+ "cursor" : "abc123"
+}
+
+
+
+
+
+
+
+ GrantFinalization
+
+
+
+
Values
+
+
+
+ Enum Value
+ Description
+
+
+
+
+
+ ISSUED
+
+ The grant was issued successfully.
+
+
+
+ REVOKED
+
+ The grant was revoked.
+
+
+
+ REJECTED
+
+ The grant request was rejected.
+
+
+
+
+
+
+
+
+
+ GrantState
+
+
+
+
Values
+
+
+
+ Enum Value
+ Description
+
+
+
+
+
+ PROCESSING
+
+ The grant request is processing.
+
+
+
+ PENDING
+
+ The grant request is awaiting interaction.
+
+
+
+ APPROVED
+
+ The grant request has been approved.
+
+
+
+ FINALIZED
+
+
+ The grant request has been finalized, and no more
+ access tokens or interactions can be made.
+
+
+
+
+
+
+
+
+
Example
+
"PROCESSING"
+
+
+
+
+
+
+ GrantsConnection
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ pageInfoPageInfo!
+ Information to aid in pagination.
+
+
+
+ edges[GrantEdge!]!
+
+ A list of edges representing grants and cursors for
+ pagination.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "pageInfo" : PageInfo ,
+ "edges" : [ GrantEdge ]
+}
+
+
+
+
+
+
+ ID
+
+
+
+
Description
+
+ The ID scalar type represents a unique
+ identifier, often used to refetch an object or as key for a
+ cache. The ID type appears in a JSON response as a String;
+ however, it is not intended to be human-readable. When
+ expected as an input type, any string (such as
+ "4") or integer (such as
+ 4) input value will be accepted as an ID.
+
+
+
+
+
+
+
+ Int
+
+
+
+
Description
+
+ The Int scalar type represents non-fractional
+ signed whole numeric values. Int can represent values
+ between -(2^31) and 2^31 - 1.
+
+
+
+
+
+
+
+ LimitData
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ receiverString
+ Wallet address URL of the receiver.
+
+
+
+ debitAmountPaymentAmount
+ Amount to debit.
+
+
+
+ receiveAmountPaymentAmount
+ Amount to receive.
+
+
+
+ intervalString
+ Interval between payments.
+
+
+
+
+
+
+
+
Example
+
{
+ "receiver" : "xyz789" ,
+ "debitAmount" : PaymentAmount ,
+ "receiveAmount" : PaymentAmount ,
+ "interval" : "abc123"
+}
+
+
+
+
+
+
+ Model
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ idID!
+ Unique identifier for the model.
+
+
+
+ createdAtString!
+ The date and time when the model was created.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "id" : "4" ,
+ "createdAt" : "xyz789"
+}
+
+
+
+
+
+
+ PageInfo
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ endCursorString
+
+ The cursor used to fetch the next page when paginating
+ forward.
+
+
+
+
+ hasNextPageBoolean!
+
+ Indicates if there are more pages when paginating
+ forward.
+
+
+
+
+ hasPreviousPageBoolean!
+
+ Indicates if there are more pages when paginating
+ backward.
+
+
+
+
+ startCursorString
+
+ The cursor used to fetch the next page when paginating
+ backward.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "endCursor" : "xyz789" ,
+ "hasNextPage" : true ,
+ "hasPreviousPage" : true ,
+ "startCursor" : "xyz789"
+}
+
+
+
+
+
+
+ PaymentAmount
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ valueUInt64!
+ The value of the payment amount.
+
+
+
+ assetCodeString!
+
+ Should be an ISO 4217 currency code whenever possible,
+ e.g. USD. For more information, refer to
+ assets .
+
+
+
+
+ assetScaleUInt8!
+
+ Difference in orders of magnitude between the standard
+ unit of an asset and a corresponding fractional unit.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "value" : UInt64 ,
+ "assetCode" : "abc123" ,
+ "assetScale" : UInt8
+}
+
+
+
+
+
+
+
+ RevokeGrantMutationResponse
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ idID!
+ Unique identifier of the revoked grant.
+
+
+
+
+
+
+
+
Example
+
{ "id" : "4" }
+
+
+
+
+
+
+ SortOrder
+
+
+
+
Values
+
+
+
+ Enum Value
+ Description
+
+
+
+
+
+ ASC
+
+ Sort the results in ascending order.
+
+
+
+ DESC
+
+ Sort the results in descending order.
+
+
+
+
+
+
+
+
+
+ String
+
+
+
+
Description
+
+ The String scalar type represents textual data,
+ represented as UTF-8 character sequences. The String type is
+ most often used by GraphQL to represent free-form
+ human-readable text.
+
+
+
+
+
+
+
+ Subject
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ sub_ids[SubjectItem!]!
+
+
+
+
+
+
+
+
Example
+
{ "sub_ids" : [ SubjectItem ] }
+
+
+
+
+
+
+ SubjectItem
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ idID!
+ Unique identifier of the subject object.
+
+
+
+ subIdString!
+ Wallet address of the subject's account.
+
+
+
+ subIdFormatString!
+ Format of the subject identifier
+
+
+
+ createdAtString!
+ The date and time when the subject was created.
+
+
+
+
+
+
+
+
Example
+
{
+ "id" : 4 ,
+ "subId" : "xyz789" ,
+ "subIdFormat" : "xyz789" ,
+ "createdAt" : "xyz789"
+}
+
+
+
+
+
+
+ UInt64
+
+
+
+
Description
+
+ The UInt64 scalar type represents unsigned
+ 64-bit whole numeric values. It is capable of handling
+ values that are larger than the JavaScript
+ Number type limit (greater than 2^53).
+
+
+
+
+
+
+
+ UInt8
+
+
+
+
Description
+
+ The UInt8 scalar type represents unsigned 8-bit
+ whole numeric values, ranging from 0 to 255.
+
+
+
+
+
+
+
+
+
+
+
diff --git a/packages/documentation/src/pages/es/apis/graphql/backend/index.html b/packages/documentation/src/pages/es/apis/graphql/backend/index.html
new file mode 100644
index 0000000000..c3ccf1849b
--- /dev/null
+++ b/packages/documentation/src/pages/es/apis/graphql/backend/index.html
@@ -0,0 +1,21149 @@
+
+
+
+
+
+
+
Backend Admin API
+
+
+
+
+
+
+
+
+
+
+
+ Backend Admin API
+
+
+
+
+ The Backend Admin API provides you with comprehensive
+ capabilities to manage your Rafiki instance. Core
+ functionality includes managing peering relationships, assets,
+ wallet addresses and their public keys, as well as liquidity
+ management through deposits and withdrawals. Another important
+ aspect of the Backend Admin API is to manage Open Payments
+ resources like payments and quotes.
+
+
+
+
+
API Endpoints
+
# Staging:
+https://staging.example.com/graphql
+
+
+
+
+
+ Queries
+
+
+
+ accountingTransfers
+
+
+
+
+
Description
+
+ Fetch a paginated list of accounting transfers for a given
+ account.
+
+
+
+
+
+
+
+
Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ idString!
+ Unique identifier of the account.
+
+
+
+ limitInt
+
+ Limit the number of results returned. If no limit is
+ provided, the default limit is 20.
+
+
+
+
+
+
+
+
Example
+
+
Query
+
query AccountingTransfers(
+ $id : String! ,
+ $limit : Int
+ ) {
+ accountingTransfers(
+ id: $id ,
+ limit: $limit
+ ) {
+ debits {
+ id
+ debitAccountId
+ creditAccountId
+ amount
+ transferType
+ ledger
+ createdAt
+ state
+ expiresAt
+ }
+ credits {
+ id
+ debitAccountId
+ creditAccountId
+ amount
+ transferType
+ ledger
+ createdAt
+ state
+ expiresAt
+ }
+ }
+}
+
+
+
Variables
+
{ "id" : "abc123" , "limit" : 123 }
+
+
+
+
Response
+
{
+ "data" : {
+ "accountingTransfers" : {
+ "debits" : [ AccountingTransfer ] ,
+ "credits" : [ AccountingTransfer ]
+ }
+ }
+}
+
+
+
+
+
+
+
+ asset
+
+
+
+
+
Description
+
Fetch an asset by its ID.
+
+
+
+
+
+
Response
+
+ Returns an
+ Asset
+
+
+
Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ idString!
+ Unique identifier of the asset.
+
+
+
+
+
+
+
Example
+
+
Query
+
query Asset($id : String! ) {
+ asset(id: $id ) {
+ id
+ code
+ scale
+ liquidity
+ withdrawalThreshold
+ liquidityThreshold
+ receivingFee {
+ id
+ assetId
+ type
+ fixed
+ basisPoints
+ createdAt
+ }
+ sendingFee {
+ id
+ assetId
+ type
+ fixed
+ basisPoints
+ createdAt
+ }
+ fees {
+ pageInfo {
+ ...PageInfoFragment
+ }
+ edges {
+ ...FeeEdgeFragment
+ }
+ }
+ createdAt
+ tenant {
+ id
+ email
+ apiSecret
+ idpConsentUrl
+ idpSecret
+ publicName
+ createdAt
+ deletedAt
+ settings {
+ ...TenantSettingFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{ "id" : "abc123" }
+
+
+
+
Response
+
{
+ "data" : {
+ "asset" : {
+ "id" : 4 ,
+ "code" : "abc123" ,
+ "scale" : UInt8 ,
+ "liquidity" : UInt64 ,
+ "withdrawalThreshold" : UInt64 ,
+ "liquidityThreshold" : UInt64 ,
+ "receivingFee" : Fee ,
+ "sendingFee" : Fee ,
+ "fees" : FeesConnection ,
+ "createdAt" : "abc123" ,
+ "tenant" : Tenant
+ }
+ }
+}
+
+
+
+
+
+
+
+ assetByCodeAndScale
+
+
+
+
+
Description
+
+ Get an asset based on its currency code and scale if it
+ exists.
+
+
+
+
+
+
+
Response
+
+ Returns an
+ Asset
+
+
+
Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ codeString!
+ ISO 4217 currency code.
+
+
+
+ scaleUInt8!
+
+ Difference in order of magnitude between the standard
+ unit of an asset and its corresponding fractional
+ unit.
+
+
+
+
+
+
+
+
Example
+
+
Query
+
query AssetByCodeAndScale(
+ $code : String! ,
+ $scale : UInt8!
+) {
+ assetByCodeAndScale(
+ code: $code ,
+ scale: $scale
+ ) {
+ id
+ code
+ scale
+ liquidity
+ withdrawalThreshold
+ liquidityThreshold
+ receivingFee {
+ id
+ assetId
+ type
+ fixed
+ basisPoints
+ createdAt
+ }
+ sendingFee {
+ id
+ assetId
+ type
+ fixed
+ basisPoints
+ createdAt
+ }
+ fees {
+ pageInfo {
+ ...PageInfoFragment
+ }
+ edges {
+ ...FeeEdgeFragment
+ }
+ }
+ createdAt
+ tenant {
+ id
+ email
+ apiSecret
+ idpConsentUrl
+ idpSecret
+ publicName
+ createdAt
+ deletedAt
+ settings {
+ ...TenantSettingFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{
+ "code" : "abc123" ,
+ "scale" : UInt8
+}
+
+
+
+
Response
+
{
+ "data" : {
+ "assetByCodeAndScale" : {
+ "id" : 4 ,
+ "code" : "xyz789" ,
+ "scale" : UInt8 ,
+ "liquidity" : UInt64 ,
+ "withdrawalThreshold" : UInt64 ,
+ "liquidityThreshold" : UInt64 ,
+ "receivingFee" : Fee ,
+ "sendingFee" : Fee ,
+ "fees" : FeesConnection ,
+ "createdAt" : "xyz789" ,
+ "tenant" : Tenant
+ }
+ }
+}
+
+
+
+
+
+
+
+ assets
+
+
+
+
+
Description
+
Fetch a paginated list of assets.
+
+
+
+
+
+
+
Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ afterString
+
+ Forward pagination: Cursor (asset ID) to start
+ retrieving assets after this point.
+
+
+
+
+ beforeString
+
+ Backward pagination: Cursor (asset ID) to start
+ retrieving assets before this point.
+
+
+
+
+ firstInt
+
+ Forward pagination: Limit the result to the first
+ n assets after the
+ after cursor.
+
+
+
+
+ lastInt
+
+ Backward pagination: Limit the result to the last
+ n assets before the
+ before cursor.
+
+
+
+
+ sortOrderSortOrder
+
+ Specify the sort order of assets based on their
+ creation data, either ascending or descending.
+
+
+
+
+ tenantIdString
+
+ Unique identifier of the tenant associated with the
+ wallet address. Optional, if not provided, the
+ tenantId will be obtained from the signature.
+
+
+
+
+
+
+
+
Example
+
+
Query
+
query Assets(
+ $after : String,
+ $before : String,
+ $first : Int,
+ $last : Int,
+ $sortOrder : SortOrder,
+ $tenantId : String
+ ) {
+ assets(
+ after: $after ,
+ before: $before ,
+ first: $first ,
+ last: $last ,
+ sortOrder: $sortOrder ,
+ tenantId: $tenantId
+ ) {
+ pageInfo {
+ endCursor
+ hasNextPage
+ hasPreviousPage
+ startCursor
+ }
+ edges {
+ node {
+ ...AssetFragment
+ }
+ cursor
+ }
+ }
+}
+
+
+
Variables
+
{
+ "after" : "abc123" ,
+ "before" : "abc123" ,
+ "first" : 987 ,
+ "last" : 987 ,
+ "sortOrder" : "ASC" ,
+ "tenantId" : "abc123"
+}
+
+
+
+
Response
+
{
+ "data" : {
+ "assets" : {
+ "pageInfo" : PageInfo ,
+ "edges" : [ AssetEdge ]
+ }
+ }
+}
+
+
+
+
+
+
+
+ incomingPayment
+
+
+
+
+
Description
+
Fetch an Open Payments incoming payment by its ID.
+
+
+
+
+
+
+
Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ idString!
+ Unique identifier of the incoming payment.
+
+
+
+
+
+
+
Example
+
+
Query
+
query IncomingPayment($id : String! ) {
+ incomingPayment(id: $id ) {
+ id
+ url
+ walletAddressId
+ client
+ liquidity
+ state
+ expiresAt
+ incomingAmount {
+ value
+ assetCode
+ assetScale
+ }
+ receivedAmount {
+ value
+ assetCode
+ assetScale
+ }
+ metadata
+ createdAt
+ senderWalletAddress
+ tenant {
+ id
+ email
+ apiSecret
+ idpConsentUrl
+ idpSecret
+ publicName
+ createdAt
+ deletedAt
+ settings {
+ ...TenantSettingFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{ "id" : "abc123" }
+
+
+
+
Response
+
{
+ "data" : {
+ "incomingPayment" : {
+ "id" : 4 ,
+ "url" : "abc123" ,
+ "walletAddressId" : 4 ,
+ "client" : "abc123" ,
+ "liquidity" : UInt64 ,
+ "state" : "PENDING" ,
+ "expiresAt" : "xyz789" ,
+ "incomingAmount" : Amount ,
+ "receivedAmount" : Amount ,
+ "metadata" : { } ,
+ "createdAt" : "abc123" ,
+ "senderWalletAddress" : "xyz789" ,
+ "tenant" : Tenant
+ }
+ }
+}
+
+
+
+
+
+
+
+ incomingPayments
+
+
+
+
+
Description
+
Fetch a paginated list of incoming payments.
+
+
+
+
+
+
+
Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ afterString
+
+ Forward pagination: Cursor (incoming payment ID) to
+ start retrieving incoming payments after this point.
+
+
+
+
+ beforeString
+
+ Backward pagination: Cursor (outgoing payment ID) to
+ start retrieving incoming payments before this point.
+
+
+
+
+ firstInt
+
+ Forward pagination: Limit the result to the first
+ n incoming payments after the
+ after cursor.
+
+
+
+
+ lastInt
+
+ Backward pagination: Limit the result to the last
+ n incoming payments before the
+ before cursor.
+
+
+
+
+ sortOrderSortOrder
+
+ Specify the sort order of incoming payments based on
+ their creation date, either ascending or descending.
+
+
+
+
+ filterIncomingPaymentFilter
+
+ Filter incoming payments based on specific criteria
+ such as initiation reason.
+
+
+
+
+ tenantIdString
+
+ Unique identifier of the tenant associated with the
+ incoming payment. Optional, if not provided, the
+ tenantId will be obtained from the signature.
+
+
+
+
+
+
+
+
Example
+
+
Query
+
query IncomingPayments(
+ $after : String,
+ $before : String,
+ $first : Int,
+ $last : Int,
+ $sortOrder : SortOrder,
+ $filter : IncomingPaymentFilter,
+ $tenantId : String
+ ) {
+ incomingPayments(
+ after: $after ,
+ before: $before ,
+ first: $first ,
+ last: $last ,
+ sortOrder: $sortOrder ,
+ filter: $filter ,
+ tenantId: $tenantId
+ ) {
+ pageInfo {
+ endCursor
+ hasNextPage
+ hasPreviousPage
+ startCursor
+ }
+ edges {
+ node {
+ ...IncomingPaymentFragment
+ }
+ cursor
+ }
+ }
+}
+
+
+
Variables
+
{
+ "after" : "xyz789" ,
+ "before" : "xyz789" ,
+ "first" : 123 ,
+ "last" : 123 ,
+ "sortOrder" : "ASC" ,
+ "filter" : IncomingPaymentFilter ,
+ "tenantId" : "abc123"
+}
+
+
+
+
Response
+
{
+ "data" : {
+ "incomingPayments" : {
+ "pageInfo" : PageInfo ,
+ "edges" : [ IncomingPaymentEdge ]
+ }
+ }
+}
+
+
+
+
+
+
+
+ outgoingPayment
+
+
+
+
+
Description
+
Fetch an Open Payments outgoing payment by its ID.
+
+
+
+
+
+
+
Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ idString!
+ Unique identifier of the outgoing payment.
+
+
+
+
+
+
+
Example
+
+
Query
+
query OutgoingPayment($id : String! ) {
+ outgoingPayment(id: $id ) {
+ id
+ walletAddressId
+ client
+ liquidity
+ state
+ error
+ stateAttempts
+ debitAmount {
+ value
+ assetCode
+ assetScale
+ }
+ receiveAmount {
+ value
+ assetCode
+ assetScale
+ }
+ receiver
+ metadata
+ quote {
+ id
+ tenantId
+ walletAddressId
+ receiver
+ debitAmount {
+ ...AmountFragment
+ }
+ receiveAmount {
+ ...AmountFragment
+ }
+ createdAt
+ expiresAt
+ estimatedExchangeRate
+ }
+ sentAmount {
+ value
+ assetCode
+ assetScale
+ }
+ createdAt
+ grantId
+ tenant {
+ id
+ email
+ apiSecret
+ idpConsentUrl
+ idpSecret
+ publicName
+ createdAt
+ deletedAt
+ settings {
+ ...TenantSettingFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{ "id" : "xyz789" }
+
+
+
+
Response
+
{
+ "data" : {
+ "outgoingPayment" : {
+ "id" : "4" ,
+ "walletAddressId" : 4 ,
+ "client" : "xyz789" ,
+ "liquidity" : UInt64 ,
+ "state" : "FUNDING" ,
+ "error" : "abc123" ,
+ "stateAttempts" : 987 ,
+ "debitAmount" : Amount ,
+ "receiveAmount" : Amount ,
+ "receiver" : "xyz789" ,
+ "metadata" : { } ,
+ "quote" : Quote ,
+ "sentAmount" : Amount ,
+ "createdAt" : "abc123" ,
+ "grantId" : "xyz789" ,
+ "tenant" : Tenant
+ }
+ }
+}
+
+
+
+
+
+
+
+ outgoingPayments
+
+
+
+
+
Description
+
+ Fetch a paginated list of outgoing payments by receiver.
+
+
+
+
+
+
+
+
Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ afterString
+
+ Forward pagination: Cursor (outgoing payment ID) to
+ start retrieving outgoing payments after this point.
+
+
+
+
+ beforeString
+
+ Backward pagination: Cursor (outgoing payment ID) to
+ start retrieving outgoing payments before this point.
+
+
+
+
+ firstInt
+
+ Forward pagination: Limit the result to the first
+ n outgoing payments after the
+ after cursor.
+
+
+
+
+ lastInt
+
+ Backward pagination: Limit the result to the last
+ n outgoing payments before the
+ before cursor.
+
+
+
+
+ sortOrderSortOrder
+
+ Specify the sort order of outgoing payments based on
+ their creation date, either ascending or descending.
+
+
+
+
+ filterOutgoingPaymentFilter
+
+ Filter outgoing payments based on specific criteria
+ such as receiver, wallet address ID, or state.
+
+
+
+
+ tenantIdString
+
+ Unique identifier of the tenant associated with the
+ wallet address. Optional, if not provided, the
+ tenantId will be obtained from the signature.
+
+
+
+
+
+
+
+
Example
+
+
Query
+
query OutgoingPayments(
+ $after : String,
+ $before : String,
+ $first : Int,
+ $last : Int,
+ $sortOrder : SortOrder,
+ $filter : OutgoingPaymentFilter,
+ $tenantId : String
+ ) {
+ outgoingPayments(
+ after: $after ,
+ before: $before ,
+ first: $first ,
+ last: $last ,
+ sortOrder: $sortOrder ,
+ filter: $filter ,
+ tenantId: $tenantId
+ ) {
+ pageInfo {
+ endCursor
+ hasNextPage
+ hasPreviousPage
+ startCursor
+ }
+ edges {
+ node {
+ ...OutgoingPaymentFragment
+ }
+ cursor
+ }
+ }
+}
+
+
+
Variables
+
{
+ "after" : "xyz789" ,
+ "before" : "xyz789" ,
+ "first" : 987 ,
+ "last" : 123 ,
+ "sortOrder" : "ASC" ,
+ "filter" : OutgoingPaymentFilter ,
+ "tenantId" : "abc123"
+}
+
+
+
+
Response
+
{
+ "data" : {
+ "outgoingPayments" : {
+ "pageInfo" : PageInfo ,
+ "edges" : [ OutgoingPaymentEdge ]
+ }
+ }
+}
+
+
+
+
+
+
+
+ payments
+
+
+
+
+
Description
+
+ Fetch a paginated list of combined payments, including
+ incoming and outgoing payments.
+
+
+
+
+
+
+
+
Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ afterString
+
+ Forward pagination: Cursor (payment ID) to start
+ retrieving payments after this point.
+
+
+
+
+ beforeString
+
+ Backward pagination: Cursor (payment ID) to start
+ retrieving payments before this point.
+
+
+
+
+ firstInt
+
+ Forward pagination: Limit the result to the first
+ n payments after the
+ after cursor.
+
+
+
+
+ lastInt
+
+ Backward pagination: Limit the result to the last
+ n payments before the
+ before cursor.
+
+
+
+
+ sortOrderSortOrder
+
+ Specify the sort order of payments based on their
+ creation date, either ascending or descending.
+
+
+
+
+ filterPaymentFilter
+
+ Filter payment events based on specific criteria such
+ as payment type or wallet address ID.
+
+
+
+
+ tenantIdString
+
+ Unique identifier of the tenant associated with the
+ wallet address. Optional, if not provided, the
+ tenantId will be obtained from the signature.
+
+
+
+
+
+
+
+
Example
+
+
Query
+
query Payments(
+ $after : String,
+ $before : String,
+ $first : Int,
+ $last : Int,
+ $sortOrder : SortOrder,
+ $filter : PaymentFilter,
+ $tenantId : String
+ ) {
+ payments(
+ after: $after ,
+ before: $before ,
+ first: $first ,
+ last: $last ,
+ sortOrder: $sortOrder ,
+ filter: $filter ,
+ tenantId: $tenantId
+ ) {
+ pageInfo {
+ endCursor
+ hasNextPage
+ hasPreviousPage
+ startCursor
+ }
+ edges {
+ node {
+ ...PaymentFragment
+ }
+ cursor
+ }
+ }
+}
+
+
+
Variables
+
{
+ "after" : "abc123" ,
+ "before" : "abc123" ,
+ "first" : 123 ,
+ "last" : 987 ,
+ "sortOrder" : "ASC" ,
+ "filter" : PaymentFilter ,
+ "tenantId" : "xyz789"
+}
+
+
+
+
Response
+
{
+ "data" : {
+ "payments" : {
+ "pageInfo" : PageInfo ,
+ "edges" : [ PaymentEdge ]
+ }
+ }
+}
+
+
+
+
+
+
+
+ peer
+
+
+
+
+
Description
+
Fetch a peer by its ID.
+
+
+
+
+
+
Response
+
+ Returns a Peer
+
+
+
Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ idString!
+ Unique identifier of the peer.
+
+
+
+
+
+
+
Example
+
+
Query
+
query Peer($id : String! ) {
+ peer(id: $id ) {
+ id
+ maxPacketAmount
+ http {
+ outgoing {
+ ...HttpOutgoingFragment
+ }
+ }
+ asset {
+ id
+ code
+ scale
+ liquidity
+ withdrawalThreshold
+ liquidityThreshold
+ receivingFee {
+ ...FeeFragment
+ }
+ sendingFee {
+ ...FeeFragment
+ }
+ fees {
+ ...FeesConnectionFragment
+ }
+ createdAt
+ tenant {
+ ...TenantFragment
+ }
+ }
+ staticIlpAddress
+ name
+ liquidityThreshold
+ liquidity
+ createdAt
+ routes
+ tenant {
+ id
+ email
+ apiSecret
+ idpConsentUrl
+ idpSecret
+ publicName
+ createdAt
+ deletedAt
+ settings {
+ ...TenantSettingFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{ "id" : "xyz789" }
+
+
+
+
Response
+
{
+ "data" : {
+ "peer" : {
+ "id" : 4 ,
+ "maxPacketAmount" : UInt64 ,
+ "http" : Http ,
+ "asset" : Asset ,
+ "staticIlpAddress" : "xyz789" ,
+ "name" : "xyz789" ,
+ "liquidityThreshold" : UInt64 ,
+ "liquidity" : UInt64 ,
+ "createdAt" : "abc123" ,
+ "routes" : [ "xyz789" ] ,
+ "tenant" : Tenant
+ }
+ }
+}
+
+
+
+
+
+
+
+ peerByAddressAndAsset
+
+
+
+
+
Description
+
+ Get a peer based on its ILP address and asset ID if it
+ exists.
+
+
+
+
+
+
+
Response
+
+ Returns a Peer
+
+
+
Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ staticIlpAddressString!
+ ILP address of the peer.
+
+
+
+ assetIdString!
+ Asset ID of peering relationship.
+
+
+
+
+
+
+
Example
+
+
Query
+
query PeerByAddressAndAsset(
+ $staticIlpAddress : String! ,
+ $assetId : String!
+) {
+ peerByAddressAndAsset(
+ staticIlpAddress: $staticIlpAddress ,
+ assetId: $assetId
+ ) {
+ id
+ maxPacketAmount
+ http {
+ outgoing {
+ ...HttpOutgoingFragment
+ }
+ }
+ asset {
+ id
+ code
+ scale
+ liquidity
+ withdrawalThreshold
+ liquidityThreshold
+ receivingFee {
+ ...FeeFragment
+ }
+ sendingFee {
+ ...FeeFragment
+ }
+ fees {
+ ...FeesConnectionFragment
+ }
+ createdAt
+ tenant {
+ ...TenantFragment
+ }
+ }
+ staticIlpAddress
+ name
+ liquidityThreshold
+ liquidity
+ createdAt
+ routes
+ tenant {
+ id
+ email
+ apiSecret
+ idpConsentUrl
+ idpSecret
+ publicName
+ createdAt
+ deletedAt
+ settings {
+ ...TenantSettingFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{
+ "staticIlpAddress" : "abc123" ,
+ "assetId" : "abc123"
+}
+
+
+
+
Response
+
{
+ "data" : {
+ "peerByAddressAndAsset" : {
+ "id" : 4 ,
+ "maxPacketAmount" : UInt64 ,
+ "http" : Http ,
+ "asset" : Asset ,
+ "staticIlpAddress" : "xyz789" ,
+ "name" : "xyz789" ,
+ "liquidityThreshold" : UInt64 ,
+ "liquidity" : UInt64 ,
+ "createdAt" : "xyz789" ,
+ "routes" : [ "xyz789" ] ,
+ "tenant" : Tenant
+ }
+ }
+}
+
+
+
+
+
+
+
+ peers
+
+
+
+
+
Description
+
Fetch a paginated list of peers.
+
+
+
+
+
+
+
Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ afterString
+
+ Forward pagination: Cursor (peer ID) to start
+ retrieving peers after this point.
+
+
+
+
+ beforeString
+
+ Backward pagination: Cursor (peer ID) to start
+ retrieving peers before this point.
+
+
+
+
+ firstInt
+
+ Forward pagination: Limit the result to the first
+ n peers after the
+ after cursor.
+
+
+
+
+ lastInt
+
+ Backward pagination: Limit the result to the last
+ n peers before the
+ before cursor.
+
+
+
+
+ sortOrderSortOrder
+
+ Specify the sort order of peers based on their
+ creation date, either ascending or descending.
+
+
+
+
+ tenantIdID
+
+ Unique identifier of the tenant associated with the
+ peer.
+
+
+
+
+
+
+
+
Example
+
+
Query
+
query Peers(
+ $after : String,
+ $before : String,
+ $first : Int,
+ $last : Int,
+ $sortOrder : SortOrder,
+ $tenantId : ID
+) {
+ peers(
+ after: $after ,
+ before: $before ,
+ first: $first ,
+ last: $last ,
+ sortOrder: $sortOrder ,
+ tenantId: $tenantId
+ ) {
+ pageInfo {
+ endCursor
+ hasNextPage
+ hasPreviousPage
+ startCursor
+ }
+ edges {
+ node {
+ ...PeerFragment
+ }
+ cursor
+ }
+ }
+}
+
+
+
Variables
+
{
+ "after" : "abc123" ,
+ "before" : "abc123" ,
+ "first" : 987 ,
+ "last" : 987 ,
+ "sortOrder" : "ASC" ,
+ "tenantId" : "4"
+}
+
+
+
+
Response
+
{
+ "data" : {
+ "peers" : {
+ "pageInfo" : PageInfo ,
+ "edges" : [ PeerEdge ]
+ }
+ }
+}
+
+
+
+
+
+
+
+ quote
+
+
+
+
+
Description
+
Fetch an Open Payments quote by its ID.
+
+
+
+
+
+
Response
+
+ Returns a Quote
+
+
+
Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ idString!
+ Unique identifier of the quote.
+
+
+
+
+
+
+
Example
+
+
Query
+
query Quote($id : String! ) {
+ quote(id: $id ) {
+ id
+ tenantId
+ walletAddressId
+ receiver
+ debitAmount {
+ value
+ assetCode
+ assetScale
+ }
+ receiveAmount {
+ value
+ assetCode
+ assetScale
+ }
+ createdAt
+ expiresAt
+ estimatedExchangeRate
+ }
+}
+
+
+
Variables
+
{ "id" : "xyz789" }
+
+
+
+
Response
+
{
+ "data" : {
+ "quote" : {
+ "id" : "4" ,
+ "tenantId" : 4 ,
+ "walletAddressId" : 4 ,
+ "receiver" : "abc123" ,
+ "debitAmount" : Amount ,
+ "receiveAmount" : Amount ,
+ "createdAt" : "abc123" ,
+ "expiresAt" : "abc123" ,
+ "estimatedExchangeRate" : 987.65
+ }
+ }
+}
+
+
+
+
+
+
+
+ receiver
+
+
+
+
+
Description
+
+ Retrieve an Open Payments incoming payment by receiver ID.
+ The receiver's wallet address can be hosted on this
+ server or a remote Open Payments resource server.
+
+
+
+
+
+
+
+
Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ idString!
+
+ Unique identifier of the receiver (incoming payment
+ URL).
+
+
+
+
+
+
+
+
Example
+
+
Query
+
query Receiver($id : String! ) {
+ receiver(id: $id ) {
+ id
+ walletAddressUrl
+ completed
+ incomingAmount {
+ value
+ assetCode
+ assetScale
+ }
+ receivedAmount {
+ value
+ assetCode
+ assetScale
+ }
+ expiresAt
+ metadata
+ createdAt
+ }
+}
+
+
+
Variables
+
{ "id" : "abc123" }
+
+
+
+
Response
+
{
+ "data" : {
+ "receiver" : {
+ "id" : "abc123" ,
+ "walletAddressUrl" : "abc123" ,
+ "completed" : true ,
+ "incomingAmount" : Amount ,
+ "receivedAmount" : Amount ,
+ "expiresAt" : "abc123" ,
+ "metadata" : { } ,
+ "createdAt" : "xyz789"
+ }
+ }
+}
+
+
+
+
+
+
+
+ tenant
+
+
+
+
+
Description
+
Retrieve a tenant of the instance.
+
+
+
+
+
+
Response
+
+ Returns a
+ Tenant!
+
+
+
Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ idString!
+ Unique identifier of the tenant.
+
+
+
+
+
+
+
Example
+
+
Query
+
query Tenant($id : String! ) {
+ tenant(id: $id ) {
+ id
+ email
+ apiSecret
+ idpConsentUrl
+ idpSecret
+ publicName
+ createdAt
+ deletedAt
+ settings {
+ key
+ value
+ }
+ }
+}
+
+
+
Variables
+
{ "id" : "xyz789" }
+
+
+
+
Response
+
{
+ "data" : {
+ "tenant" : {
+ "id" : 4 ,
+ "email" : "xyz789" ,
+ "apiSecret" : "abc123" ,
+ "idpConsentUrl" : "abc123" ,
+ "idpSecret" : "abc123" ,
+ "publicName" : "abc123" ,
+ "createdAt" : "abc123" ,
+ "deletedAt" : "xyz789" ,
+ "settings" : [ TenantSetting ]
+ }
+ }
+}
+
+
+
+
+
+
+
+ tenants
+
+
+
+
+
Description
+
+ As an operator, fetch a paginated list of tenants on the
+ instance.
+
+
+
+
+
+
+
+
Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ afterString
+
+ Forward pagination: Cursor (tenant ID) to start
+ retrieving tenants after this point.
+
+
+
+
+ beforeString
+
+ Backward pagination: Cursor (tenant ID) to start
+ retrieving tenants before this point.
+
+
+
+
+ firstInt
+
+ Forward pagination: Limit the result to the first
+ n tenants after the
+ after cursor.
+
+
+
+
+ lastInt
+
+ Backward pagination: Limit the result to the last
+ n tenants before the
+ before cursor.
+
+
+
+
+ sortOrderSortOrder
+
+ Specify the sort order of tenants based on their
+ creation date, either ascending or descending.
+
+
+
+
+
+
+
+
Example
+
+
Query
+
query Tenants(
+ $after : String,
+ $before : String,
+ $first : Int,
+ $last : Int,
+ $sortOrder : SortOrder
+ ) {
+ tenants(
+ after: $after ,
+ before: $before ,
+ first: $first ,
+ last: $last ,
+ sortOrder: $sortOrder
+ ) {
+ pageInfo {
+ endCursor
+ hasNextPage
+ hasPreviousPage
+ startCursor
+ }
+ edges {
+ node {
+ ...TenantFragment
+ }
+ cursor
+ }
+ }
+}
+
+
+
Variables
+
{
+ "after" : "xyz789" ,
+ "before" : "abc123" ,
+ "first" : 123 ,
+ "last" : 987 ,
+ "sortOrder" : "ASC"
+}
+
+
+
+
Response
+
{
+ "data" : {
+ "tenants" : {
+ "pageInfo" : PageInfo ,
+ "edges" : [ TenantEdge ]
+ }
+ }
+}
+
+
+
+
+
+
+
+ walletAddress
+
+
+
+
+
Description
+
Fetch a wallet address by its ID.
+
+
+
+
+
+
+
Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ idString!
+ Unique identifier of the wallet address.
+
+
+
+
+
+
+
Example
+
+
Query
+
query WalletAddress($id : String! ) {
+ walletAddress(id: $id ) {
+ id
+ asset {
+ id
+ code
+ scale
+ liquidity
+ withdrawalThreshold
+ liquidityThreshold
+ receivingFee {
+ ...FeeFragment
+ }
+ sendingFee {
+ ...FeeFragment
+ }
+ fees {
+ ...FeesConnectionFragment
+ }
+ createdAt
+ tenant {
+ ...TenantFragment
+ }
+ }
+ liquidity
+ address
+ publicName
+ incomingPayments {
+ pageInfo {
+ ...PageInfoFragment
+ }
+ edges {
+ ...IncomingPaymentEdgeFragment
+ }
+ }
+ quotes {
+ pageInfo {
+ ...PageInfoFragment
+ }
+ edges {
+ ...QuoteEdgeFragment
+ }
+ }
+ outgoingPayments {
+ pageInfo {
+ ...PageInfoFragment
+ }
+ edges {
+ ...OutgoingPaymentEdgeFragment
+ }
+ }
+ createdAt
+ status
+ walletAddressKeys {
+ pageInfo {
+ ...PageInfoFragment
+ }
+ edges {
+ ...WalletAddressKeyEdgeFragment
+ }
+ }
+ additionalProperties {
+ key
+ value
+ visibleInOpenPayments
+ }
+ tenant {
+ id
+ email
+ apiSecret
+ idpConsentUrl
+ idpSecret
+ publicName
+ createdAt
+ deletedAt
+ settings {
+ ...TenantSettingFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{ "id" : "xyz789" }
+
+
+
+
Response
+
{
+ "data" : {
+ "walletAddress" : {
+ "id" : 4 ,
+ "asset" : Asset ,
+ "liquidity" : UInt64 ,
+ "address" : "abc123" ,
+ "publicName" : "abc123" ,
+ "incomingPayments" : IncomingPaymentConnection ,
+ "quotes" : QuoteConnection ,
+ "outgoingPayments" : OutgoingPaymentConnection ,
+ "createdAt" : "abc123" ,
+ "status" : "INACTIVE" ,
+ "walletAddressKeys" : WalletAddressKeyConnection ,
+ "additionalProperties" : [ AdditionalProperty ] ,
+ "tenant" : Tenant
+ }
+ }
+}
+
+
+
+
+
+
+
+ walletAddressByUrl
+
+
+
+
+
Description
+
Get a wallet address by its url if it exists
+
+
+
+
+
+
+
Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ urlString!
+ Wallet Address URL.
+
+
+
+
+
+
+
Example
+
+
Query
+
query WalletAddressByUrl($url : String! ) {
+ walletAddressByUrl(url: $url ) {
+ id
+ asset {
+ id
+ code
+ scale
+ liquidity
+ withdrawalThreshold
+ liquidityThreshold
+ receivingFee {
+ ...FeeFragment
+ }
+ sendingFee {
+ ...FeeFragment
+ }
+ fees {
+ ...FeesConnectionFragment
+ }
+ createdAt
+ tenant {
+ ...TenantFragment
+ }
+ }
+ liquidity
+ address
+ publicName
+ incomingPayments {
+ pageInfo {
+ ...PageInfoFragment
+ }
+ edges {
+ ...IncomingPaymentEdgeFragment
+ }
+ }
+ quotes {
+ pageInfo {
+ ...PageInfoFragment
+ }
+ edges {
+ ...QuoteEdgeFragment
+ }
+ }
+ outgoingPayments {
+ pageInfo {
+ ...PageInfoFragment
+ }
+ edges {
+ ...OutgoingPaymentEdgeFragment
+ }
+ }
+ createdAt
+ status
+ walletAddressKeys {
+ pageInfo {
+ ...PageInfoFragment
+ }
+ edges {
+ ...WalletAddressKeyEdgeFragment
+ }
+ }
+ additionalProperties {
+ key
+ value
+ visibleInOpenPayments
+ }
+ tenant {
+ id
+ email
+ apiSecret
+ idpConsentUrl
+ idpSecret
+ publicName
+ createdAt
+ deletedAt
+ settings {
+ ...TenantSettingFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{ "url" : "abc123" }
+
+
+
+
Response
+
{
+ "data" : {
+ "walletAddressByUrl" : {
+ "id" : "4" ,
+ "asset" : Asset ,
+ "liquidity" : UInt64 ,
+ "address" : "xyz789" ,
+ "publicName" : "xyz789" ,
+ "incomingPayments" : IncomingPaymentConnection ,
+ "quotes" : QuoteConnection ,
+ "outgoingPayments" : OutgoingPaymentConnection ,
+ "createdAt" : "xyz789" ,
+ "status" : "INACTIVE" ,
+ "walletAddressKeys" : WalletAddressKeyConnection ,
+ "additionalProperties" : [ AdditionalProperty ] ,
+ "tenant" : Tenant
+ }
+ }
+}
+
+
+
+
+
+
+
+ walletAddresses
+
+
+
+
+
Description
+
Fetch a paginated list of wallet addresses.
+
+
+
+
+
+
+
Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ afterString
+
+ Forward pagination: Cursor (wallet address ID) to
+ start retrieving wallet addresses after this point.
+
+
+
+
+ beforeString
+
+ Backward pagination: Cursor (wallet address ID) to
+ start retrieving wallet addresses before this point.
+
+
+
+
+ firstInt
+
+ Forward pagination: Limit the result to the first
+ n wallet addresses after the
+ after cursor.
+
+
+
+
+ lastInt
+
+ Backward pagination: Limit the result to the last
+ n wallet addresses before the
+ before cursor.
+
+
+
+
+ sortOrderSortOrder
+
+ Specify the sort order of wallet addresses based on
+ their creation date, either ascending or descending.
+
+
+
+
+ tenantIdString
+
+ Unique identifier of the tenant associated with the
+ wallet address. Optional, if not provided, the
+ tenantId will be obtained from the signature.
+
+
+
+
+
+
+
+
Example
+
+
Query
+
query WalletAddresses(
+ $after : String,
+ $before : String,
+ $first : Int,
+ $last : Int,
+ $sortOrder : SortOrder,
+ $tenantId : String
+ ) {
+ walletAddresses(
+ after: $after ,
+ before: $before ,
+ first: $first ,
+ last: $last ,
+ sortOrder: $sortOrder ,
+ tenantId: $tenantId
+ ) {
+ pageInfo {
+ endCursor
+ hasNextPage
+ hasPreviousPage
+ startCursor
+ }
+ edges {
+ node {
+ ...WalletAddressFragment
+ }
+ cursor
+ }
+ }
+}
+
+
+
Variables
+
{
+ "after" : "abc123" ,
+ "before" : "xyz789" ,
+ "first" : 987 ,
+ "last" : 987 ,
+ "sortOrder" : "ASC" ,
+ "tenantId" : "xyz789"
+}
+
+
+
+
Response
+
{
+ "data" : {
+ "walletAddresses" : {
+ "pageInfo" : PageInfo ,
+ "edges" : [ WalletAddressEdge ]
+ }
+ }
+}
+
+
+
+
+
+
+
+ webhookEvents
+
+
+
+
+
Description
+
Fetch a paginated list of webhook events.
+
+
+
+
+
+
+
Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ afterString
+
+ Forward pagination: Cursor (webhook event ID) to start
+ retrieving webhook events after this point.
+
+
+
+
+ beforeString
+
+ Backward pagination: Cursor (webhook event ID) to
+ start retrieving webhook events before this point.
+
+
+
+
+ firstInt
+
+ Forward pagination: Limit the result to the first
+ n webhook events after the
+ after cursor.
+
+
+
+
+ lastInt
+
+ Backward pagination: Limit the result to the last
+ n webhook events before the
+ before cursor.
+
+
+
+
+ sortOrderSortOrder
+
+ Specify the sort order of webhook events based on
+ their creation date, either ascending or descending.
+
+
+
+
+ filterWebhookEventFilter
+
+ Filter webhook events based on specific criteria.
+
+
+
+
+ tenantIdString
+
+ Unique identifier of the tenant associated with the
+ wallet address. Optional, if not provided, the
+ tenantId will be obtained from the signature.
+
+
+
+
+
+
+
+
Example
+
+
Query
+
query WebhookEvents(
+ $after : String,
+ $before : String,
+ $first : Int,
+ $last : Int,
+ $sortOrder : SortOrder,
+ $filter : WebhookEventFilter,
+ $tenantId : String
+ ) {
+ webhookEvents(
+ after: $after ,
+ before: $before ,
+ first: $first ,
+ last: $last ,
+ sortOrder: $sortOrder ,
+ filter: $filter ,
+ tenantId: $tenantId
+ ) {
+ pageInfo {
+ endCursor
+ hasNextPage
+ hasPreviousPage
+ startCursor
+ }
+ edges {
+ node {
+ ...WebhookEventFragment
+ }
+ cursor
+ }
+ }
+}
+
+
+
Variables
+
{
+ "after" : "xyz789" ,
+ "before" : "xyz789" ,
+ "first" : 987 ,
+ "last" : 987 ,
+ "sortOrder" : "ASC" ,
+ "filter" : WebhookEventFilter ,
+ "tenantId" : "xyz789"
+}
+
+
+
+
Response
+
{
+ "data" : {
+ "webhookEvents" : {
+ "pageInfo" : PageInfo ,
+ "edges" : [ WebhookEventsEdge ]
+ }
+ }
+}
+
+
+
+
+
+
+
+ whoami
+
+
+
+
+
Description
+
Determine if the requester has operator permissions
+
+
+
+
+
+
Example
+
+
Query
+
query Whoami {
+ whoami {
+ id
+ isOperator
+ }
+}
+
+
+
Response
+
{
+ "data" : {
+ "whoami" : {
+ "id" : "xyz789" ,
+ "isOperator" : false }
+ }
+}
+
+
+
+
+
+ Mutations
+
+
+
+ approveIncomingPayment
+
+
+
+
+
Description
+
+ Approves the incoming payment if the incoming payment is in
+ the PENDING state
+
+
+
+
+
+
+
Example
+
+
Query
+
mutation ApproveIncomingPayment($input : ApproveIncomingPaymentInput! ) {
+ approveIncomingPayment(input: $input ) {
+ payment {
+ id
+ url
+ walletAddressId
+ client
+ liquidity
+ state
+ expiresAt
+ incomingAmount {
+ ...AmountFragment
+ }
+ receivedAmount {
+ ...AmountFragment
+ }
+ metadata
+ createdAt
+ senderWalletAddress
+ tenant {
+ ...TenantFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{ "input" : ApproveIncomingPaymentInput }
+
+
+
+
Response
+
{
+ "data" : {
+ "approveIncomingPayment" : { "payment" : IncomingPayment }
+ }
+}
+
+
+
+
+
+
+
+ cancelIncomingPayment
+
+
+
+
+
Description
+
+ Cancel the incoming payment if the incoming payment is in
+ the PENDING state
+
+
+
+
+
+
+
Example
+
+
Query
+
mutation CancelIncomingPayment($input : CancelIncomingPaymentInput! ) {
+ cancelIncomingPayment(input: $input ) {
+ payment {
+ id
+ url
+ walletAddressId
+ client
+ liquidity
+ state
+ expiresAt
+ incomingAmount {
+ ...AmountFragment
+ }
+ receivedAmount {
+ ...AmountFragment
+ }
+ metadata
+ createdAt
+ senderWalletAddress
+ tenant {
+ ...TenantFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{ "input" : CancelIncomingPaymentInput }
+
+
+
+
Response
+
{
+ "data" : {
+ "cancelIncomingPayment" : { "payment" : IncomingPayment }
+ }
+}
+
+
+
+
+
+
+
+ cancelOutgoingPayment
+
+
+
+
+
Description
+
Cancel an outgoing payment.
+
+
+
+
+
+
Example
+
+
Query
+
mutation CancelOutgoingPayment($input : CancelOutgoingPaymentInput! ) {
+ cancelOutgoingPayment(input: $input ) {
+ payment {
+ id
+ walletAddressId
+ client
+ liquidity
+ state
+ error
+ stateAttempts
+ debitAmount {
+ ...AmountFragment
+ }
+ receiveAmount {
+ ...AmountFragment
+ }
+ receiver
+ metadata
+ quote {
+ ...QuoteFragment
+ }
+ sentAmount {
+ ...AmountFragment
+ }
+ createdAt
+ grantId
+ tenant {
+ ...TenantFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{ "input" : CancelOutgoingPaymentInput }
+
+
+
+
Response
+
{
+ "data" : {
+ "cancelOutgoingPayment" : { "payment" : OutgoingPayment }
+ }
+}
+
+
+
+
+
+
+
+ completeReceiver
+
+
+
+
+
Description
+
+ Complete an internal or external Open Payments incoming
+ payment. The receiver has a wallet address on either this or
+ another Open Payments resource server.
+
+
+
+
+
+
+
Example
+
+
Query
+
mutation CompleteReceiver($input : CompleteReceiverInput! ) {
+ completeReceiver(input: $input ) {
+ receiver {
+ id
+ walletAddressUrl
+ completed
+ incomingAmount {
+ ...AmountFragment
+ }
+ receivedAmount {
+ ...AmountFragment
+ }
+ expiresAt
+ metadata
+ createdAt
+ }
+ }
+}
+
+
+
Variables
+
{ "input" : CompleteReceiverInput }
+
+
+
+
Response
+
{ "data" : { "completeReceiver" : { "receiver" : Receiver } } }
+
+
+
+
+
+
+
+ createAsset
+
+
+
+
+
Description
+
Create a new asset.
+
+
+
+
+
+
Example
+
+
Query
+
mutation CreateAsset($input : CreateAssetInput! ) {
+ createAsset(input: $input ) {
+ asset {
+ id
+ code
+ scale
+ liquidity
+ withdrawalThreshold
+ liquidityThreshold
+ receivingFee {
+ ...FeeFragment
+ }
+ sendingFee {
+ ...FeeFragment
+ }
+ fees {
+ ...FeesConnectionFragment
+ }
+ createdAt
+ tenant {
+ ...TenantFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{ "input" : CreateAssetInput }
+
+
+
+
Response
+
{ "data" : { "createAsset" : { "asset" : Asset } } }
+
+
+
+
+
+
+
+ createAssetLiquidityWithdrawal
+
+
+
+
+
Description
+
Withdraw asset liquidity.
+
+
+
+
+
+
Example
+
+
Query
+
mutation CreateAssetLiquidityWithdrawal($input : CreateAssetLiquidityWithdrawalInput! ) {
+ createAssetLiquidityWithdrawal(input: $input ) {
+ success
+ }
+}
+
+
+
Variables
+
{ "input" : CreateAssetLiquidityWithdrawalInput }
+
+
+
+
Response
+
{ "data" : { "createAssetLiquidityWithdrawal" : { "success" : true } } }
+
+
+
+
+
+
+
+ createIncomingPayment
+
+
+
+
+
Description
+
+ Create an internal Open Payments incoming payment. The
+ receiver has a wallet address on this Rafiki instance.
+
+
+
+
+
+
+
Example
+
+
Query
+
mutation CreateIncomingPayment($input : CreateIncomingPaymentInput! ) {
+ createIncomingPayment(input: $input ) {
+ payment {
+ id
+ url
+ walletAddressId
+ client
+ liquidity
+ state
+ expiresAt
+ incomingAmount {
+ ...AmountFragment
+ }
+ receivedAmount {
+ ...AmountFragment
+ }
+ metadata
+ createdAt
+ senderWalletAddress
+ tenant {
+ ...TenantFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{ "input" : CreateIncomingPaymentInput }
+
+
+
+
Response
+
{
+ "data" : {
+ "createIncomingPayment" : { "payment" : IncomingPayment }
+ }
+}
+
+
+
+
+
+
+
+ createIncomingPaymentWithdrawal
+
+
+
+
+
Description
+
Withdraw incoming payment liquidity.
+
+
+
+
+
+
Example
+
+
Query
+
mutation CreateIncomingPaymentWithdrawal($input : CreateIncomingPaymentWithdrawalInput! ) {
+ createIncomingPaymentWithdrawal(input: $input ) {
+ success
+ }
+}
+
+
+
Variables
+
{ "input" : CreateIncomingPaymentWithdrawalInput }
+
+
+
+
Response
+
{ "data" : { "createIncomingPaymentWithdrawal" : { "success" : false } } }
+
+
+
+
+
+
+
+ createOrUpdatePeerByUrl
+
+
+
+
+
Description
+
Create or update a peer using a URL.
+
+
+
+
+
+
Example
+
+
Query
+
mutation CreateOrUpdatePeerByUrl($input : CreateOrUpdatePeerByUrlInput! ) {
+ createOrUpdatePeerByUrl(input: $input ) {
+ peer {
+ id
+ maxPacketAmount
+ http {
+ ...HttpFragment
+ }
+ asset {
+ ...AssetFragment
+ }
+ staticIlpAddress
+ name
+ liquidityThreshold
+ liquidity
+ createdAt
+ routes
+ tenant {
+ ...TenantFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{ "input" : CreateOrUpdatePeerByUrlInput }
+
+
+
+
Response
+
{ "data" : { "createOrUpdatePeerByUrl" : { "peer" : Peer } } }
+
+
+
+
+
+
+
+ createOutgoingPayment
+
+
+
+
+
Description
+
Create an Open Payments outgoing payment.
+
+
+
+
+
+
Example
+
+
Query
+
mutation CreateOutgoingPayment($input : CreateOutgoingPaymentInput! ) {
+ createOutgoingPayment(input: $input ) {
+ payment {
+ id
+ walletAddressId
+ client
+ liquidity
+ state
+ error
+ stateAttempts
+ debitAmount {
+ ...AmountFragment
+ }
+ receiveAmount {
+ ...AmountFragment
+ }
+ receiver
+ metadata
+ quote {
+ ...QuoteFragment
+ }
+ sentAmount {
+ ...AmountFragment
+ }
+ createdAt
+ grantId
+ tenant {
+ ...TenantFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{ "input" : CreateOutgoingPaymentInput }
+
+
+
+
Response
+
{
+ "data" : {
+ "createOutgoingPayment" : { "payment" : OutgoingPayment }
+ }
+}
+
+
+
+
+
+
+
+ createOutgoingPaymentFromIncomingPayment
+
+
+
+
+
Description
+
+ Create an Open Payments outgoing payment from an incoming
+ payment.
+
+
+
+
+
+
+
Example
+
+
Query
+
mutation CreateOutgoingPaymentFromIncomingPayment($input : CreateOutgoingPaymentFromIncomingPaymentInput! ) {
+ createOutgoingPaymentFromIncomingPayment(input: $input ) {
+ payment {
+ id
+ walletAddressId
+ client
+ liquidity
+ state
+ error
+ stateAttempts
+ debitAmount {
+ ...AmountFragment
+ }
+ receiveAmount {
+ ...AmountFragment
+ }
+ receiver
+ metadata
+ quote {
+ ...QuoteFragment
+ }
+ sentAmount {
+ ...AmountFragment
+ }
+ createdAt
+ grantId
+ tenant {
+ ...TenantFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{ "input" : CreateOutgoingPaymentFromIncomingPaymentInput }
+
+
+
+
Response
+
{
+ "data" : {
+ "createOutgoingPaymentFromIncomingPayment" : {
+ "payment" : OutgoingPayment
+ }
+ }
+}
+
+
+
+
+
+
+
+ createOutgoingPaymentWithdrawal
+
+
+
+
+
Description
+
Withdraw outgoing payment liquidity.
+
+
+
+
+
+
Example
+
+
Query
+
mutation CreateOutgoingPaymentWithdrawal($input : CreateOutgoingPaymentWithdrawalInput! ) {
+ createOutgoingPaymentWithdrawal(input: $input ) {
+ success
+ }
+}
+
+
+
Variables
+
{ "input" : CreateOutgoingPaymentWithdrawalInput }
+
+
+
+
Response
+
{ "data" : { "createOutgoingPaymentWithdrawal" : { "success" : true } } }
+
+
+
+
+
+
+
+ createPeer
+
+
+
+
+
Description
+
Create a new peer.
+
+
+
+
+
+
Example
+
+
Query
+
mutation CreatePeer($input : CreatePeerInput! ) {
+ createPeer(input: $input ) {
+ peer {
+ id
+ maxPacketAmount
+ http {
+ ...HttpFragment
+ }
+ asset {
+ ...AssetFragment
+ }
+ staticIlpAddress
+ name
+ liquidityThreshold
+ liquidity
+ createdAt
+ routes
+ tenant {
+ ...TenantFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{ "input" : CreatePeerInput }
+
+
+
+
Response
+
{ "data" : { "createPeer" : { "peer" : Peer } } }
+
+
+
+
+
+
+
+ createPeerLiquidityWithdrawal
+
+
+
+
+
Description
+
Withdraw peer liquidity.
+
+
+
+
+
+
Example
+
+
Query
+
mutation CreatePeerLiquidityWithdrawal($input : CreatePeerLiquidityWithdrawalInput! ) {
+ createPeerLiquidityWithdrawal(input: $input ) {
+ success
+ }
+}
+
+
+
Variables
+
{ "input" : CreatePeerLiquidityWithdrawalInput }
+
+
+
+
Response
+
{ "data" : { "createPeerLiquidityWithdrawal" : { "success" : false } } }
+
+
+
+
+
+
+
+ createQuote
+
+
+
+
+
Description
+
Create an Open Payments quote.
+
+
+
+
+
+
Example
+
+
Query
+
mutation CreateQuote($input : CreateQuoteInput! ) {
+ createQuote(input: $input ) {
+ quote {
+ id
+ tenantId
+ walletAddressId
+ receiver
+ debitAmount {
+ ...AmountFragment
+ }
+ receiveAmount {
+ ...AmountFragment
+ }
+ createdAt
+ expiresAt
+ estimatedExchangeRate
+ }
+ }
+}
+
+
+
Variables
+
{ "input" : CreateQuoteInput }
+
+
+
+
Response
+
{ "data" : { "createQuote" : { "quote" : Quote } } }
+
+
+
+
+
+
+
+ createReceiver
+
+
+
+
+
Description
+
+ Create an internal or external Open Payments incoming
+ payment. The receiver has a wallet address on either this or
+ another Open Payments resource server.
+
+
+
+
+
+
+
Example
+
+
Query
+
mutation CreateReceiver($input : CreateReceiverInput! ) {
+ createReceiver(input: $input ) {
+ receiver {
+ id
+ walletAddressUrl
+ completed
+ incomingAmount {
+ ...AmountFragment
+ }
+ receivedAmount {
+ ...AmountFragment
+ }
+ expiresAt
+ metadata
+ createdAt
+ }
+ }
+}
+
+
+
Variables
+
{ "input" : CreateReceiverInput }
+
+
+
+
Response
+
{ "data" : { "createReceiver" : { "receiver" : Receiver } } }
+
+
+
+
+
+
+
+ createTenant
+
+
+
+
+
Description
+
As an operator, create a tenant.
+
+
+
+
+
+
Example
+
+
Query
+
mutation CreateTenant($input : CreateTenantInput! ) {
+ createTenant(input: $input ) {
+ tenant {
+ id
+ email
+ apiSecret
+ idpConsentUrl
+ idpSecret
+ publicName
+ createdAt
+ deletedAt
+ settings {
+ ...TenantSettingFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{ "input" : CreateTenantInput }
+
+
+
+
Response
+
{ "data" : { "createTenant" : { "tenant" : Tenant } } }
+
+
+
+
+
+
+
+ createTenantSettings
+
+
+
+
+
Example
+
+
Query
+
mutation CreateTenantSettings($input : CreateTenantSettingsInput! ) {
+ createTenantSettings(input: $input ) {
+ settings {
+ key
+ value
+ }
+ }
+}
+
+
+
Variables
+
{ "input" : CreateTenantSettingsInput }
+
+
+
+
Response
+
{
+ "data" : {
+ "createTenantSettings" : { "settings" : [ TenantSetting ] }
+ }
+}
+
+
+
+
+
+
+
+ createWalletAddress
+
+
+
+
+
Description
+
Create a new wallet address.
+
+
+
+
+
+
Example
+
+
Query
+
mutation CreateWalletAddress($input : CreateWalletAddressInput! ) {
+ createWalletAddress(input: $input ) {
+ walletAddress {
+ id
+ asset {
+ ...AssetFragment
+ }
+ liquidity
+ address
+ publicName
+ incomingPayments {
+ ...IncomingPaymentConnectionFragment
+ }
+ quotes {
+ ...QuoteConnectionFragment
+ }
+ outgoingPayments {
+ ...OutgoingPaymentConnectionFragment
+ }
+ createdAt
+ status
+ walletAddressKeys {
+ ...WalletAddressKeyConnectionFragment
+ }
+ additionalProperties {
+ ...AdditionalPropertyFragment
+ }
+ tenant {
+ ...TenantFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{ "input" : CreateWalletAddressInput }
+
+
+
+
Response
+
{
+ "data" : {
+ "createWalletAddress" : {
+ "walletAddress" : WalletAddress
+ }
+ }
+}
+
+
+
+
+
+
+
+ createWalletAddressKey
+
+
+
+
+
Description
+
+ Add a public key to a wallet address that is used to verify
+ Open Payments requests.
+
+
+
+
+
+
+
Example
+
+
Query
+
mutation CreateWalletAddressKey($input : CreateWalletAddressKeyInput! ) {
+ createWalletAddressKey(input: $input ) {
+ walletAddressKey {
+ id
+ walletAddressId
+ jwk {
+ ...JwkFragment
+ }
+ revoked
+ createdAt
+ }
+ }
+}
+
+
+
Variables
+
{ "input" : CreateWalletAddressKeyInput }
+
+
+
+
Response
+
{
+ "data" : {
+ "createWalletAddressKey" : {
+ "walletAddressKey" : WalletAddressKey
+ }
+ }
+}
+
+
+
+
+
+
+
+ createWalletAddressWithdrawal
+
+
+
+
+
Description
+
+ Withdraw liquidity from a wallet address received via Web
+ Monetization.
+
+
+
+
+
+
+
Example
+
+
Query
+
mutation CreateWalletAddressWithdrawal($input : CreateWalletAddressWithdrawalInput! ) {
+ createWalletAddressWithdrawal(input: $input ) {
+ withdrawal {
+ id
+ amount
+ walletAddress {
+ ...WalletAddressFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{ "input" : CreateWalletAddressWithdrawalInput }
+
+
+
+
Response
+
{
+ "data" : {
+ "createWalletAddressWithdrawal" : {
+ "withdrawal" : WalletAddressWithdrawal
+ }
+ }
+}
+
+
+
+
+
+
+
+ deleteAsset
+
+
+
+
+
Description
+
Delete an asset.
+
+
+
+
+
+
Example
+
+
Query
+
mutation DeleteAsset($input : DeleteAssetInput! ) {
+ deleteAsset(input: $input ) {
+ asset {
+ id
+ code
+ scale
+ liquidity
+ withdrawalThreshold
+ liquidityThreshold
+ receivingFee {
+ ...FeeFragment
+ }
+ sendingFee {
+ ...FeeFragment
+ }
+ fees {
+ ...FeesConnectionFragment
+ }
+ createdAt
+ tenant {
+ ...TenantFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{ "input" : DeleteAssetInput }
+
+
+
+
Response
+
{ "data" : { "deleteAsset" : { "asset" : Asset } } }
+
+
+
+
+
+
+
+ deletePeer
+
+
+
+
+
Description
+
Delete a peer.
+
+
+
+
+
+
Example
+
+
Query
+
mutation DeletePeer($input : DeletePeerInput! ) {
+ deletePeer(input: $input ) {
+ success
+ }
+}
+
+
+
Variables
+
{ "input" : DeletePeerInput }
+
+
+
+
Response
+
{ "data" : { "deletePeer" : { "success" : true } } }
+
+
+
+
+
+
+
+ deleteTenant
+
+
+
+
+
Description
+
Delete a tenant.
+
+
+
+
+
+
+
Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ idString!
+
+
+
+
+
+
+
Example
+
+
Query
+
mutation DeleteTenant($id : String! ) {
+ deleteTenant(id: $id ) {
+ success
+ }
+}
+
+
+
Variables
+
{ "id" : "abc123" }
+
+
+
+
Response
+
{ "data" : { "deleteTenant" : { "success" : true } } }
+
+
+
+
+
+
+
+ depositAssetLiquidity
+
+
+
+
+
Description
+
Deposit asset liquidity.
+
+
+
+
+
+
Example
+
+
Query
+
mutation DepositAssetLiquidity($input : DepositAssetLiquidityInput! ) {
+ depositAssetLiquidity(input: $input ) {
+ success
+ }
+}
+
+
+
Variables
+
{ "input" : DepositAssetLiquidityInput }
+
+
+
+
Response
+
{ "data" : { "depositAssetLiquidity" : { "success" : false } } }
+
+
+
+
+
+
+
+ depositEventLiquidity
+
+
+
+
+
+ Use depositOutgoingPaymentLiquidity
+
+
+
+
+
+
+
Description
+
Deposit webhook event liquidity (deprecated).
+
+
+
+
+
+
Example
+
+
Query
+
mutation DepositEventLiquidity($input : DepositEventLiquidityInput! ) {
+ depositEventLiquidity(input: $input ) {
+ success
+ }
+}
+
+
+
Variables
+
{ "input" : DepositEventLiquidityInput }
+
+
+
+
Response
+
{ "data" : { "depositEventLiquidity" : { "success" : false } } }
+
+
+
+
+
+
+
+ depositOutgoingPaymentLiquidity
+
+
+
+
+
Description
+
Deposit outgoing payment liquidity.
+
+
+
+
+
+
Example
+
+
Query
+
mutation DepositOutgoingPaymentLiquidity($input : DepositOutgoingPaymentLiquidityInput! ) {
+ depositOutgoingPaymentLiquidity(input: $input ) {
+ success
+ }
+}
+
+
+
Variables
+
{ "input" : DepositOutgoingPaymentLiquidityInput }
+
+
+
+
Response
+
{ "data" : { "depositOutgoingPaymentLiquidity" : { "success" : true } } }
+
+
+
+
+
+
+
+ depositPeerLiquidity
+
+
+
+
+
Description
+
Deposit peer liquidity.
+
+
+
+
+
+
Example
+
+
Query
+
mutation DepositPeerLiquidity($input : DepositPeerLiquidityInput! ) {
+ depositPeerLiquidity(input: $input ) {
+ success
+ }
+}
+
+
+
Variables
+
{ "input" : DepositPeerLiquidityInput }
+
+
+
+
Response
+
{ "data" : { "depositPeerLiquidity" : { "success" : true } } }
+
+
+
+
+
+
+
+ postLiquidityWithdrawal
+
+
+
+
+
Description
+
+ Post liquidity withdrawal. Withdrawals are two-phase commits
+ and are committed via this mutation.
+
+
+
+
+
+
+
Example
+
+
Query
+
mutation PostLiquidityWithdrawal($input : PostLiquidityWithdrawalInput! ) {
+ postLiquidityWithdrawal(input: $input ) {
+ success
+ }
+}
+
+
+
Variables
+
{ "input" : PostLiquidityWithdrawalInput }
+
+
+
+
Response
+
{ "data" : { "postLiquidityWithdrawal" : { "success" : true } } }
+
+
+
+
+
+
+
+ revokeWalletAddressKey
+
+
+
+
+
Description
+
+ Revoke a public key associated with a wallet address. Open
+ Payment requests using this key for request signatures will
+ be denied going forward.
+
+
+
+
+
+
+
Example
+
+
Query
+
mutation RevokeWalletAddressKey($input : RevokeWalletAddressKeyInput! ) {
+ revokeWalletAddressKey(input: $input ) {
+ walletAddressKey {
+ id
+ walletAddressId
+ jwk {
+ ...JwkFragment
+ }
+ revoked
+ createdAt
+ }
+ }
+}
+
+
+
Variables
+
{ "input" : RevokeWalletAddressKeyInput }
+
+
+
+
Response
+
{
+ "data" : {
+ "revokeWalletAddressKey" : {
+ "walletAddressKey" : WalletAddressKey
+ }
+ }
+}
+
+
+
+
+
+
+
+ setFee
+
+
+
+
+
Description
+
Set the fee structure on an asset.
+
+
+
+
+
+
+
Arguments
+
+
+
+ Name
+ Description
+
+
+
+
+
+ inputSetFeeInput!
+
+
+
+
+
+
+
Example
+
+
Query
+
mutation SetFee($input : SetFeeInput! ) {
+ setFee(input: $input ) {
+ fee {
+ id
+ assetId
+ type
+ fixed
+ basisPoints
+ createdAt
+ }
+ }
+}
+
+
+
Variables
+
{ "input" : SetFeeInput }
+
+
+
+
Response
+
{ "data" : { "setFee" : { "fee" : Fee } } }
+
+
+
+
+
+
+
+ triggerWalletAddressEvents
+
+
+
+
+
Description
+
+ 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.
+
+
+
+
+
+
+
Example
+
+
Query
+
mutation TriggerWalletAddressEvents($input : TriggerWalletAddressEventsInput! ) {
+ triggerWalletAddressEvents(input: $input ) {
+ count
+ }
+}
+
+
+
Variables
+
{ "input" : TriggerWalletAddressEventsInput }
+
+
+
+
Response
+
{ "data" : { "triggerWalletAddressEvents" : { "count" : 123 } } }
+
+
+
+
+
+
+
+ updateAsset
+
+
+
+
+
Description
+
Update an existing asset.
+
+
+
+
+
+
Example
+
+
Query
+
mutation UpdateAsset($input : UpdateAssetInput! ) {
+ updateAsset(input: $input ) {
+ asset {
+ id
+ code
+ scale
+ liquidity
+ withdrawalThreshold
+ liquidityThreshold
+ receivingFee {
+ ...FeeFragment
+ }
+ sendingFee {
+ ...FeeFragment
+ }
+ fees {
+ ...FeesConnectionFragment
+ }
+ createdAt
+ tenant {
+ ...TenantFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{ "input" : UpdateAssetInput }
+
+
+
+
Response
+
{ "data" : { "updateAsset" : { "asset" : Asset } } }
+
+
+
+
+
+
+
+ updateIncomingPayment
+
+
+
+
+
Description
+
Update an existing incoming payment.
+
+
+
+
+
+
Example
+
+
Query
+
mutation UpdateIncomingPayment($input : UpdateIncomingPaymentInput! ) {
+ updateIncomingPayment(input: $input ) {
+ payment {
+ id
+ url
+ walletAddressId
+ client
+ liquidity
+ state
+ expiresAt
+ incomingAmount {
+ ...AmountFragment
+ }
+ receivedAmount {
+ ...AmountFragment
+ }
+ metadata
+ createdAt
+ senderWalletAddress
+ tenant {
+ ...TenantFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{ "input" : UpdateIncomingPaymentInput }
+
+
+
+
Response
+
{
+ "data" : {
+ "updateIncomingPayment" : { "payment" : IncomingPayment }
+ }
+}
+
+
+
+
+
+
+
+ updatePeer
+
+
+
+
+
Description
+
Update an existing peer.
+
+
+
+
+
+
Example
+
+
Query
+
mutation UpdatePeer($input : UpdatePeerInput! ) {
+ updatePeer(input: $input ) {
+ peer {
+ id
+ maxPacketAmount
+ http {
+ ...HttpFragment
+ }
+ asset {
+ ...AssetFragment
+ }
+ staticIlpAddress
+ name
+ liquidityThreshold
+ liquidity
+ createdAt
+ routes
+ tenant {
+ ...TenantFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{ "input" : UpdatePeerInput }
+
+
+
+
Response
+
{ "data" : { "updatePeer" : { "peer" : Peer } } }
+
+
+
+
+
+
+
+ updateTenant
+
+
+
+
+
Description
+
Update a tenant.
+
+
+
+
+
+
Example
+
+
Query
+
mutation UpdateTenant($input : UpdateTenantInput! ) {
+ updateTenant(input: $input ) {
+ tenant {
+ id
+ email
+ apiSecret
+ idpConsentUrl
+ idpSecret
+ publicName
+ createdAt
+ deletedAt
+ settings {
+ ...TenantSettingFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{ "input" : UpdateTenantInput }
+
+
+
+
Response
+
{ "data" : { "updateTenant" : { "tenant" : Tenant } } }
+
+
+
+
+
+
+
+ updateWalletAddress
+
+
+
+
+
Description
+
Update an existing wallet address.
+
+
+
+
+
+
Example
+
+
Query
+
mutation UpdateWalletAddress($input : UpdateWalletAddressInput! ) {
+ updateWalletAddress(input: $input ) {
+ walletAddress {
+ id
+ asset {
+ ...AssetFragment
+ }
+ liquidity
+ address
+ publicName
+ incomingPayments {
+ ...IncomingPaymentConnectionFragment
+ }
+ quotes {
+ ...QuoteConnectionFragment
+ }
+ outgoingPayments {
+ ...OutgoingPaymentConnectionFragment
+ }
+ createdAt
+ status
+ walletAddressKeys {
+ ...WalletAddressKeyConnectionFragment
+ }
+ additionalProperties {
+ ...AdditionalPropertyFragment
+ }
+ tenant {
+ ...TenantFragment
+ }
+ }
+ }
+}
+
+
+
Variables
+
{ "input" : UpdateWalletAddressInput }
+
+
+
+
Response
+
{
+ "data" : {
+ "updateWalletAddress" : {
+ "walletAddress" : WalletAddress
+ }
+ }
+}
+
+
+
+
+
+
+
+ voidLiquidityWithdrawal
+
+
+
+
+
Description
+
+ Void liquidity withdrawal. Withdrawals are two-phase commits
+ and are rolled back via this mutation.
+
+
+
+
+
+
+
Example
+
+
Query
+
mutation VoidLiquidityWithdrawal($input : VoidLiquidityWithdrawalInput! ) {
+ voidLiquidityWithdrawal(input: $input ) {
+ success
+ }
+}
+
+
+
Variables
+
{ "input" : VoidLiquidityWithdrawalInput }
+
+
+
+
Response
+
{ "data" : { "voidLiquidityWithdrawal" : { "success" : false } } }
+
+
+
+
+
+
+
+ withdrawEventLiquidity
+
+
+
+
+
+ Use
+ createOutgoingPaymentWithdrawal,
+ createIncomingPaymentWithdrawal, or
+ createWalletAddressWithdrawal
+
+
+
+
+
+
+
Description
+
Withdraw webhook event liquidity (deprecated).
+
+
+
+
+
+
Example
+
+
Query
+
mutation WithdrawEventLiquidity($input : WithdrawEventLiquidityInput! ) {
+ withdrawEventLiquidity(input: $input ) {
+ success
+ }
+}
+
+
+
Variables
+
{ "input" : WithdrawEventLiquidityInput }
+
+
+
+
Response
+
{ "data" : { "withdrawEventLiquidity" : { "success" : true } } }
+
+
+
+
+
+ Types
+
+
+ AccountingTransfer
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ idID!
+ Unique identifier for the accounting transfer.
+
+
+
+ debitAccountIdID!
+ Unique identifier for the debit account.
+
+
+
+ creditAccountIdID!
+ Unique identifier for the credit account.
+
+
+
+ amountUInt64!
+ Amount sent (fixed send).
+
+
+
+ transferTypeTransferType!
+ Type of the accounting transfer.
+
+
+
+ ledgerUInt8!
+
+ Identifier that partitions the sets of accounts that
+ can transact with each other.
+
+
+
+
+ createdAtString!
+
+ The date and time that the accounting transfer was
+ created.
+
+
+
+
+ stateTransferState!
+ The state of the accounting transfer.
+
+
+
+ expiresAtString
+
+ The date and time that the accounting transfer will
+ expire.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "id" : 4 ,
+ "debitAccountId" : 4 ,
+ "creditAccountId" : 4 ,
+ "amount" : UInt64 ,
+ "transferType" : "DEPOSIT" ,
+ "ledger" : UInt8 ,
+ "createdAt" : "xyz789" ,
+ "state" : "PENDING" ,
+ "expiresAt" : "abc123"
+}
+
+
+
+
+
+
+ AccountingTransferConnection
+
+
+
+
+
Example
+
{
+ "debits" : [ AccountingTransfer ] ,
+ "credits" : [ AccountingTransfer ]
+}
+
+
+
+
+
+
+ AdditionalProperty
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ keyString!
+ Key for the additional property.
+
+
+
+ valueString!
+ Value for the additional property.
+
+
+
+ visibleInOpenPaymentsBoolean!
+
+ Indicates whether the property is visible in Open
+ Payments wallet address requests.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "key" : "xyz789" ,
+ "value" : "abc123" ,
+ "visibleInOpenPayments" : false }
+
+
+
+
+
+
+
+ Alg
+
+
+
+
Values
+
+
+
+ Enum Value
+ Description
+
+
+
+
+
+ EdDSA
+
+ EdDSA cryptographic algorithm.
+
+
+
+
+
+
+
+
+
+ Amount
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ valueUInt64!
+ Numerical value.
+
+
+
+ assetCodeString!
+
+ Should be an ISO 4217 currency code whenever possible,
+ e.g. USD. For more information, refer to
+ assets .
+
+
+
+
+ assetScaleUInt8!
+
+ Difference in order of magnitude between the standard
+ unit of an asset and its corresponding fractional
+ unit.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "value" : UInt64 ,
+ "assetCode" : "xyz789" ,
+ "assetScale" : UInt8
+}
+
+
+
+
+
+
+
+
+ ApproveIncomingPaymentResponse
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ paymentIncomingPayment
+ The incoming payment that was approved.
+
+
+
+
+
+
+
+
Example
+
{ "payment" : IncomingPayment }
+
+
+
+
+
+
+ Asset
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ idID!
+ Unique identifier of the asset.
+
+
+
+ codeString!
+
+ Should be an ISO 4217 currency code whenever possible,
+ e.g. USD. For more information, refer to
+ assets .
+
+
+
+
+ scaleUInt8!
+
+ Difference in order of magnitude between the standard
+ unit of an asset and its corresponding fractional
+ unit.
+
+
+
+
+ liquidityUInt64
+ Available liquidity
+
+
+
+ withdrawalThresholdUInt64
+
+ Minimum amount of liquidity that can be withdrawn from
+ the asset.
+
+
+
+
+ liquidityThresholdUInt64
+
+ A webhook event will notify the Account Servicing
+ Entity if liquidity falls below this value.
+
+
+
+
+ receivingFeeFee
+ The receiving fee structure for the asset.
+
+
+
+ sendingFeeFee
+ The sending fee structure for the asset.
+
+
+
+ feesFeesConnection
+
+ Fetches a paginated list of fees associated with this
+ asset.
+
+
+
+
+
+
Arguments
+
+
+
+ afterString
+
+ Forward pagination: Cursor (fee ID) to start
+ retrieving fees after this point.
+
+
+
+
+ beforeString
+
+ Backward pagination: Cursor (fee ID) to start
+ retrieving fees before this point.
+
+
+
+
+ firstInt
+
+ Forward pagination: Limit the result to the
+ first n fees after the
+ after cursor.
+
+
+
+
+ lastInt
+
+ Backward pagination: Limit the result to the
+ last n fees before the
+ before cursor.
+
+
+
+
+ sortOrderSortOrder
+
+ Specify the sort order of fees based on their
+ creation data, either ascending or descending.
+
+
+
+
+
+
+
+ createdAtString!
+ The date and time when the asset was created.
+
+
+
+ tenantTenant
+ The tenant that the asset belongs to.
+
+
+
+
+
+
+
+
Example
+
{
+ "id" : 4 ,
+ "code" : "xyz789" ,
+ "scale" : UInt8 ,
+ "liquidity" : UInt64 ,
+ "withdrawalThreshold" : UInt64 ,
+ "liquidityThreshold" : UInt64 ,
+ "receivingFee" : Fee ,
+ "sendingFee" : Fee ,
+ "fees" : FeesConnection ,
+ "createdAt" : "xyz789" ,
+ "tenant" : Tenant
+}
+
+
+
+
+
+
+ AssetEdge
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ nodeAsset!
+ An asset node in the list.
+
+
+
+ cursorString!
+ A cursor for paginating through the assets.
+
+
+
+
+
+
+
+
Example
+
{
+ "node" : Asset ,
+ "cursor" : "xyz789"
+}
+
+
+
+
+
+
+ AssetMutationResponse
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ assetAsset
+ The asset affected by the mutation.
+
+
+
+
+
+
+
+
Example
+
{ "asset" : Asset }
+
+
+
+
+
+
+ AssetsConnection
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ pageInfoPageInfo!
+ Information to aid in pagination.
+
+
+
+ edges[AssetEdge!]!
+
+ A list of edges representing assets and cursors for
+ pagination.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "pageInfo" : PageInfo ,
+ "edges" : [ AssetEdge ]
+}
+
+
+
+
+
+
+ BasePayment
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ idID!
+ Unique identifier for the payment.
+
+
+
+ walletAddressIdID!
+
+ Unique identifier of the wallet address under which
+ the payment was created.
+
+
+
+
+ metadataJSONObject
+
+ Additional metadata associated with the payment.
+
+
+
+
+ createdAtString!
+ The date and time that the payment was created.
+
+
+
+ clientString
+
+ Information about the wallet address of the Open
+ Payments client that created the payment.
+
+
+
+
+
+
+
+
+
+
Example
+
{
+ "id" : "4" ,
+ "walletAddressId" : "4" ,
+ "metadata" : { } ,
+ "createdAt" : "abc123" ,
+ "client" : "xyz789"
+}
+
+
+
+
+
+
+ Boolean
+
+
+
+
Description
+
+ The Boolean scalar type represents
+ true or false.
+
+
+
+
+
+
+
+
+ CancelIncomingPaymentResponse
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ paymentIncomingPayment
+ The incoming payment that was canceled.
+
+
+
+
+
+
+
+
Example
+
{ "payment" : IncomingPayment }
+
+
+
+
+
+
+
+
+ CardPaymentFailureReason
+
+
+
+
Values
+
+
+
+ Enum Value
+ Description
+
+
+
+
+
+ invalid_signature
+
+
+
+
+ invalid_request
+
+
+
+
+
+
+
+
+
Example
+
"invalid_signature"
+
+
+
+
+
+
+
+ CompleteReceiverResponse
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ receiverReceiver
+ The receiver object returned in the response.
+
+
+
+
+
+
+
+
Example
+
{ "receiver" : Receiver }
+
+
+
+
+
+
+
+
+
+
+
+
+ CreateOrUpdatePeerByUrlMutationResponse
+
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ peerPeer
+ The peer created or updated based on a URL.
+
+
+
+
+
+
+
+
Example
+
{ "peer" : Peer }
+
+
+
+
+
+
+
+
+
+
+
+ CreatePeerMutationResponse
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ peerPeer
+ The peer created by the mutation.
+
+
+
+
+
+
+
+
Example
+
{ "peer" : Peer }
+
+
+
+
+
+
+
+
+ CreateReceiverResponse
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ receiverReceiver
+ The receiver object returned in the response.
+
+
+
+
+
+
+
+
Example
+
{ "receiver" : Receiver }
+
+
+
+
+
+
+
+
+
+ CreateTenantSettingsMutationResponse
+
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ settings[TenantSetting!]!
+ New tenant settings.
+
+
+
+
+
+
+
+
Example
+
{ "settings" : [ TenantSetting ] }
+
+
+
+
+
+
+
+
+
+ CreateWalletAddressKeyMutationResponse
+
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ walletAddressKeyWalletAddressKey
+ The wallet address key that was created.
+
+
+
+
+
+
+
+
Example
+
{ "walletAddressKey" : WalletAddressKey }
+
+
+
+
+
+
+
+ CreateWalletAddressMutationResponse
+
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ walletAddressWalletAddress
+ The newly created wallet address.
+
+
+
+
+
+
+
+
Example
+
{ "walletAddress" : WalletAddress }
+
+
+
+
+
+
+
+ Crv
+
+
+
+
Values
+
+
+
+ Enum Value
+ Description
+
+
+
+
+
+ Ed25519
+
+
+ Elliptic curve Ed25519, used in EdDSA.
+
+
+
+
+
+
+
+
+
Example
+
"Ed25519"
+
+
+
+
+
+
+
+ DeleteAssetMutationResponse
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ assetAsset
+ The asset that was deleted.
+
+
+
+
+
+
+
+
Example
+
{ "asset" : Asset }
+
+
+
+
+
+
+
+ DeletePeerMutationResponse
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ successBoolean!
+
+ Indicates whether the peer deletion was successful.
+
+
+
+
+
+
+
+
+
Example
+
{ "success" : false }
+
+
+
+
+
+
+ DeleteTenantMutationResponse
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ successBoolean!
+
+
+
+
+
+
+
+
Example
+
{ "success" : true }
+
+
+
+
+
+
+
+
+
+
+ Fee
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ idID!
+ Unique identifier of the fee.
+
+
+
+ assetIdID!
+
+ Unique identifier of the asset associated with the
+ fee.
+
+
+
+
+ typeFeeType!
+ Type of fee, either sending or receiving.
+
+
+
+ fixedUInt64!
+ Amount of the flat, fixed fee to charge.
+
+
+
+ basisPointsInt!
+
+ Basis points fee is a variable fee charged based on
+ the total amount. Should be between 0 and 10000
+ (inclusive). 1 basis point = 0.01%, 100 basis points =
+ 1%, 10000 basis points = 100%.
+
+
+
+
+ createdAtString!
+ The date and time that this fee was created.
+
+
+
+
+
+
+
+
Example
+
{
+ "id" : 4 ,
+ "assetId" : 4 ,
+ "type" : "SENDING" ,
+ "fixed" : UInt64 ,
+ "basisPoints" : 987 ,
+ "createdAt" : "abc123"
+}
+
+
+
+
+
+
+
+ FeeEdge
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ nodeFee!
+ A fee node in the list.
+
+
+
+ cursorString!
+ A cursor for paginating through the fees.
+
+
+
+
+
+
+
+
Example
+
{
+ "node" : Fee ,
+ "cursor" : "xyz789"
+}
+
+
+
+
+
+
+ FeeType
+
+
+
+
Values
+
+
+
+ Enum Value
+ Description
+
+
+
+
+
+ SENDING
+
+ The sender is responsible for paying the fees.
+
+
+
+ RECEIVING
+
+
+ The receiver is responsible for paying the fees.
+
+
+
+
+
+
+
+
+
Example
+
"SENDING"
+
+
+
+
+
+
+ FeesConnection
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ pageInfoPageInfo!
+ Pagination information for fees.
+
+
+
+ edges[FeeEdge!]!
+
+ A list of fee edges, containing fee nodes and cursors
+ for pagination.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "pageInfo" : PageInfo ,
+ "edges" : [ FeeEdge ]
+}
+
+
+
+
+
+
+
+ Float
+
+
+
+
Description
+
+ The Float scalar type represents signed
+ double-precision fractional values as specified by
+ IEEE 754 .
+
+
+
+
+
+
+
+ Http
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ outgoingHttpOutgoing!
+ Details of the outgoing connection for peering.
+
+
+
+
+
+
+
+
Example
+
{ "outgoing" : HttpOutgoing }
+
+
+
+
+
+
+
+
+ HttpOutgoing
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ authTokenString!
+
+ Authorization token to be presented to the peer's
+ Rafiki instance.
+
+
+
+
+ endpointString!
+ Connection endpoint of the peer.
+
+
+
+
+
+
+
+
Example
+
{
+ "authToken" : "xyz789" ,
+ "endpoint" : "xyz789"
+}
+
+
+
+
+
+
+
+ ID
+
+
+
+
Description
+
+ The ID scalar type represents a unique
+ identifier, often used to refetch an object or as key for a
+ cache. The ID type appears in a JSON response as a String;
+ however, it is not intended to be human-readable. When
+ expected as an input type, any string (such as
+ "4") or integer (such as
+ 4) input value will be accepted as an ID.
+
+
+
+
+
+
+
+ IncomingPayment
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ idID!
+ Unique identifier of the incoming payment.
+
+
+
+ urlString!
+ The URL of the incoming payment.
+
+
+
+ walletAddressIdID!
+
+ Unique identifier of the wallet address under which
+ the incoming payment was created.
+
+
+
+
+ clientString
+
+ Information about the wallet address of the Open
+ Payments client that created the incoming payment.
+
+
+
+
+ liquidityUInt64
+
+ Current amount of liquidity available for this
+ incoming payment.
+
+
+
+
+ stateIncomingPaymentState!
+ State of the incoming payment.
+
+
+
+ expiresAtString!
+
+ Date and time that the incoming payment will expire.
+ After this time, the incoming payment will not accept
+ further payments made to it.
+
+
+
+
+ incomingAmountAmount
+
+ The maximum amount that should be paid into the wallet
+ address under this incoming payment.
+
+
+
+
+ receivedAmountAmount!
+
+ The total amount that has been paid into the wallet
+ address under this incoming payment.
+
+
+
+
+ metadataJSONObject
+
+ Additional metadata associated with the incoming
+ payment.
+
+
+
+
+ createdAtString!
+
+ The date and time that the incoming payment was
+ created.
+
+
+
+
+ senderWalletAddressString
+
+ The sender's wallet address URL. Applicable only to
+ card payments.
+
+
+
+
+ tenantTenant
+
+ The tenant associated with the incoming payment. If
+ not provided, it will be obtained from the signature.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "id" : 4 ,
+ "url" : "abc123" ,
+ "walletAddressId" : 4 ,
+ "client" : "xyz789" ,
+ "liquidity" : UInt64 ,
+ "state" : "PENDING" ,
+ "expiresAt" : "xyz789" ,
+ "incomingAmount" : Amount ,
+ "receivedAmount" : Amount ,
+ "metadata" : { } ,
+ "createdAt" : "abc123" ,
+ "senderWalletAddress" : "xyz789" ,
+ "tenant" : Tenant
+}
+
+
+
+
+
+
+ IncomingPaymentConnection
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ pageInfoPageInfo!
+
+ Pagination information for the incoming payments.
+
+
+
+
+ edges[IncomingPaymentEdge!]!
+
+ A list of incoming payment edges, containing incoming
+ payment nodes and cursors for pagination.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "pageInfo" : PageInfo ,
+ "edges" : [ IncomingPaymentEdge ]
+}
+
+
+
+
+
+
+ IncomingPaymentEdge
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ nodeIncomingPayment!
+ An incoming payment node in the list.
+
+
+
+ cursorString!
+
+ A cursor for paginating through the incoming payments.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "node" : IncomingPayment ,
+ "cursor" : "xyz789"
+}
+
+
+
+
+
+
+
+ IncomingPaymentResponse
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ paymentIncomingPayment
+
+ The incoming payment object returned in the response.
+
+
+
+
+
+
+
+
+
Example
+
{ "payment" : IncomingPayment }
+
+
+
+
+
+
+ IncomingPaymentState
+
+
+
+
Values
+
+
+
+ Enum Value
+ Description
+
+
+
+
+
+ PENDING
+
+
+ The payment is pending when it is initially created
+ and has not started processing.
+
+
+
+
+ PROCESSING
+
+
+ The payment is being processed after funds have
+ started clearing into the account.
+
+
+
+
+ COMPLETED
+
+
+ The payment is completed automatically once the
+ expected incomingAmount is received or
+ manually via an API call.
+
+
+
+
+ EXPIRED
+
+
+ The payment has expired before completion, and no
+ further funds will be accepted.
+
+
+
+
+
+
+
+
+
Example
+
"PENDING"
+
+
+
+
+
+
+ Int
+
+
+
+
Description
+
+ The Int scalar type represents non-fractional
+ signed whole numeric values. Int can represent values
+ between -(2^31) and 2^31 - 1.
+
+
+
+
+
+
+
+ JSONObject
+
+
+
+
Description
+
+ The JSONObject scalar type represents JSON
+ objects as specified by the
+ ECMA-404
+ standard.
+
+
+
+
+
+
+
+ Jwk
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ kidString!
+ Unique identifier for the key.
+
+
+
+ xString!
+ Base64 url-encoded public key.
+
+
+
+ algAlg!
+
+ Cryptographic algorithm used with the key. The only
+ allowed value is EdDSA.
+
+
+
+
+ ktyKty!
+
+ Key type. The only allowed value is OKP.
+
+
+
+
+ crvCrv!
+
+ Cryptographic curve that the key pair is derived from.
+ The only allowed value is Ed25519.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "kid" : "abc123" ,
+ "x" : "abc123" ,
+ "alg" : "EdDSA" ,
+ "kty" : "OKP" ,
+ "crv" : "Ed25519"
+}
+
+
+
+
+
+
+
+ Kty
+
+
+
+
Values
+
+
+
+ Enum Value
+ Description
+
+
+
+
+
+ OKP
+
+ Octet Key Pair (OKP) key type.
+
+
+
+
+
+
+
+
+
+ LiquidityMutationResponse
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ successBoolean!
+
+ Indicates whether the liquidity operation was
+ successful.
+
+
+
+
+
+
+
+
+
Example
+
{ "success" : false }
+
+
+
+
+
+
+ Model
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ idID!
+ Unique identifier for the entity.
+
+
+
+ createdAtString!
+ The date and time that the entity was created.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "id" : "4" ,
+ "createdAt" : "xyz789"
+}
+
+
+
+
+
+
+ OutgoingPayment
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ idID!
+ Unique identifier of the outgoing payment.
+
+
+
+ walletAddressIdID!
+
+ Unique identifier of the wallet address under which
+ the outgoing payment was created.
+
+
+
+
+ clientString
+
+ Information about the wallet address of the Open
+ Payments client that created the outgoing payment.
+
+
+
+
+ liquidityUInt64
+
+ Current amount of liquidity available for this
+ outgoing payment.
+
+
+
+
+ stateOutgoingPaymentState!
+ State of the outgoing payment.
+
+
+
+ errorString
+
+ Any error encountered during the payment process.
+
+
+
+
+ stateAttemptsInt!
+
+ Number of attempts made to send an outgoing payment.
+
+
+
+
+ debitAmountAmount!
+ Amount to send (fixed send).
+
+
+
+ receiveAmountAmount!
+ Amount to receive (fixed receive).
+
+
+
+ receiverString!
+ Wallet address URL of the receiver.
+
+
+
+ metadataJSONObject
+
+ Additional metadata associated with the outgoing
+ payment.
+
+
+
+
+ quoteQuote
+ Corresponding quote for the outgoing payment.
+
+
+
+ sentAmountAmount!
+ Amount already sent.
+
+
+
+ createdAtString!
+
+ The date and time that the outgoing payment was
+ created.
+
+
+
+
+ grantIdString
+
+ Unique identifier of the grant under which the
+ outgoing payment was created.
+
+
+
+
+ tenantTenant
+ Tenant of the outgoing payment.
+
+
+
+
+
+
+
+
Example
+
{
+ "id" : 4 ,
+ "walletAddressId" : 4 ,
+ "client" : "xyz789" ,
+ "liquidity" : UInt64 ,
+ "state" : "FUNDING" ,
+ "error" : "xyz789" ,
+ "stateAttempts" : 987 ,
+ "debitAmount" : Amount ,
+ "receiveAmount" : Amount ,
+ "receiver" : "abc123" ,
+ "metadata" : { } ,
+ "quote" : Quote ,
+ "sentAmount" : Amount ,
+ "createdAt" : "abc123" ,
+ "grantId" : "abc123" ,
+ "tenant" : Tenant
+}
+
+
+
+
+
+
+ OutgoingPaymentConnection
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ pageInfoPageInfo!
+
+ Pagination information for the outgoing payments.
+
+
+
+
+ edges[OutgoingPaymentEdge!]!
+
+ A list of outgoing payment edges, containing outgoing
+ payment nodes and cursors for pagination.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "pageInfo" : PageInfo ,
+ "edges" : [ OutgoingPaymentEdge ]
+}
+
+
+
+
+
+
+ OutgoingPaymentEdge
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ nodeOutgoingPayment!
+ An outgoing payment node in the list.
+
+
+
+ cursorString!
+
+ A cursor for paginating through the outgoing payments.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "node" : OutgoingPayment ,
+ "cursor" : "abc123"
+}
+
+
+
+
+
+
+
+ OutgoingPaymentResponse
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ paymentOutgoingPayment
+
+ The outgoing payment object returned in the response.
+
+
+
+
+
+
+
+
+
Example
+
{ "payment" : OutgoingPayment }
+
+
+
+
+
+
+ OutgoingPaymentState
+
+
+
+
Values
+
+
+
+ Enum Value
+ Description
+
+
+
+
+
+ FUNDING
+
+
+ The payment is reserving funds and will transition to
+ SENDING once funds are secured.
+
+
+
+
+ SENDING
+
+
+ The payment is in progress and will transition to
+ COMPLETED upon success.
+
+
+
+
+ COMPLETED
+
+ The payment has been successfully completed.
+
+
+
+ FAILED
+
+ The payment has failed.
+
+
+
+ CANCELLED
+
+ The payment has been canceled.
+
+
+
+
+
+
+
+
Example
+
"FUNDING"
+
+
+
+
+
+
+ PageInfo
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ endCursorString
+
+ The cursor used to fetch the next page when paginating
+ forwards.
+
+
+
+
+ hasNextPageBoolean!
+
+ Indicates if there are more pages when paginating
+ forwards.
+
+
+
+
+ hasPreviousPageBoolean!
+
+ Indicates if there are more pages when paginating
+ backwards.
+
+
+
+
+ startCursorString
+
+ The cursor used to fetch the next page when paginating
+ backwards.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "endCursor" : "xyz789" ,
+ "hasNextPage" : true ,
+ "hasPreviousPage" : true ,
+ "startCursor" : "abc123"
+}
+
+
+
+
+
+
+ Payment
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ idID!
+ Unique identifier of the payment.
+
+
+
+ typePaymentType!
+ Type of payment, either incoming or outgoing.
+
+
+
+ walletAddressIdID!
+
+ Unique identifier of the wallet address under which
+ the payment was created.
+
+
+
+
+ clientString
+
+ Information about the wallet address of the Open
+ Payments client that created the payment.
+
+
+
+
+ stateString!
+
+ State of the payment, either
+ IncomingPaymentState or
+ OutgoingPaymentState according to payment
+ type
+
+
+
+
+ liquidityUInt64
+
+ Current amount of liquidity available for this
+ payment.
+
+
+
+
+ metadataJSONObject
+
+ Additional metadata associated with the payment.
+
+
+
+
+ createdAtString!
+ The date and time that the payment was created.
+
+
+
+ tenantTenant
+ The tenant associated with the payment.
+
+
+
+
+
+
+
+
Example
+
{
+ "id" : "4" ,
+ "type" : "INCOMING" ,
+ "walletAddressId" : 4 ,
+ "client" : "xyz789" ,
+ "state" : "abc123" ,
+ "liquidity" : UInt64 ,
+ "metadata" : { } ,
+ "createdAt" : "abc123" ,
+ "tenant" : Tenant
+}
+
+
+
+
+
+
+ PaymentConnection
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ pageInfoPageInfo!
+ Pagination information for the payments.
+
+
+
+ edges[PaymentEdge!]!
+
+ A list of payment edges, containing payment nodes and
+ cursors for pagination.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "pageInfo" : PageInfo ,
+ "edges" : [ PaymentEdge ]
+}
+
+
+
+
+
+
+ PaymentEdge
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ nodePayment!
+ A payment node in the list.
+
+
+
+ cursorString!
+ A cursor for paginating through the payments.
+
+
+
+
+
+
+
+
Example
+
{
+ "node" : Payment ,
+ "cursor" : "xyz789"
+}
+
+
+
+
+
+
+
+ PaymentType
+
+
+
+
Values
+
+
+
+ Enum Value
+ Description
+
+
+
+
+
+ INCOMING
+
+ Represents an incoming payment.
+
+
+
+ OUTGOING
+
+ Represents an outgoing payment.
+
+
+
+
+
+
+
+
Example
+
"INCOMING"
+
+
+
+
+
+
+ Peer
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ idID!
+ Unique identifier of the peer.
+
+
+
+ maxPacketAmountUInt64
+ Maximum packet amount that the peer accepts.
+
+
+
+ httpHttp!
+ Peering connection details.
+
+
+
+ assetAsset!
+ Asset of peering relationship.
+
+
+
+ staticIlpAddressString!
+ ILP address of the peer.
+
+
+
+ nameString
+ Public name for the peer.
+
+
+
+ liquidityThresholdUInt64
+
+ A webhook event will notify the Account Servicing
+ Entity if liquidity falls below this value.
+
+
+
+
+ liquidityUInt64
+ Current amount of peer liquidity available.
+
+
+
+ createdAtString!
+ The date and time when the peer was created.
+
+
+
+ routes[String!]!
+ Routes for the peer.
+
+
+
+ tenantTenant
+
+ Unique identifier of the tenant associated with the
+ peer.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "id" : "4" ,
+ "maxPacketAmount" : UInt64 ,
+ "http" : Http ,
+ "asset" : Asset ,
+ "staticIlpAddress" : "abc123" ,
+ "name" : "xyz789" ,
+ "liquidityThreshold" : UInt64 ,
+ "liquidity" : UInt64 ,
+ "createdAt" : "abc123" ,
+ "routes" : [ "abc123" ] ,
+ "tenant" : Tenant
+}
+
+
+
+
+
+
+ PeerEdge
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ nodePeer!
+ A peer node in the list.
+
+
+
+ cursorString!
+ A cursor for paginating through the peers.
+
+
+
+
+
+
+
+
Example
+
{
+ "node" : Peer ,
+ "cursor" : "xyz789"
+}
+
+
+
+
+
+
+ PeersConnection
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ pageInfoPageInfo!
+ Information to aid in pagination.
+
+
+
+ edges[PeerEdge!]!
+
+ A list of edges representing peers and cursors for
+ pagination.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "pageInfo" : PageInfo ,
+ "edges" : [ PeerEdge ]
+}
+
+
+
+
+
+
+
+ Quote
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ idID!
+ Unique identifier of the quote.
+
+
+
+ tenantIdID!
+
+ Unique identifier of the tenant under which the quote
+ was created.
+
+
+
+
+ walletAddressIdID!
+
+ Unique identifier of the wallet address under which
+ the quote was created.
+
+
+
+
+ receiverString!
+ Wallet address URL of the receiver.
+
+
+
+ debitAmountAmount!
+ Amount to send (fixed send).
+
+
+
+ receiveAmountAmount!
+ Amount to receive (fixed receive).
+
+
+
+ createdAtString!
+ The date and time that the quote was created.
+
+
+
+ expiresAtString!
+ The date and time that the quote will expire.
+
+
+
+ estimatedExchangeRateFloat
+ Estimated exchange rate for this quote.
+
+
+
+
+
+
+
+
Example
+
{
+ "id" : "4" ,
+ "tenantId" : "4" ,
+ "walletAddressId" : 4 ,
+ "receiver" : "xyz789" ,
+ "debitAmount" : Amount ,
+ "receiveAmount" : Amount ,
+ "createdAt" : "abc123" ,
+ "expiresAt" : "abc123" ,
+ "estimatedExchangeRate" : 987.65
+}
+
+
+
+
+
+
+ QuoteConnection
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ pageInfoPageInfo!
+ Pagination information for quotes.
+
+
+
+ edges[QuoteEdge!]!
+
+ A list of quote edges, containing quote nodes and
+ cursors for pagination.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "pageInfo" : PageInfo ,
+ "edges" : [ QuoteEdge ]
+}
+
+
+
+
+
+
+ QuoteEdge
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ nodeQuote!
+ A quote node in the list.
+
+
+
+ cursorString!
+ A cursor for paginating through the quotes.
+
+
+
+
+
+
+
+
Example
+
{
+ "node" : Quote ,
+ "cursor" : "abc123"
+}
+
+
+
+
+
+
+ QuoteResponse
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ quoteQuote
+ The quote object returned in the response.
+
+
+
+
+
+
+
+
Example
+
{ "quote" : Quote }
+
+
+
+
+
+
+ Receiver
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ idString!
+
+ Unique identifier of the receiver (incoming payment
+ URL).
+
+
+
+
+ walletAddressUrlString!
+
+ Wallet address URL under which the incoming payment
+ was created.
+
+
+
+
+ completedBoolean!
+
+ Indicates whether the incoming payment has completed
+ receiving funds.
+
+
+
+
+ incomingAmountAmount
+
+ The maximum amount that should be paid into the wallet
+ address under this incoming payment.
+
+
+
+
+ receivedAmountAmount!
+
+ The total amount that has been paid into the wallet
+ address under this incoming payment.
+
+
+
+
+ expiresAtString
+
+ Date and time that the incoming payment will expire.
+ After this time, the incoming payment will not accept
+ further payments made to it.
+
+
+
+
+ metadataJSONObject
+
+ Additional metadata associated with the incoming
+ payment.
+
+
+
+
+ createdAtString!
+
+ The date and time that the incoming payment was
+ created.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "id" : "xyz789" ,
+ "walletAddressUrl" : "abc123" ,
+ "completed" : true ,
+ "incomingAmount" : Amount ,
+ "receivedAmount" : Amount ,
+ "expiresAt" : "xyz789" ,
+ "metadata" : { } ,
+ "createdAt" : "xyz789"
+}
+
+
+
+
+
+
+
+
+ RevokeWalletAddressKeyMutationResponse
+
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ walletAddressKeyWalletAddressKey
+ The wallet address key that was revoked.
+
+
+
+
+
+
+
+
Example
+
{ "walletAddressKey" : WalletAddressKey }
+
+
+
+
+
+
+
+ SetFeeResponse
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ feeFee
+ The fee that was set.
+
+
+
+
+
+
+
+
Example
+
{ "fee" : Fee }
+
+
+
+
+
+
+ SortOrder
+
+
+
+
Values
+
+
+
+ Enum Value
+ Description
+
+
+
+
+
+ ASC
+
+ Sort the results in ascending order.
+
+
+
+ DESC
+
+ Sort the results in descending order.
+
+
+
+
+
+
+
+
+
+ String
+
+
+
+
Description
+
+ The String scalar type represents textual data,
+ represented as UTF-8 character sequences. The String type is
+ most often used by GraphQL to represent free-form
+ human-readable text.
+
+
+
+
+
+
+
+ Tenant
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ idID!
+ Unique identifier of the tenant.
+
+
+
+ emailString
+ Contact email of the tenant owner.
+
+
+
+ apiSecretString!
+
+ Secret used to secure requests made for this tenant.
+
+
+
+
+ idpConsentUrlString
+
+ URL of the tenant's identity provider's consent
+ screen.
+
+
+
+
+ idpSecretString
+
+ Secret used to secure requests from the tenant's
+ identity provider.
+
+
+
+
+ publicNameString
+ Public name for the tenant.
+
+
+
+ createdAtString!
+ The date and time that this tenant was created.
+
+
+
+ deletedAtString
+ The date and time that this tenant was deleted.
+
+
+
+ settings[TenantSetting!]!
+ List of settings for the tenant.
+
+
+
+
+
+
+
+
Example
+
{
+ "id" : "4" ,
+ "email" : "abc123" ,
+ "apiSecret" : "abc123" ,
+ "idpConsentUrl" : "xyz789" ,
+ "idpSecret" : "abc123" ,
+ "publicName" : "abc123" ,
+ "createdAt" : "xyz789" ,
+ "deletedAt" : "xyz789" ,
+ "settings" : [ TenantSetting ]
+}
+
+
+
+
+
+
+ TenantEdge
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ nodeTenant!
+ A tenant node in the list.
+
+
+
+ cursorString!
+ A cursor for paginating through the tenants.
+
+
+
+
+
+
+
+
Example
+
{
+ "node" : Tenant ,
+ "cursor" : "abc123"
+}
+
+
+
+
+
+
+ TenantMutationResponse
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ tenantTenant!
+
+
+
+
+
+
+
+
Example
+
{ "tenant" : Tenant }
+
+
+
+
+
+
+ TenantSetting
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ keyTenantSettingKey!
+ Key for this setting.
+
+
+
+ valueString!
+ Value of a setting for this key.
+
+
+
+
+
+
+
+
Example
+
{
+ "key" : "EXCHANGE_RATES_URL" ,
+ "value" : "xyz789"
+}
+
+
+
+
+
+
+
+ TenantSettingKey
+
+
+
+
Values
+
+
+
+ Enum Value
+ Description
+
+
+
+
+
+ EXCHANGE_RATES_URL
+
+
+
+
+ WEBHOOK_URL
+
+
+
+
+ WEBHOOK_TIMEOUT
+
+
+
+
+ WEBHOOK_MAX_RETRY
+
+
+
+
+ WALLET_ADDRESS_URL
+
+
+
+
+ ILP_ADDRESS
+
+
+
+
+
+
+
+
+
Example
+
"EXCHANGE_RATES_URL"
+
+
+
+
+
+
+ TenantsConnection
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ pageInfoPageInfo!
+ Information to aid in pagination.
+
+
+
+ edges[TenantEdge!]!
+
+ A list of edges representing tenants and cursors for
+ pagination.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "pageInfo" : PageInfo ,
+ "edges" : [ TenantEdge ]
+}
+
+
+
+
+
+
+ TransferState
+
+
+
+
Values
+
+
+
+ Enum Value
+ Description
+
+
+
+
+
+ PENDING
+
+ The accounting transfer is pending
+
+
+
+ POSTED
+
+ The accounting transfer is posted
+
+
+
+ VOIDED
+
+ The accounting transfer is voided
+
+
+
+
+
+
+
+
Example
+
"PENDING"
+
+
+
+
+
+
+ TransferType
+
+
+
+
Values
+
+
+
+ Enum Value
+ Description
+
+
+
+
+
+ DEPOSIT
+
+ Represents a deposit transfer.
+
+
+
+ WITHDRAWAL
+
+ Represents a withdrawal transfer.
+
+
+
+ TRANSFER
+
+ Represents a generic transfer within Rafiki.
+
+
+
+
+
+
+
+
Example
+
"DEPOSIT"
+
+
+
+
+
+
+
+
+ TriggerWalletAddressEventsMutationResponse
+
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ countInt
+ The number of events that were triggered.
+
+
+
+
+
+
+
+
Example
+
{ "count" : 987 }
+
+
+
+
+
+
+ UInt64
+
+
+
+
Description
+
+ The UInt64 scalar type represents unsigned
+ 64-bit whole numeric values. It is capable of handling
+ values that are larger than the JavaScript
+ Number type limit (greater than 2^53).
+
+
+
+
+
+
+
+ UInt8
+
+
+
+
Description
+
+ The UInt8 scalar type represents unsigned 8-bit
+ whole numeric values, ranging from 0 to 255.
+
+
+
+
+
+
+
+
+
+
+ UpdatePeerMutationResponse
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ peerPeer
+ The peer that was updated.
+
+
+
+
+
+
+
+
Example
+
{ "peer" : Peer }
+
+
+
+
+
+
+
+
+
+ UpdateWalletAddressMutationResponse
+
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ walletAddressWalletAddress
+ The updated wallet address.
+
+
+
+
+
+
+
+
Example
+
{ "walletAddress" : WalletAddress }
+
+
+
+
+
+
+
+ WalletAddress
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ idID!
+ Unique identifier of the wallet address.
+
+
+
+ assetAsset!
+ Asset of the wallet address.
+
+
+
+ liquidityUInt64
+
+ Current amount of liquidity available for this wallet
+ address.
+
+
+
+
+ addressString!
+ Wallet Address.
+
+
+
+ publicNameString
+
+ Public name associated with the wallet address. This
+ is visible to anyone with the wallet address URL.
+
+
+
+
+ incomingPaymentsIncomingPaymentConnection
+
+ List of incoming payments received by this wallet
+ address
+
+
+
+
+
+
Arguments
+
+
+
+ afterString
+
+ Forward pagination: Cursor (incoming payment
+ ID) to start retrieving incoming payments
+ after this point.
+
+
+
+
+ beforeString
+
+ Backward pagination: Cursor (incoming payment
+ ID) to start retrieving incoming payments
+ before this point.
+
+
+
+
+ firstInt
+
+ Forward pagination: Limit the result to the
+ first n incoming payments
+ after the after cursor.
+
+
+
+
+ lastInt
+
+ Backward pagination: Limit the result to the
+ last n incoming payments
+ before the before cursor.
+
+
+
+
+ sortOrderSortOrder
+
+ Specify the sort order of incoming payments
+ based on their creation date, either ascending
+ or descending.
+
+
+
+
+
+ Filter incoming payments based on specific
+ criteria such as initiation reason.
+
+
+
+
+
+
+
+ quotesQuoteConnection
+ List of quotes created at this wallet address
+
+
+
+
+
Arguments
+
+
+
+ afterString
+
+ Forward pagination: Cursor (quote ID) to start
+ retrieving quotes after this point.
+
+
+
+
+ beforeString
+
+ Backward pagination: Cursor (quote ID) to
+ start retrieving quotes before this point.
+
+
+
+
+ firstInt
+
+ Forward pagination: Limit the result to the
+ first n quotes after the
+ after cursor.
+
+
+
+
+ lastInt
+
+ Backward pagination: Limit the result to the
+ last n quotes before the
+ before cursor.
+
+
+
+
+ sortOrderSortOrder
+
+ Specify the sort order of quotes based on
+ their creation data, either ascending or
+ descending.
+
+
+
+
+
+
+
+ outgoingPaymentsOutgoingPaymentConnection
+
+ List of outgoing payments sent from this wallet
+ address
+
+
+
+
+
+
Arguments
+
+
+
+ afterString
+
+ Forward pagination: Cursor (outgoing payment
+ ID) to start retrieving outgoing payments
+ after this point.
+
+
+
+
+ beforeString
+
+ Backward pagination: Cursor (outgoing payment
+ ID) to start retrieving outgoing payments
+ before this point.
+
+
+
+
+ firstInt
+
+ Forward pagination: Limit the result to the
+ first n outgoing payments
+ after the after cursor.
+
+
+
+
+ lastInt
+
+ Backward pagination: Limit the result to the
+ last n outgoing payments
+ before the before cursor.
+
+
+
+
+ sortOrderSortOrder
+
+ Specify the sort order of outgoing payments
+ based on their creation date, either ascending
+ or descending.
+
+
+
+
+
+
+
+ createdAtString!
+
+ The date and time when the wallet address was created.
+
+
+
+
+ statusWalletAddressStatus!
+
+ The current status of the wallet, either active or
+ inactive.
+
+
+
+
+ walletAddressKeysWalletAddressKeyConnection
+
+ List of keys associated with this wallet address
+
+
+
+
+
+
Arguments
+
+
+
+ afterString
+
+ Forward pagination: Cursor (wallet address key
+ ID) to start retrieving keys after this point.
+
+
+
+
+ beforeString
+
+ Backward pagination: Cursor (wallet address
+ key ID) to start retrieving keys before this
+ point.
+
+
+
+
+ firstInt
+
+ Forward pagination: Limit the result to the
+ first n keys after the
+ after cursor.
+
+
+
+
+ lastInt
+
+ Backward pagination: Limit the result to the
+ last n keys before the
+ before cursor.
+
+
+
+
+ sortOrderSortOrder
+
+ Specify the sort order of keys based on their
+ creation data, either ascending or descending.
+
+
+
+
+
+
+
+ additionalProperties[AdditionalProperty]
+
+ Additional properties associated with the wallet
+ address.
+
+
+
+
+ tenantTenant
+ Tenant of the wallet address.
+
+
+
+
+
+
+
+
Example
+
{
+ "id" : "4" ,
+ "asset" : Asset ,
+ "liquidity" : UInt64 ,
+ "address" : "xyz789" ,
+ "publicName" : "abc123" ,
+ "incomingPayments" : IncomingPaymentConnection ,
+ "quotes" : QuoteConnection ,
+ "outgoingPayments" : OutgoingPaymentConnection ,
+ "createdAt" : "xyz789" ,
+ "status" : "INACTIVE" ,
+ "walletAddressKeys" : WalletAddressKeyConnection ,
+ "additionalProperties" : [ AdditionalProperty ] ,
+ "tenant" : Tenant
+}
+
+
+
+
+
+
+ WalletAddressEdge
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ nodeWalletAddress!
+ A wallet address node in the list.
+
+
+
+ cursorString!
+
+ A cursor for paginating through the wallet addresses.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "node" : WalletAddress ,
+ "cursor" : "xyz789"
+}
+
+
+
+
+
+
+ WalletAddressKey
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ idID!
+
+ Unique internal identifier for the wallet address key.
+
+
+
+
+ walletAddressIdID!
+
+ Unique identifier of the wallet address to associate
+ with the key.
+
+
+
+
+ jwkJwk!
+
+ The public key object in JSON Web Key (JWK) format.
+
+
+
+
+ revokedBoolean!
+ Indicator of whether the key has been revoked.
+
+
+
+ createdAtString!
+
+ The date and time that this wallet address key was
+ created.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "id" : "4" ,
+ "walletAddressId" : "4" ,
+ "jwk" : Jwk ,
+ "revoked" : false ,
+ "createdAt" : "xyz789"
+}
+
+
+
+
+
+
+ WalletAddressKeyConnection
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ pageInfoPageInfo!
+ Pagination information for wallet address keys.
+
+
+
+ edges[WalletAddressKeyEdge!]!
+
+ A list of wallet address key edges, containing wallet
+ address key nodes and cursors for pagination.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "pageInfo" : PageInfo ,
+ "edges" : [ WalletAddressKeyEdge ]
+}
+
+
+
+
+
+
+ WalletAddressKeyEdge
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ nodeWalletAddressKey!
+ A wallet address key node in the list.
+
+
+
+ cursorString!
+
+ A cursor for paginating through the wallet address
+ keys.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "node" : WalletAddressKey ,
+ "cursor" : "xyz789"
+}
+
+
+
+
+
+
+ WalletAddressStatus
+
+
+
+
Values
+
+
+
+ Enum Value
+ Description
+
+
+
+
+
+ INACTIVE
+
+ The status after deactivating a wallet address.
+
+
+
+ ACTIVE
+
+ The default status of a wallet address.
+
+
+
+
+
+
+
+
Example
+
"INACTIVE"
+
+
+
+
+
+
+ WalletAddressWithdrawal
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ idID!
+ Unique identifier for the withdrawal.
+
+
+
+ amountUInt64!
+ Amount to be withdrawn.
+
+
+
+ walletAddressWalletAddress!
+
+ Details about the wallet address from which the
+ withdrawal is made.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "id" : "4" ,
+ "amount" : UInt64 ,
+ "walletAddress" : WalletAddress
+}
+
+
+
+
+
+
+
+ WalletAddressWithdrawalMutationResponse
+
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ withdrawalWalletAddressWithdrawal
+
+ The wallet address withdrawal that was processed.
+
+
+
+
+
+
+
+
+
Example
+
{ "withdrawal" : WalletAddressWithdrawal }
+
+
+
+
+
+
+ WalletAddressesConnection
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ pageInfoPageInfo!
+
+ Pagination information for the wallet addresses.
+
+
+
+
+ edges[WalletAddressEdge!]!
+
+ A list of wallet address edges, containing wallet
+ address nodes and cursors for pagination.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "pageInfo" : PageInfo ,
+ "edges" : [ WalletAddressEdge ]
+}
+
+
+
+
+
+
+ WebhookEvent
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ idID!
+ Unique identifier of the webhook event.
+
+
+
+ tenantTenant
+ Tenant of the webhook event.
+
+
+
+ typeString!
+ Type of webhook event.
+
+
+
+ dataJSONObject!
+ Stringified JSON data for the webhook event.
+
+
+
+ createdAtString!
+
+ The date and time when the webhook event was created.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "id" : 4 ,
+ "tenant" : Tenant ,
+ "type" : "xyz789" ,
+ "data" : { } ,
+ "createdAt" : "xyz789"
+}
+
+
+
+
+
+
+
+ WebhookEventsConnection
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ pageInfoPageInfo!
+ Pagination information for webhook events.
+
+
+
+ edges[WebhookEventsEdge!]!
+
+ A list of webhook event edges, containing event nodes
+ and cursors for pagination.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "pageInfo" : PageInfo ,
+ "edges" : [ WebhookEventsEdge ]
+}
+
+
+
+
+
+
+ WebhookEventsEdge
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ nodeWebhookEvent!
+ A webhook event node in the list.
+
+
+
+ cursorString!
+
+ A cursor for paginating through the webhook events.
+
+
+
+
+
+
+
+
+
Example
+
{
+ "node" : WebhookEvent ,
+ "cursor" : "xyz789"
+}
+
+
+
+
+
+
+ WhoamiResponse
+
+
+
+
Fields
+
+
+
+ Field Name
+ Description
+
+
+
+
+
+ idString!
+
+
+
+ isOperatorBoolean!
+
+
+
+
+
+
+
+
Example
+
{ "id" : "abc123" , "isOperator" : false }
+
+
+
+
+
+
+
+
+
+
+
+