Skip to main content
Version: 0.62.0-rc.1267

Customer API Reference

This API reference has been automatically generated from the Customer GraphQL schema.

Queries​

creditFacility​

No description

creditFacility(
  id: CreditFacilityId!
): CreditFacility

Arguments​

creditFacility.id ● CreditFacilityId! non-null scalar​

Type​

CreditFacility object​

exchangeRates​

Every currency pair the bank prices, not just BTC/USD - a customer holding a non-USD facility needs its pair too. Mirrors admin's exchangeRates.

exchangeRates: [ExchangeRate!]!

Type​

ExchangeRate object​

One currency pair the bank prices, e.g. BTC quoted in EUR.

me​

No description

me: Me!

Type​

Me object​

Mutations​

creditFacilityProposalCustomerApprovalConclude​

No description

creditFacilityProposalCustomerApprovalConclude(
  input: CreditFacilityProposalCustomerApprovalConcludeInput!
): CreditFacilityProposalCustomerApprovalConcludePayload!

Arguments​

creditFacilityProposalCustomerApprovalConclude.input ● CreditFacilityProposalCustomerApprovalConcludeInput! non-null input​

Type​

CreditFacilityProposalCustomerApprovalConcludePayload object​

Directives (Operations)​

include​

Directs the executor to include this field or fragment only when the if argument is true.

directive @include(
  if: Boolean!
) on 
  | FIELD
  | FRAGMENT_SPREAD
  | INLINE_FRAGMENT

Arguments​

include.if ● Boolean! non-null scalar​

skip​

Directs the executor to skip this field or fragment when the if argument is true.

directive @skip(
  if: Boolean!
) on 
  | FIELD
  | FRAGMENT_SPREAD
  | INLINE_FRAGMENT

Arguments​

skip.if ● Boolean! non-null scalar​

Objects​

CancelledWithdrawalEntry​

No description

type CancelledWithdrawalEntry {
  recordedAt: Timestamp!
  withdrawal: Withdrawal!
}

Fields​

CancelledWithdrawalEntry.recordedAt ● Timestamp! non-null scalar​

CancelledWithdrawalEntry.withdrawal ● Withdrawal! non-null object​

Implemented By​

DepositAccountHistoryEntry union

CreditFacility​

No description

type CreditFacility {
  activatedAt: Timestamp!
  balance: CreditFacilityBalance!
  collateralCurrency: Currency!
  collateralizationState: CollateralizationState!
  creditFacilityId: CreditFacilityId!
  creditFacilityTerms: TermValues!
  currentLtv: LtvPct!
  disbursals: [CreditFacilityDisbursal!]!
  facilityAmount: Money!
  history: [CreditFacilityHistoryEntry!]!
  liquidations: [Liquidation!]!
  maturityDate: AccountingDate!
  product: CreditFacilityProduct!
  publicId: PublicId!
  repaymentPlan: [CreditFacilityRepaymentPlanEntry!]!
  status: CreditFacilityStatus!
  wallet: Wallet
}

Fields​

CreditFacility.activatedAt ● Timestamp! non-null scalar​

CreditFacility.balance ● CreditFacilityBalance! non-null object​

CreditFacility.collateralCurrency ● Currency! non-null object​

CreditFacility.collateralizationState ● CollateralizationState! non-null enum​

CreditFacility.creditFacilityId ● CreditFacilityId! non-null scalar​

CreditFacility.creditFacilityTerms ● TermValues! non-null object​

CreditFacility.currentLtv ● LtvPct! non-null union​

CreditFacility.disbursals ● [CreditFacilityDisbursal!]! non-null object​

CreditFacility.facilityAmount ● Money! non-null object​

CreditFacility.history ● [CreditFacilityHistoryEntry!]! non-null union​

CreditFacility.liquidations ● [Liquidation!]! non-null object​

CreditFacility.maturityDate ● AccountingDate! non-null scalar​

CreditFacility.product ● CreditFacilityProduct! non-null object​

CreditFacility.publicId ● PublicId! non-null scalar​

CreditFacility.repaymentPlan ● [CreditFacilityRepaymentPlanEntry!]! non-null object​

CreditFacility.status ● CreditFacilityStatus! non-null enum​

CreditFacility.wallet ● Wallet object​

Where collateral for this facility is sent.

Returned By​

creditFacility query

Member Of​

CreditFacilityPaymentAllocation object ● Customer object

CreditFacilityApproved​

No description

type CreditFacilityApproved {
  amount: Money!
  effective: AccountingDate!
  ledgerTransactionId: LedgerTransactionId!
  recordedAt: Timestamp!
}

Fields​

CreditFacilityApproved.amount ● Money! non-null object​

CreditFacilityApproved.effective ● AccountingDate! non-null scalar​

CreditFacilityApproved.ledgerTransactionId ● LedgerTransactionId! non-null scalar​

CreditFacilityApproved.recordedAt ● Timestamp! non-null scalar​

Implemented By​

CreditFacilityHistoryEntry union

CreditFacilityBalance​

No description

type CreditFacilityBalance {
  collateral: Money!
  disbursed: Disbursed!
  dueOutstanding: Money!
  facilityRemaining: Money!
  interest: Interest!
  outstanding: Money!
  outstandingPayable: Money!
  paymentsUnapplied: Money!
}

Fields​

CreditFacilityBalance.collateral ● Money! non-null object​

CreditFacilityBalance.disbursed ● Disbursed! non-null object​

CreditFacilityBalance.dueOutstanding ● Money! non-null object​

CreditFacilityBalance.facilityRemaining ● Money! non-null object​

CreditFacilityBalance.interest ● Interest! non-null object​

CreditFacilityBalance.outstanding ● Money! non-null object​

CreditFacilityBalance.outstandingPayable ● Money! non-null object​

CreditFacilityBalance.paymentsUnapplied ● Money! non-null object​

Member Of​

CreditFacility object

CreditFacilityCollateralizationUpdated​

No description

type CreditFacilityCollateralizationUpdated {
  collateral: Money!
  effective: AccountingDate!
  exchangeRate: Money!
  liquidationId: LiquidationId
  outstandingDisbursal: Money!
  outstandingInterest: Money!
  recordedAt: Timestamp!
  state: CollateralizationState!
}

Fields​

CreditFacilityCollateralizationUpdated.collateral ● Money! non-null object​

CreditFacilityCollateralizationUpdated.effective ● AccountingDate! non-null scalar​

CreditFacilityCollateralizationUpdated.exchangeRate ● Money! non-null object​

CreditFacilityCollateralizationUpdated.liquidationId ● LiquidationId scalar​

CreditFacilityCollateralizationUpdated.outstandingDisbursal ● Money! non-null object​

CreditFacilityCollateralizationUpdated.outstandingInterest ● Money! non-null object​

CreditFacilityCollateralizationUpdated.recordedAt ● Timestamp! non-null scalar​

CreditFacilityCollateralizationUpdated.state ● CollateralizationState! non-null enum​

Implemented By​

