Skip to content
GitHub

Objects

Access

Implements

Fields

NameDescription
id
ID!

Unique identifier of the access object.

identifier
String

Wallet address of the sub-resource (incoming payment, outgoing payment, or quote).

type
String!

Type of access (incoming payment, outgoing payment, or quote).

actions
[String]!

Actions allowed with this access.

limits
LimitData

Limits for an outgoing payment associated with this access.

createdAt
String!

The date and time when the access was created.

Grant

Implements

Fields

NameDescription
id
ID!

Unique identifier of the grant.

client
String!

Wallet address of the grantee's account.

access
[Access!]!

Details of the access provided by the grant.

state
GrantState!

Current state of the grant.

finalizationReason
GrantFinalization

Specific outcome of a finalized grant, indicating whether the grant was issued, revoked, or rejected.

createdAt
String!

The date and time when the grant was created.

GrantEdge

Fields

NameDescription
node
Grant!

A grant node in the list.

cursor
String!

A cursor for paginating through the grants.

GrantsConnection

Fields

NameDescription
pageInfo
PageInfo!

Information to aid in pagination.

edges
[GrantEdge!]!

A list of edges representing grants and cursors for pagination.

LimitData

Fields

NameDescription
receiver
String

Wallet address URL of the receiver.

debitAmount
PaymentAmount

Amount to debit.

receiveAmount
PaymentAmount

Amount to receive.

interval
String

Interval between payments.

PageInfo

Fields

NameDescription
endCursor
String

The cursor used to fetch the next page when paginating forward.

hasNextPage
Boolean!

Indicates if there are more pages when paginating forward.

hasPreviousPage
Boolean!

Indicates if there are more pages when paginating backward.

startCursor
String

The cursor used to fetch the next page when paginating backward.

PaymentAmount

Fields

NameDescription
value
UInt64!

The value of the payment amount.

assetCode
String!

Should be an ISO 4217 currency code whenever possible, e.g. USD. For more information, refer to assets.

assetScale
UInt8!

Difference in orders of magnitude between the standard unit of an asset and a corresponding fractional unit.

RevokeGrantMutationResponse

Fields

NameDescription
id
ID!

Unique identifier of the revoked grant.