CreditFacilityHistoryEntry union

CreditFacilityCollateralSentOut​

No description

type CreditFacilityCollateralSentOut {
  amount: Money!
  effective: AccountingDate!
  ledgerTransactionId: LedgerTransactionId!
  recordedAt: Timestamp!
}

Fields​

CreditFacilityCollateralSentOut.amount ● Money! non-null object​

CreditFacilityCollateralSentOut.effective ● AccountingDate! non-null scalar​

CreditFacilityCollateralSentOut.ledgerTransactionId ● LedgerTransactionId! non-null scalar​

CreditFacilityCollateralSentOut.recordedAt ● Timestamp! non-null scalar​

Implemented By​

CreditFacilityHistoryEntry union

CreditFacilityCollateralUpdated​

No description

type CreditFacilityCollateralUpdated {
  amount: Money!
  effective: AccountingDate!
  recordedAt: Timestamp!
}

Fields​

CreditFacilityCollateralUpdated.amount ● Money! non-null object​

CreditFacilityCollateralUpdated.effective ● AccountingDate! non-null scalar​

CreditFacilityCollateralUpdated.recordedAt ● Timestamp! non-null scalar​

Implemented By​

CreditFacilityHistoryEntry union

CreditFacilityDisbursal​

No description

type CreditFacilityDisbursal {
  amount: Money!
  createdAt: Timestamp!
  creditFacilityDisbursalId: CreditFacilityDisbursalId!
  publicId: PublicId!
  status: DisbursalStatus!
}

Fields​

CreditFacilityDisbursal.amount ● Money! non-null object​

CreditFacilityDisbursal.createdAt ● Timestamp! non-null scalar​

CreditFacilityDisbursal.creditFacilityDisbursalId ● CreditFacilityDisbursalId! non-null scalar​

CreditFacilityDisbursal.publicId ● PublicId! non-null scalar​

CreditFacilityDisbursal.status ● DisbursalStatus! non-null enum​

Member Of​

CreditFacility object ● DisbursalEntry object

CreditFacilityDisbursalExecuted​

No description

type CreditFacilityDisbursalExecuted {
  amount: Money!
  effective: AccountingDate!
  ledgerTransactionId: LedgerTransactionId!
  recordedAt: Timestamp!
}

Fields​

CreditFacilityDisbursalExecuted.amount ● Money! non-null object​

CreditFacilityDisbursalExecuted.effective ● AccountingDate! non-null scalar​

CreditFacilityDisbursalExecuted.ledgerTransactionId ● LedgerTransactionId! non-null scalar​

CreditFacilityDisbursalExecuted.recordedAt ● Timestamp! non-null scalar​

Implemented By​

CreditFacilityHistoryEntry union

CreditFacilityIncrementalPayment​

No description

type CreditFacilityIncrementalPayment {
  amount: Money!
  effective: AccountingDate!
  paymentAllocationId: PaymentAllocationId!
  recordedAt: Timestamp!
}

Fields​

CreditFacilityIncrementalPayment.amount ● Money! non-null object​

CreditFacilityIncrementalPayment.effective ● AccountingDate! non-null scalar​

CreditFacilityIncrementalPayment.paymentAllocationId ● PaymentAllocationId! non-null scalar​

CreditFacilityIncrementalPayment.recordedAt ● Timestamp! non-null scalar​

Implemented By​

CreditFacilityHistoryEntry union

CreditFacilityInterestAccrued​

No description

type CreditFacilityInterestAccrued {
  amount: Money!
  days: Int!
  effective: AccountingDate!
  ledgerTransactionId: LedgerTransactionId!
  recordedAt: Timestamp!
}

Fields​

CreditFacilityInterestAccrued.amount ● Money! non-null object​

CreditFacilityInterestAccrued.days ● Int! non-null scalar​

CreditFacilityInterestAccrued.effective ● AccountingDate! non-null scalar​

CreditFacilityInterestAccrued.ledgerTransactionId ● LedgerTransactionId! non-null scalar​

CreditFacilityInterestAccrued.recordedAt ● Timestamp! non-null scalar​

Implemented By​

CreditFacilityHistoryEntry union

CreditFacilityPaymentAllocation​

No description

type CreditFacilityPaymentAllocation {
  amount: Money!
  createdAt: Timestamp!
  creditFacility: CreditFacility!
  creditFacilityPaymentAllocationId: CreditFacilityPaymentAllocationId!
}

Fields​

CreditFacilityPaymentAllocation.amount ● Money! non-null object​

CreditFacilityPaymentAllocation.createdAt ● Timestamp! non-null scalar​

CreditFacilityPaymentAllocation.creditFacility ● CreditFacility! non-null object​

CreditFacilityPaymentAllocation.creditFacilityPaymentAllocationId ● CreditFacilityPaymentAllocationId! non-null scalar​

Member Of​

PaymentEntry object

CreditFacilityProduct​

The product a facility was opened under.

type CreditFacilityProduct {
  creditFacilityProductId: CreditFacilityProductId!
  name: String!
}

Fields​

CreditFacilityProduct.creditFacilityProductId ● CreditFacilityProductId! non-null scalar​

CreditFacilityProduct.name ● String! non-null scalar​

Member Of​

CreditFacility object

CreditFacilityProposal​

No description

type CreditFacilityProposal {
  approvalProcessId: ApprovalProcessId
  createdAt: Timestamp!
  creditFacilityProposalId: CreditFacilityProposalId!
  creditFacilityTerms: TermValues!
  facilityAmount: Money!
  status: CreditFacilityProposalStatus!
}

Fields​

CreditFacilityProposal.approvalProcessId ● ApprovalProcessId scalar​

CreditFacilityProposal.createdAt ● Timestamp! non-null scalar​

CreditFacilityProposal.creditFacilityProposalId ● CreditFacilityProposalId! non-null scalar​

CreditFacilityProposal.creditFacilityTerms ● TermValues! non-null object​

CreditFacilityProposal.facilityAmount ● Money! non-null object​

CreditFacilityProposal.status ● CreditFacilityProposalStatus! non-null enum​

Member Of​

CreditFacilityProposalCustomerApprovalConcludePayload object ● Customer object

CreditFacilityProposalCustomerApprovalConcludePayload​

No description

type CreditFacilityProposalCustomerApprovalConcludePayload {
  creditFacilityProposal: CreditFacilityProposal!
}

Fields​

CreditFacilityProposalCustomerApprovalConcludePayload.creditFacilityProposal ● CreditFacilityProposal! non-null object​

Returned By​

creditFacilityProposalCustomerApprovalConclude mutation

CreditFacilityRepaymentAmountReceived​

No description

type CreditFacilityRepaymentAmountReceived {
  amount: Money!
  effective: AccountingDate!
  ledgerTransactionId: LedgerTransactionId!
  recordedAt: Timestamp!
}

Fields​

CreditFacilityRepaymentAmountReceived.amount ● Money! non-null object​

CreditFacilityRepaymentAmountReceived.effective ● AccountingDate! non-null scalar​

CreditFacilityRepaymentAmountReceived.ledgerTransactionId ● LedgerTransactionId! non-null scalar​

CreditFacilityRepaymentAmountReceived.recordedAt ● Timestamp! non-null scalar​

Implemented By​

CreditFacilityHistoryEntry union

CreditFacilityRepaymentPlanEntry​

No description

type CreditFacilityRepaymentPlanEntry {
  accrualAt: Timestamp!
  dueAt: AccountingDate!
  initial: Money!
  outstanding: Money!
  repaymentType: CreditFacilityRepaymentType!
  status: CreditFacilityRepaymentStatus!
}

Fields​

CreditFacilityRepaymentPlanEntry.accrualAt ● Timestamp! non-null scalar​

CreditFacilityRepaymentPlanEntry.dueAt ● AccountingDate! non-null scalar​

CreditFacilityRepaymentPlanEntry.initial ● Money! non-null object​

CreditFacilityRepaymentPlanEntry.outstanding ● Money! non-null object​

CreditFacilityRepaymentPlanEntry.repaymentType ● CreditFacilityRepaymentType! non-null enum​

CreditFacilityRepaymentPlanEntry.status ● CreditFacilityRepaymentStatus! non-null enum​

Member Of​

CreditFacility object

Currency​

No description

type Currency {
  code: CurrencyCode!
  isFiat: Boolean!
  minorUnitsPerMajor: Int!
}

Fields​

Currency.code ● CurrencyCode! non-null scalar​

Currency.isFiat ● Boolean! non-null scalar​

Currency.minorUnitsPerMajor ● Int! non-null scalar​

Member Of​

CreditFacility object ● CurrencyPair object ● DepositAccount object ● Money object

CurrencyPair​

No description

type CurrencyPair {
  base: Currency!
  quote: Currency!
}

Fields​

CurrencyPair.base ● Currency! non-null object​

CurrencyPair.quote ● Currency! non-null object​

Member Of​

ExchangeRate object

Custodian​

The custodian safekeeping a wallet.

type Custodian {
  createdAt: Timestamp!
  custodianId: CustodianId!
  name: String!
  provider: String!
}

Fields​

Custodian.createdAt ● Timestamp! non-null scalar​

Custodian.custodianId ● CustodianId! non-null scalar​

Custodian.name ● String! non-null scalar​

Custodian.provider ● String! non-null scalar​

Member Of​

Wallet object

Customer​

No description

type Customer {
  createdAt: Timestamp!
  creditFacilities: [CreditFacility!]!
  creditFacilityProposals: [CreditFacilityProposal!]!
  customerId: CustomerId!
  depositAccounts: [DepositAccount!]!
  level: KycLevel!
  party: Party!
  pendingCreditFacilities: [PendingCreditFacility!]!
  publicId: PublicId!
  status: CustomerStatus!
}

Fields​

Customer.createdAt ● Timestamp! non-null scalar​

Customer.creditFacilities ● [CreditFacility!]! non-null object​

Customer.creditFacilityProposals ● [CreditFacilityProposal!]! non-null object​

Customer.customerId ● CustomerId! non-null scalar​

Customer.depositAccounts ● [DepositAccount!]! non-null object​

Customer.level ● KycLevel! non-null enum​

Customer.party ● Party! non-null union​

Customer.pendingCreditFacilities ● [PendingCreditFacility!]! non-null object​

Customer.publicId ● PublicId! non-null scalar​

Customer.status ● CustomerStatus! non-null enum​

Member Of​

Me object

Deposit​

No description

type Deposit {
  accountId: DepositAccountId!
  amount: Money!
  createdAt: Timestamp!
  depositId: DepositId!
  publicId: PublicId!
  reference: String!
  status: DepositStatus!
}

Fields​

Deposit.accountId ● DepositAccountId! non-null scalar​

Deposit.amount ● Money! non-null object​

Deposit.createdAt ● Timestamp! non-null scalar​

Deposit.depositId ● DepositId! non-null scalar​

Deposit.publicId ● PublicId! non-null scalar​

Deposit.reference ● String! non-null scalar​

Deposit.status ● DepositStatus! non-null enum​

Member Of​

DepositAccount object ● DepositEntry object

DepositAccount​

No description

type DepositAccount {
  balance: DepositAccountBalance!
  createdAt: Timestamp!
  currency: Currency!
  customerId: CustomerId!
  depositAccountId: DepositAccountId!
  deposits: [Deposit!]!
  history(
    after: String
    first: Int!
  ): DepositAccountHistoryEntryConnection!
  paymentEndpoint: PaymentEndpoint!
  publicId: PublicId!
  status: DepositAccountStatus!
  withdrawals: [Withdrawal!]!
}

Fields​

DepositAccount.balance ● DepositAccountBalance! non-null object​

DepositAccount.createdAt ● Timestamp! non-null scalar​

DepositAccount.currency ● Currency! non-null object​

DepositAccount.customerId ● CustomerId! non-null scalar​

DepositAccount.depositAccountId ● DepositAccountId! non-null scalar​

DepositAccount.deposits ● [Deposit!]! non-null object​

DepositAccount.history ● DepositAccountHistoryEntryConnection! non-null object​

DepositAccount.history.after ● String scalar​
DepositAccount.history.first ● Int! non-null scalar​

DepositAccount.paymentEndpoint ● PaymentEndpoint! non-null object​

Where inbound transfers to this account are sent.

DepositAccount.publicId ● PublicId! non-null scalar​

DepositAccount.status ● DepositAccountStatus! non-null enum​

DepositAccount.withdrawals ● [Withdrawal!]! non-null object​

Member Of​

Customer object

DepositAccountBalance​

No description

type DepositAccountBalance {
  pending: Money!
  settled: Money!
}

Fields​

DepositAccountBalance.pending ● Money! non-null object​

DepositAccountBalance.settled ● Money! non-null object​

Member Of​

DepositAccount object

DepositAccountHistoryEntryConnection​

No description

type DepositAccountHistoryEntryConnection {
  edges: [DepositAccountHistoryEntryEdge!]!
  nodes: [DepositAccountHistoryEntry!]!
  pageInfo: PageInfo!
}

Fields​

DepositAccountHistoryEntryConnection.edges ● [DepositAccountHistoryEntryEdge!]! non-null object​

A list of edges.

DepositAccountHistoryEntryConnection.nodes ● [DepositAccountHistoryEntry!]! non-null union​

A list of nodes.

DepositAccountHistoryEntryConnection.pageInfo ● PageInfo! non-null object​

Information to aid in pagination.

Member Of​

DepositAccount object

DepositAccountHistoryEntryEdge​

An edge in a connection.

type DepositAccountHistoryEntryEdge {
  cursor: String!
  node: DepositAccountHistoryEntry!
}

Fields​

DepositAccountHistoryEntryEdge.cursor ● String! non-null scalar​

A cursor for use in pagination

DepositAccountHistoryEntryEdge.node ● DepositAccountHistoryEntry! non-null union​

The item at the end of the edge

Member Of​

DepositAccountHistoryEntryConnection object

DepositEntry​

No description

type DepositEntry {
  deposit: Deposit!
  recordedAt: Timestamp!
}

Fields​

DepositEntry.deposit ● Deposit! non-null object​

DepositEntry.recordedAt ● Timestamp! non-null scalar​

Implemented By​

DepositAccountHistoryEntry union

DisbursalEntry​

No description

type DisbursalEntry {
  amount: Money!
  disbursal: CreditFacilityDisbursal!
  recordedAt: Timestamp!
}

Fields​

DisbursalEntry.amount ● Money! non-null object​

DisbursalEntry.disbursal ● CreditFacilityDisbursal! non-null object​

DisbursalEntry.recordedAt ● Timestamp! non-null scalar​

Implemented By​

DepositAccountHistoryEntry union

Disbursed​

No description

type Disbursed {
  dueOutstanding: Money!
  outstanding: Money!
  outstandingPayable: Money!
  total: Money!
}

Fields​

Disbursed.dueOutstanding ● Money! non-null object​

Disbursed.outstanding ● Money! non-null object​

Disbursed.outstandingPayable ● Money! non-null object​

Disbursed.total ● Money! non-null object​

Member Of​

CreditFacilityBalance object

Duration​

No description

type Duration {
  period: Period!
  units: Int!
}

Fields​

Duration.period ● Period! non-null enum​

Duration.units ● Int! non-null scalar​

Member Of​

TermValues object

ExchangeRate​

One currency pair the bank prices, e.g. BTC quoted in EUR.

type ExchangeRate {
  asOf: Timestamp
  freshness: Freshness!
  pair: CurrencyPair!
  rate: Decimal!
  rateInQuote: Money!
}

Fields​

ExchangeRate.asOf ● Timestamp scalar​

ExchangeRate.freshness ● Freshness! non-null enum​

ExchangeRate.pair ● CurrencyPair! non-null object​

ExchangeRate.rate ● Decimal! non-null scalar​

One unit of pair.base priced in pair.quote, exactly.

rateInQuote renders the same figure as Money, which rounds it to the quote currency's minor units - lossy for a rate, since EUR/USD carries more significant digits than USD has cents. Use this for arithmetic and rateInQuote.display for presentation.

ExchangeRate.rateInQuote ● Money! non-null object​

One unit of pair.base priced in pair.quote, rounded to that currency's minor units.

Returned By​

exchangeRates query

FiniteLtvPct​

No description

type FiniteLtvPct {
  value: LtvPctValue!
}

Fields​

FiniteLtvPct.value ● LtvPctValue! non-null scalar​

Implemented By​

LtvPct union

FreezeEntry​

No description

type FreezeEntry {
  amount: Money!
  ledgerTransactionId: LedgerTransactionId!
  recordedAt: Timestamp!
}

Fields​

FreezeEntry.amount ● Money! non-null object​

FreezeEntry.ledgerTransactionId ● LedgerTransactionId! non-null scalar​

FreezeEntry.recordedAt ● Timestamp! non-null scalar​

Implemented By​

DepositAccountHistoryEntry union

FullName​

No description

type FullName {
  first: String!
  last: String!
}

Fields​

FullName.first ● String! non-null scalar​

FullName.last ● String! non-null scalar​

Member Of​

PersonalInfo object

IndividualParty​

No description

type IndividualParty {
  customerType: CustomerType!
  email: String!
  individualPartyId: IndividualPartyId!
  personalInfo: PersonalInfo
}

Fields​

IndividualParty.customerType ● CustomerType! non-null enum​

IndividualParty.email ● String! non-null scalar​

IndividualParty.individualPartyId ● IndividualPartyId! non-null scalar​

IndividualParty.personalInfo ● PersonalInfo object​

Implemented By​

Party union

InfiniteLtvPct​

No description

type InfiniteLtvPct {
  isInfinite: Boolean!
}

Fields​

InfiniteLtvPct.isInfinite ● Boolean! non-null scalar​

Implemented By​

LtvPct union

Interest​

No description

type Interest {
  dueOutstanding: Money!
  outstanding: Money!
  outstandingPayable: Money!
  total: Money!
}

Fields​

Interest.dueOutstanding ● Money! non-null object​

Interest.outstanding ● Money! non-null object​

Interest.outstandingPayable ● Money! non-null object​

Interest.total ● Money! non-null object​

Member Of​

CreditFacilityBalance object

Liquidation​

No description

type Liquidation {
  amountReceived: Money!
  collateralId: CollateralId!
  completed: Boolean!
  createdAt: Timestamp!
  expectedToReceive: Money!
  initiallyEstimatedToLiquidate: Money!
  liquidationId: LiquidationId!
  receivedProceeds: [LiquidationProceedsReceived!]!
  sentCollateral: [LiquidationCollateralSent!]!
  sentTotal: Money!
}

Fields​

Liquidation.amountReceived ● Money! non-null object​

Liquidation.collateralId ● CollateralId! non-null scalar​

Liquidation.completed ● Boolean! non-null scalar​

Liquidation.createdAt ● Timestamp! non-null scalar​

Liquidation.expectedToReceive ● Money! non-null object​

Liquidation.initiallyEstimatedToLiquidate ● Money! non-null object​

Liquidation.liquidationId ● LiquidationId! non-null scalar​

Liquidation.receivedProceeds ● [LiquidationProceedsReceived!]! non-null object​

Liquidation.sentCollateral ● [LiquidationCollateralSent!]! non-null object​

Liquidation.sentTotal ● Money! non-null object​

Member Of​

CreditFacility object

LiquidationCollateralSent​

No description

type LiquidationCollateralSent {
  amount: Money!
  ledgerTransactionId: LedgerTransactionId!
}

Fields​

LiquidationCollateralSent.amount ● Money! non-null object​

LiquidationCollateralSent.ledgerTransactionId ● LedgerTransactionId! non-null scalar​

Member Of​

Liquidation object

LiquidationProceedsReceived​

No description

type LiquidationProceedsReceived {
  amount: Money!
  ledgerTransactionId: LedgerTransactionId!
}

Fields​

LiquidationProceedsReceived.amount ● Money! non-null object​

LiquidationProceedsReceived.ledgerTransactionId ● LedgerTransactionId! non-null scalar​

Member Of​

Liquidation object

Me​

No description

type Me {
  customer: Customer!
}

Fields​

Me.customer ● Customer! non-null object​

Returned By​

me query

Money​

No description

type Money {
  amount: MinorUnits!
  currency: Currency!
  display: String!
}

Fields​

Money.amount ● MinorUnits! non-null scalar​

The amount in the minor unit of currency.

Money.currency ● Currency! non-null object​

Money.display ● String! non-null scalar​

The amount at its currency's own scale, e.g. 1234.56 USD.

Canonical rather than localized: no grouping separators and no symbol, so it is unambiguous across currencies. Clients wanting their own presentation should use amount with currency.minorUnitsPerMajor.

Member Of​

CreditFacility object ● CreditFacilityApproved object ● CreditFacilityBalance object ● CreditFacilityCollateralizationUpdated object ● CreditFacilityCollateralSentOut object ● CreditFacilityCollateralUpdated object ● CreditFacilityDisbursal object ● CreditFacilityDisbursalExecuted object ● CreditFacilityIncrementalPayment object ● CreditFacilityInterestAccrued object ● CreditFacilityPaymentAllocation object ● CreditFacilityProposal object ● CreditFacilityRepaymentAmountReceived object ● CreditFacilityRepaymentPlanEntry object ● Deposit object ● DepositAccountBalance object ● DisbursalEntry object ● Disbursed object ● ExchangeRate object ● FreezeEntry object ● Interest object ● Liquidation object ● LiquidationCollateralSent object ● LiquidationProceedsReceived object ● PendingCreditFacility object ● PendingCreditFacilityCollateralizationUpdated object ● UnfreezeEntry object ● Withdrawal object

OrganizationParty​

No description

type OrganizationParty {
  companyName: String!
  countryOfIncorporation: CountryCode!
  customerType: CustomerType!
  email: String!
  organizationPartyId: OrganizationPartyId!
}

Fields​

OrganizationParty.companyName ● String! non-null scalar​

OrganizationParty.countryOfIncorporation ● CountryCode! non-null scalar​

OrganizationParty.customerType ● CustomerType! non-null enum​

OrganizationParty.email ● String! non-null scalar​

OrganizationParty.organizationPartyId ● OrganizationPartyId! non-null scalar​

Implemented By​

Party union

PageInfo​

Information about pagination in a connection

type PageInfo {
  endCursor: String
  hasNextPage: Boolean!
  hasPreviousPage: Boolean!
  startCursor: String
}

Fields​

PageInfo.endCursor ● String scalar​

When paginating forwards, the cursor to continue.

PageInfo.hasNextPage ● Boolean! non-null scalar​

When paginating forwards, are there more items?

PageInfo.hasPreviousPage ● Boolean! non-null scalar​

When paginating backwards, are there more items?

PageInfo.startCursor ● String scalar​

When paginating backwards, the cursor to continue.

Member Of​

DepositAccountHistoryEntryConnection object

PaymentEndpoint​

No description

type PaymentEndpoint {
  locators: [PaymentEndpointLocator!]!
  paymentEndpointId: PaymentEndpointId!
}

Fields​

PaymentEndpoint.locators ● [PaymentEndpointLocator!]! non-null object​

PaymentEndpoint.paymentEndpointId ● PaymentEndpointId! non-null scalar​

Member Of​

DepositAccount object

PaymentEndpointLocator​

No description

type PaymentEndpointLocator {
  label: String
  locator: String!
  locatorId: LocatorId!
}

Fields​

PaymentEndpointLocator.label ● String scalar​

PaymentEndpointLocator.locator ● String! non-null scalar​

PaymentEndpointLocator.locatorId ● LocatorId! non-null scalar​

Member Of​

PaymentEndpoint object

PaymentEntry​

No description

type PaymentEntry {
  payment: CreditFacilityPaymentAllocation!
  recordedAt: Timestamp!
}

Fields​

PaymentEntry.payment ● CreditFacilityPaymentAllocation! non-null object​

PaymentEntry.recordedAt ● Timestamp! non-null scalar​

Implemented By​

DepositAccountHistoryEntry union

PendingCreditFacility​

No description

type PendingCreditFacility {
  approvalProcessId: ApprovalProcessId!
  collateralId: CollateralId!
  collateralizationState: PendingCreditFacilityCollateralizationState!
  createdAt: Timestamp!
  creditFacilityId: CreditFacilityId!
  facilityAmount: Money!
  pendingCreditFacilityId: PendingCreditFacilityId!
  status: PendingCreditFacilityStatus!
  wallet: Wallet
}

Fields​

PendingCreditFacility.approvalProcessId ● ApprovalProcessId! non-null scalar​

PendingCreditFacility.collateralId ● CollateralId! non-null scalar​

PendingCreditFacility.collateralizationState ● PendingCreditFacilityCollateralizationState! non-null enum​

PendingCreditFacility.createdAt ● Timestamp! non-null scalar​

PendingCreditFacility.creditFacilityId ● CreditFacilityId! non-null scalar​

PendingCreditFacility.facilityAmount ● Money! non-null object​

PendingCreditFacility.pendingCreditFacilityId ● PendingCreditFacilityId! non-null scalar​

PendingCreditFacility.status ● PendingCreditFacilityStatus! non-null enum​

PendingCreditFacility.wallet ● Wallet object​

Where collateral must be sent to activate this facility.

creditFacility returns nothing until activation, so this is the only way to reach the address in the state where it is actually needed.

Member Of​

Customer object

PendingCreditFacilityCollateralizationUpdated​

No description

type PendingCreditFacilityCollateralizationUpdated {
  collateral: Money!
  effective: AccountingDate!
  exchangeRate: Money!
  recordedAt: Timestamp!
  state: PendingCreditFacilityCollateralizationState!
}

Fields​

PendingCreditFacilityCollateralizationUpdated.collateral ● Money! non-null object​

PendingCreditFacilityCollateralizationUpdated.effective ● AccountingDate! non-null scalar​

PendingCreditFacilityCollateralizationUpdated.exchangeRate ● Money! non-null object​

PendingCreditFacilityCollateralizationUpdated.recordedAt ● Timestamp! non-null scalar​

PendingCreditFacilityCollateralizationUpdated.state ● PendingCreditFacilityCollateralizationState! non-null enum​

Implemented By​

CreditFacilityHistoryEntry union

PersonalInfo​

No description

type PersonalInfo {
  address: PostalAddress
  dateOfBirth: Date
  name: FullName!
  nationality: CountryCode
}

Fields​

PersonalInfo.address ● PostalAddress object​

PersonalInfo.dateOfBirth ● Date scalar​

PersonalInfo.name ● FullName! non-null object​

PersonalInfo.nationality ● CountryCode scalar​

Member Of​

IndividualParty object

PostalAddress​

No description

type PostalAddress {
  city: String!
  country: CountryCode!
  line1: String!
  line2: String
  state: String
  zipCode: String
}

Fields​

PostalAddress.city ● String! non-null scalar​

PostalAddress.country ● CountryCode! non-null scalar​

PostalAddress.line1 ● String! non-null scalar​

PostalAddress.line2 ● String scalar​

PostalAddress.state ● String scalar​

PostalAddress.zipCode ● String scalar​

Member Of​

PersonalInfo object

TermValues​

No description

type TermValues {
  accrualCycleInterval: InterestInterval!
  annualRate: AnnualRatePct!
  duration: Duration!
  initialLtvLimit: LtvPct!
  liquidationLtvLimit: LtvPct!
  marginCallLtvLimit: LtvPct!
  oneTimeFeeRate: OneTimeFeeRatePct!
}

Fields​

TermValues.accrualCycleInterval ● InterestInterval! non-null enum​

TermValues.annualRate ● AnnualRatePct! non-null scalar​

TermValues.duration ● Duration! non-null object​

TermValues.initialLtvLimit ● LtvPct! non-null union​

TermValues.liquidationLtvLimit ● LtvPct! non-null union​

TermValues.marginCallLtvLimit ● LtvPct! non-null union​

TermValues.oneTimeFeeRate ● OneTimeFeeRatePct! non-null scalar​

Member Of​

CreditFacility object ● CreditFacilityProposal object

UnfreezeEntry​

No description

type UnfreezeEntry {
  amount: Money!
  ledgerTransactionId: LedgerTransactionId!
  recordedAt: Timestamp!
}

Fields​

UnfreezeEntry.amount ● Money! non-null object​

UnfreezeEntry.ledgerTransactionId ● LedgerTransactionId! non-null scalar​

UnfreezeEntry.recordedAt ● Timestamp! non-null scalar​

Implemented By​

DepositAccountHistoryEntry union

Wallet​

No description

type Wallet {
  address: String
  custodian: Custodian!
  network: WalletNetwork
  status: WalletStatus!
  walletId: WalletId!
}

Fields​

Wallet.address ● String scalar​

null while the wallet is Provisioning — see status.

Wallet.custodian ● Custodian! non-null object​

Wallet.network ● WalletNetwork enum​

Wallet.status ● WalletStatus! non-null enum​

Wallet.walletId ● WalletId! non-null scalar​

Member Of​

CreditFacility object ● PendingCreditFacility object

Withdrawal​

No description

type Withdrawal {
  accountId: DepositAccountId!
  amount: Money!
  createdAt: Timestamp!
  publicId: PublicId!
  reference: String!
  status: WithdrawalStatus!
  withdrawalId: WithdrawalId!
}

Fields​

Withdrawal.accountId ● DepositAccountId! non-null scalar​

Withdrawal.amount ● Money! non-null object​

Withdrawal.createdAt ● Timestamp! non-null scalar​

Withdrawal.publicId ● PublicId! non-null scalar​

Withdrawal.reference ● String! non-null scalar​

Withdrawal.status ● WithdrawalStatus! non-null enum​

Withdrawal.withdrawalId ● WithdrawalId! non-null scalar​

Member Of​

CancelledWithdrawalEntry object ● DepositAccount object ● WithdrawalEntry object

WithdrawalEntry​

No description

type WithdrawalEntry {
  recordedAt: Timestamp!
  withdrawal: Withdrawal!
}

Fields​

WithdrawalEntry.recordedAt ● Timestamp! non-null scalar​

WithdrawalEntry.withdrawal ● Withdrawal! non-null object​

Implemented By​

DepositAccountHistoryEntry union

Enums​

CollateralizationState​

No description

enum CollateralizationState {
  FULLY_COLLATERALIZED
  NO_COLLATERAL
  NO_EXPOSURE
  UNDER_LIQUIDATION_THRESHOLD
  UNDER_MARGIN_CALL_THRESHOLD
}

Values​

CollateralizationState.FULLY_COLLATERALIZED​

CollateralizationState.NO_COLLATERAL​

CollateralizationState.NO_EXPOSURE​

CollateralizationState.UNDER_LIQUIDATION_THRESHOLD​

CollateralizationState.UNDER_MARGIN_CALL_THRESHOLD​

Member Of​

CreditFacility object ● CreditFacilityCollateralizationUpdated object

CreditFacilityProposalStatus​

No description

enum CreditFacilityProposalStatus {
  APPROVED
  CUSTOMER_DENIED
  DENIED
  PENDING_APPROVAL
  PENDING_CUSTOMER_APPROVAL
}

Values​

CreditFacilityProposalStatus.APPROVED​

CreditFacilityProposalStatus.CUSTOMER_DENIED​

CreditFacilityProposalStatus.DENIED​

CreditFacilityProposalStatus.PENDING_APPROVAL​

CreditFacilityProposalStatus.PENDING_CUSTOMER_APPROVAL​

Member Of​

CreditFacilityProposal object

CreditFacilityRepaymentStatus​

No description

enum CreditFacilityRepaymentStatus {
  DEFAULTED
  DUE
  NOT_YET_DUE
  OVERDUE
  PAID
  UPCOMING
}

Values​

CreditFacilityRepaymentStatus.DEFAULTED​

CreditFacilityRepaymentStatus.DUE​

CreditFacilityRepaymentStatus.NOT_YET_DUE​

CreditFacilityRepaymentStatus.OVERDUE​

CreditFacilityRepaymentStatus.UPCOMING​

Member Of​

CreditFacilityRepaymentPlanEntry object

CreditFacilityRepaymentType​

No description

enum CreditFacilityRepaymentType {
  DISBURSAL
  INTEREST
}

Values​

CreditFacilityRepaymentType.DISBURSAL​

CreditFacilityRepaymentType.INTEREST​

Member Of​

CreditFacilityRepaymentPlanEntry object

CreditFacilityStatus​

No description

enum CreditFacilityStatus {
  ACTIVE
  CLOSED
  MATURED
}

Values​

CreditFacilityStatus.ACTIVE​

CreditFacilityStatus.CLOSED​

CreditFacilityStatus.MATURED​

Member Of​

CreditFacility object

CustomerStatus​

No description

enum CustomerStatus {
  ACTIVE
  CLOSED
  FROZEN
}

Values​

CustomerStatus.ACTIVE​

CustomerStatus.CLOSED​

CustomerStatus.FROZEN​

Member Of​

Customer object

CustomerType​

No description

enum CustomerType {
  BANK
  FINANCIAL_INSTITUTION
  FOREIGN_AGENCY_OR_SUBSIDIARY
  GOVERNMENT_ENTITY
  INDIVIDUAL
  NON_DOMICILED_COMPANY
  PRIVATE_COMPANY
}

Values​

CustomerType.BANK​

CustomerType.FINANCIAL_INSTITUTION​

CustomerType.FOREIGN_AGENCY_OR_SUBSIDIARY​

CustomerType.GOVERNMENT_ENTITY​

CustomerType.INDIVIDUAL​

CustomerType.NON_DOMICILED_COMPANY​

CustomerType.PRIVATE_COMPANY​

Member Of​

IndividualParty object ● OrganizationParty object

DepositAccountStatus​

No description

enum DepositAccountStatus {
  ACTIVE
  CLOSED
  FROZEN
}

Values​

DepositAccountStatus.ACTIVE​

DepositAccountStatus.CLOSED​

DepositAccountStatus.FROZEN​

Member Of​

DepositAccount object

DepositStatus​

No description

enum DepositStatus {
  CONFIRMED
  REVERTED
}

Values​

DepositStatus.CONFIRMED​

DepositStatus.REVERTED​

Member Of​

Deposit object

DisbursalStatus​

No description

enum DisbursalStatus {
  APPROVED
  DENIED
  NEW
  SETTLED
}

Values​

DisbursalStatus.APPROVED​

DisbursalStatus.DENIED​

DisbursalStatus.NEW​

DisbursalStatus.SETTLED​

Member Of​

CreditFacilityDisbursal object

Freshness​

How recently the rate was observed. A stale rate is still returned so the caller can decide what to do with it, rather than being left with nothing.

enum Freshness {
  FRESH
  STALE
  UNKNOWN
}

Values​

Freshness.FRESH​

Freshness.STALE​

Freshness.UNKNOWN​

Member Of​

ExchangeRate object

InterestInterval​

No description

enum InterestInterval {
  END_OF_DAY
  END_OF_MONTH
}

Values​

InterestInterval.END_OF_DAY​

InterestInterval.END_OF_MONTH​

Member Of​

TermValues object

KycLevel​

No description

enum KycLevel {
  ADVANCED
  BASIC
  NOT_KYCED
}

Values​

KycLevel.ADVANCED​

KycLevel.BASIC​

KycLevel.NOT_KYCED​

Member Of​

Customer object

PendingCreditFacilityCollateralizationState​

No description

enum PendingCreditFacilityCollateralizationState {
  FULLY_COLLATERALIZED
  NOT_YET_COLLATERALIZED
  UNDER_COLLATERALIZED
}

Values​

PendingCreditFacilityCollateralizationState.FULLY_COLLATERALIZED​

PendingCreditFacilityCollateralizationState.NOT_YET_COLLATERALIZED​

PendingCreditFacilityCollateralizationState.UNDER_COLLATERALIZED​

Member Of​

PendingCreditFacility object ● PendingCreditFacilityCollateralizationUpdated object

PendingCreditFacilityStatus​

No description

enum PendingCreditFacilityStatus {
  COMPLETED
  PENDING_COLLATERALIZATION
}

Values​

PendingCreditFacilityStatus.COMPLETED​

PendingCreditFacilityStatus.PENDING_COLLATERALIZATION​

Member Of​

PendingCreditFacility object

Period​

No description

enum Period {
  MONTHS
}

Values​

Period.MONTHS​

Member Of​

Duration object

WalletNetwork​

No description

enum WalletNetwork {
  MAINNET
  SIGNET
  TESTNET3
  TESTNET4
}

Values​

WalletNetwork.MAINNET​

WalletNetwork.SIGNET​

WalletNetwork.TESTNET3​

WalletNetwork.TESTNET4​

Member Of​

Wallet object

WalletStatus​

Whether a wallet's external-provider record has landed yet.

A wallet is born Provisioning (its id is minted and it is already linked from a Collateral row) and moves to Active once the command.custody.initialize-wallet job records the provider's response. See lana-dev/note-custody-async-wallet-init.md for why the external call happens outside any transaction.

enum WalletStatus {
  ACTIVE
  PROVISIONING
}

Values​

WalletStatus.ACTIVE​

WalletStatus.PROVISIONING​

Member Of​

Wallet object

WithdrawalStatus​

No description

enum WithdrawalStatus {
  CANCELLED
  CONFIRMED
  DENIED
  PENDING_APPROVAL
  PENDING_CONFIRMATION
  REVERTED
}

Values​

WithdrawalStatus.CANCELLED​

WithdrawalStatus.CONFIRMED​

WithdrawalStatus.DENIED​

WithdrawalStatus.PENDING_APPROVAL​

WithdrawalStatus.PENDING_CONFIRMATION​

WithdrawalStatus.REVERTED​

Member Of​

Withdrawal object

Input Types​

CreditFacilityProposalCustomerApprovalConcludeInput​

No description

input CreditFacilityProposalCustomerApprovalConcludeInput {
  approved: Boolean!
  creditFacilityProposalId: CreditFacilityProposalId!
}

Fields​

CreditFacilityProposalCustomerApprovalConcludeInput.approved ● Boolean! non-null scalar​

CreditFacilityProposalCustomerApprovalConcludeInput.creditFacilityProposalId ● CreditFacilityProposalId! non-null scalar​

Member Of​

creditFacilityProposalCustomerApprovalConclude mutation

Scalars​

AccountingDate​

A day on the bank's accounting timeline as an ISO 8601 date (e.g. 2026-03-10).

scalar AccountingDate

Member Of​

CreditFacility object ● CreditFacilityApproved object ● CreditFacilityCollateralizationUpdated object ● CreditFacilityCollateralSentOut object ● CreditFacilityCollateralUpdated object ● CreditFacilityDisbursalExecuted object ● CreditFacilityIncrementalPayment object ● CreditFacilityInterestAccrued object ● CreditFacilityRepaymentAmountReceived object ● CreditFacilityRepaymentPlanEntry object ● PendingCreditFacilityCollateralizationUpdated object

AnnualRatePct​

No description

scalar AnnualRatePct

Member Of​

TermValues object

ApprovalProcessId​

No description

scalar ApprovalProcessId

Member Of​

CreditFacilityProposal object ● PendingCreditFacility object

Boolean​

The Boolean scalar type represents true or false.

scalar Boolean

Member Of​

CreditFacilityProposalCustomerApprovalConcludeInput input ● Currency object ● include directive ● InfiniteLtvPct object ● Liquidation object ● PageInfo object ● skip directive

CollateralId​

No description

scalar CollateralId

Member Of​

Liquidation object ● PendingCreditFacility object

CountryCode​

An ISO 3166-1 alpha-3 country code in canonical uppercase form.

scalar CountryCode

Member Of​

OrganizationParty object ● PersonalInfo object ● PostalAddress object

CreditFacilityDisbursalId​

No description

scalar CreditFacilityDisbursalId

Member Of​

CreditFacilityDisbursal object

CreditFacilityId​

No description

scalar CreditFacilityId

Member Of​

creditFacility query ● CreditFacility object ● PendingCreditFacility object

CreditFacilityPaymentAllocationId​

No description

scalar CreditFacilityPaymentAllocationId

Member Of​

CreditFacilityPaymentAllocation object

CreditFacilityProductId​

No description

scalar CreditFacilityProductId

Member Of​

CreditFacilityProduct object

CreditFacilityProposalId​

No description

scalar CreditFacilityProposalId

Member Of​

CreditFacilityProposal object ● CreditFacilityProposalCustomerApprovalConcludeInput input

CurrencyCode​

No description

scalar CurrencyCode

Member Of​

Currency object

CustodianId​

No description

scalar CustodianId

Member Of​

Custodian object

CustomerId​

No description

scalar CustomerId

Member Of​

Customer object ● DepositAccount object

Date​

An ISO 8601 calendar date without time or timezone (e.g., 2024-01-15). The field defines what the date represents.

scalar Date

Member Of​

PersonalInfo object

Decimal​

No description

scalar Decimal

Member Of​

ExchangeRate object

DepositAccountId​

No description

scalar DepositAccountId

Member Of​

Deposit object ● DepositAccount object ● Withdrawal object

DepositId​

No description

scalar DepositId

Member Of​

Deposit object

IndividualPartyId​

No description

scalar IndividualPartyId

Member Of​

IndividualParty object

Int​

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

scalar Int

Member Of​

CreditFacilityInterestAccrued object ● Currency object ● Duration object

LedgerTransactionId​

No description

scalar LedgerTransactionId

Member Of​

CreditFacilityApproved object ● CreditFacilityCollateralSentOut object ● CreditFacilityDisbursalExecuted object ● CreditFacilityInterestAccrued object ● CreditFacilityRepaymentAmountReceived object ● FreezeEntry object ● LiquidationCollateralSent object ● LiquidationProceedsReceived object ● UnfreezeEntry object

LiquidationId​

No description

scalar LiquidationId

Member Of​

CreditFacilityCollateralizationUpdated object ● Liquidation object

LocatorId​

No description

scalar LocatorId

Member Of​

PaymentEndpointLocator object

LtvPctValue​

No description

scalar LtvPctValue

Member Of​

FiniteLtvPct object

MinorUnits​

No description

scalar MinorUnits

Member Of​

Money object

OneTimeFeeRatePct​

No description

scalar OneTimeFeeRatePct

Member Of​

TermValues object

OrganizationPartyId​

No description

scalar OrganizationPartyId

Member Of​

OrganizationParty object

PaymentAllocationId​

No description

scalar PaymentAllocationId

Member Of​

CreditFacilityIncrementalPayment object

PaymentEndpointId​

No description

scalar PaymentEndpointId

Member Of​

PaymentEndpoint object

PendingCreditFacilityId​

No description

scalar PendingCreditFacilityId

Member Of​

PendingCreditFacility object

PublicId​

No description

scalar PublicId

Member Of​

CreditFacility object ● CreditFacilityDisbursal object ● Customer object ● Deposit object ● DepositAccount object ● Withdrawal object

String​

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.

scalar String

Member Of​

CreditFacilityProduct object ● Custodian object ● Deposit object ● DepositAccountHistoryEntryEdge object ● deprecated directive ● FullName object ● IndividualParty object ● Money object ● OrganizationParty object ● PageInfo object ● PaymentEndpointLocator object ● PostalAddress object ● specifiedBy directive ● Wallet object ● Withdrawal object

Timestamp​

An ISO 8601 UTC timestamp (e.g., 2024-01-15T09:30:00Z). Always in UTC.

scalar Timestamp

Member Of​

CancelledWithdrawalEntry object ● CreditFacility object ● CreditFacilityApproved object ● CreditFacilityCollateralizationUpdated object ● CreditFacilityCollateralSentOut object ● CreditFacilityCollateralUpdated object ● CreditFacilityDisbursal object ● CreditFacilityDisbursalExecuted object ● CreditFacilityIncrementalPayment object ● CreditFacilityInterestAccrued object ● CreditFacilityPaymentAllocation object ● CreditFacilityProposal object ● CreditFacilityRepaymentAmountReceived object ● CreditFacilityRepaymentPlanEntry object ● Custodian object ● Customer object ● Deposit object ● DepositAccount object ● DepositEntry object ● DisbursalEntry object ● ExchangeRate object ● FreezeEntry object ● Liquidation object ● PaymentEntry object ● PendingCreditFacility object ● PendingCreditFacilityCollateralizationUpdated object ● UnfreezeEntry object ● Withdrawal object ● WithdrawalEntry object

WalletId​

No description

scalar WalletId

Member Of​

Wallet object

WithdrawalId​

No description

scalar WithdrawalId

Member Of​

Withdrawal object

Unions​

CreditFacilityHistoryEntry​

No description

union CreditFacilityHistoryEntry = CreditFacilityIncrementalPayment | CreditFacilityCollateralUpdated | CreditFacilityApproved | PendingCreditFacilityCollateralizationUpdated | CreditFacilityCollateralizationUpdated | CreditFacilityDisbursalExecuted | CreditFacilityInterestAccrued | CreditFacilityCollateralSentOut | CreditFacilityRepaymentAmountReceived

Possible types​

CreditFacilityHistoryEntry.CreditFacilityIncrementalPayment object​

CreditFacilityHistoryEntry.CreditFacilityCollateralUpdated object​

CreditFacilityHistoryEntry.CreditFacilityApproved object​

CreditFacilityHistoryEntry.PendingCreditFacilityCollateralizationUpdated object​

CreditFacilityHistoryEntry.CreditFacilityCollateralizationUpdated object​

CreditFacilityHistoryEntry.CreditFacilityDisbursalExecuted object​

CreditFacilityHistoryEntry.CreditFacilityInterestAccrued object​

CreditFacilityHistoryEntry.CreditFacilityCollateralSentOut object​

CreditFacilityHistoryEntry.CreditFacilityRepaymentAmountReceived object​

Member Of​

CreditFacility object

DepositAccountHistoryEntry​

No description

union DepositAccountHistoryEntry = DepositEntry | WithdrawalEntry | CancelledWithdrawalEntry | DisbursalEntry | PaymentEntry | FreezeEntry | UnfreezeEntry

Possible types​

DepositAccountHistoryEntry.DepositEntry object​

DepositAccountHistoryEntry.WithdrawalEntry object​

DepositAccountHistoryEntry.CancelledWithdrawalEntry object​

DepositAccountHistoryEntry.DisbursalEntry object​

DepositAccountHistoryEntry.PaymentEntry object​

DepositAccountHistoryEntry.FreezeEntry object​

DepositAccountHistoryEntry.UnfreezeEntry object​

Member Of​

DepositAccountHistoryEntryConnection object ● DepositAccountHistoryEntryEdge object

LtvPct​

No description

union LtvPct = FiniteLtvPct | InfiniteLtvPct

Possible types​

LtvPct.FiniteLtvPct object​

LtvPct.InfiniteLtvPct object​

Member Of​

CreditFacility object ● TermValues object

Party​

No description

union Party = IndividualParty | OrganizationParty

Possible types​

Party.IndividualParty object​

Party.OrganizationParty object​

Member Of​

Customer object

Directives (Types)​

deprecated​

Marks an element of a GraphQL schema as no longer supported.

directive @deprecated(
  reason: String = "No longer supported"
) on 
  | FIELD_DEFINITION
  | ARGUMENT_DEFINITION
  | INPUT_FIELD_DEFINITION
  | ENUM_VALUE
  | DIRECTIVE_DEFINITION

Arguments​

deprecated.reason ● String scalar​

Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted using the Markdown syntax, as specified by CommonMark.

oneOf​

Indicates exactly one field must be supplied and this field must not be null.

directive @oneOf on INPUT_OBJECT

specifiedBy​

Exposes a URL that specifies the behavior of this scalar.

directive @specifiedBy(
  url: String!
) on SCALAR

Arguments​

specifiedBy.url ● String! non-null scalar​

The URL that specifies the behavior of this scalar.