Skip to main content
Version: Next

Customer API Reference

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

Queries​

creditFacility​

Fetches a specific credit facility by its unique identifier for the authenticated customer

creditFacility(
  id: UUID!
): CreditFacility

Arguments​

creditFacility.id ● UUID! non-null scalar​

Type​

CreditFacility object​

me​

Returns the current authenticated customer's information including deposit account and credit facilities

me: Me!

Type​

Me object​

realtimePrice​

Returns the current BTC/USD exchange rate

realtimePrice: RealtimePrice!

Type​

RealtimePrice 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

Collateral​

No description

type Collateral {
  btcBalance: Satoshis!
}

Fields​

Collateral.btcBalance ● Satoshis! non-null scalar​

Member Of​

CreditFacilityBalance object

CreditFacility​

No description

type CreditFacility {
  id: ID!
  creditFacilityId: UUID!
  facilityAmount: UsdCents!
  collateralizationState: CollateralizationState!
  status: CreditFacilityStatus!
  activatedAt: Timestamp!
  maturesAt: Timestamp!
  creditFacilityTerms: TermValues!
  balance: CreditFacilityBalance!
  currentCvl: CVLPct!
  history: [CreditFacilityHistoryEntry!]!
  disbursals: [CreditFacilityDisbursal!]!
  repaymentPlan: [CreditFacilityRepaymentPlanEntry!]!
}

Fields​

CreditFacility.id ● ID! non-null scalar​

CreditFacility.creditFacilityId ● UUID! non-null scalar​

CreditFacility.facilityAmount ● UsdCents! non-null scalar​

CreditFacility.collateralizationState ● CollateralizationState! non-null enum​

CreditFacility.status ● CreditFacilityStatus! non-null enum​

CreditFacility.activatedAt ● Timestamp! non-null scalar​

CreditFacility.maturesAt ● Timestamp! non-null scalar​

CreditFacility.creditFacilityTerms ● TermValues! non-null object​

CreditFacility.balance ● CreditFacilityBalance! non-null object​

CreditFacility.currentCvl ● CVLPct! non-null scalar​

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

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

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

Returned By​

creditFacility query

Member Of​

CreditFacilityPaymentAllocation object ● Customer object

CreditFacilityApproved​

No description

type CreditFacilityApproved {
  cents: UsdCents!
  recordedAt: Timestamp!
  effective: Date!
  txId: UUID!
}

Fields​

CreditFacilityApproved.cents ● UsdCents! non-null scalar​

CreditFacilityApproved.recordedAt ● Timestamp! non-null scalar​

CreditFacilityApproved.effective ● Date! non-null scalar​

CreditFacilityApproved.txId ● UUID! non-null scalar​

Implemented By​

CreditFacilityHistoryEntry union

CreditFacilityBalance​

No description

type CreditFacilityBalance {
  facilityRemaining: FacilityRemaining!
  disbursed: Disbursed!
  interest: Interest!
  outstanding: Outstanding!
  dueOutstanding: Outstanding!
  collateral: Collateral!
}

Fields​

CreditFacilityBalance.facilityRemaining ● FacilityRemaining! non-null object​

CreditFacilityBalance.disbursed ● Disbursed! non-null object​

CreditFacilityBalance.interest ● Interest! non-null object​

CreditFacilityBalance.outstanding ● Outstanding! non-null object​

CreditFacilityBalance.dueOutstanding ● Outstanding! non-null object​

CreditFacilityBalance.collateral ● Collateral! non-null object​

Member Of​

CreditFacility object

CreditFacilityCollateralizationUpdated​

No description

type CreditFacilityCollateralizationUpdated {
  state: CollateralizationState!
  collateral: Satoshis!
  outstandingInterest: UsdCents!
  outstandingDisbursal: UsdCents!
  recordedAt: Timestamp!
  effective: Date!
  price: UsdCents!
}

Fields​

CreditFacilityCollateralizationUpdated.state ● CollateralizationState! non-null enum​

CreditFacilityCollateralizationUpdated.collateral ● Satoshis! non-null scalar​

CreditFacilityCollateralizationUpdated.outstandingInterest ● UsdCents! non-null scalar​

CreditFacilityCollateralizationUpdated.outstandingDisbursal ● UsdCents! non-null scalar​

CreditFacilityCollateralizationUpdated.recordedAt ● Timestamp! non-null scalar​

CreditFacilityCollateralizationUpdated.effective ● Date! non-null scalar​

CreditFacilityCollateralizationUpdated.price ● UsdCents! non-null scalar​

Implemented By​

CreditFacilityHistoryEntry union

CreditFacilityCollateralSentOut​

No description

type CreditFacilityCollateralSentOut {
  amount: Satoshis!
  recordedAt: Timestamp!
  effective: Date!
  txId: UUID!
}

Fields​

CreditFacilityCollateralSentOut.amount ● Satoshis! non-null scalar​

CreditFacilityCollateralSentOut.recordedAt ● Timestamp! non-null scalar​

CreditFacilityCollateralSentOut.effective ● Date! non-null scalar​

CreditFacilityCollateralSentOut.txId ● UUID! non-null scalar​

Implemented By​

CreditFacilityHistoryEntry union

CreditFacilityCollateralUpdated​

No description

type CreditFacilityCollateralUpdated {
  satoshis: Satoshis!
  recordedAt: Timestamp!
  effective: Date!
  direction: CollateralDirection!
  txId: UUID!
}

Fields​

CreditFacilityCollateralUpdated.satoshis ● Satoshis! non-null scalar​

CreditFacilityCollateralUpdated.recordedAt ● Timestamp! non-null scalar​

CreditFacilityCollateralUpdated.effective ● Date! non-null scalar​

CreditFacilityCollateralUpdated.direction ● CollateralDirection! non-null enum​

CreditFacilityCollateralUpdated.txId ● UUID! non-null scalar​

Implemented By​

CreditFacilityHistoryEntry union

CreditFacilityDisbursal​

No description

type CreditFacilityDisbursal {
  id: ID!
  creditFacilityDisbursalId: UUID!
  amount: UsdCents!
  status: DisbursalStatus!
  createdAt: Timestamp!
}

Fields​

CreditFacilityDisbursal.id ● ID! non-null scalar​

CreditFacilityDisbursal.creditFacilityDisbursalId ● UUID! non-null scalar​

CreditFacilityDisbursal.amount ● UsdCents! non-null scalar​

CreditFacilityDisbursal.status ● DisbursalStatus! non-null enum​

CreditFacilityDisbursal.createdAt ● Timestamp! non-null scalar​

Member Of​

CreditFacility object ● DisbursalEntry object

CreditFacilityDisbursalExecuted​

No description

type CreditFacilityDisbursalExecuted {
  cents: UsdCents!
  recordedAt: Timestamp!
  effective: Date!
  txId: UUID!
}

Fields​

CreditFacilityDisbursalExecuted.cents ● UsdCents! non-null scalar​

CreditFacilityDisbursalExecuted.recordedAt ● Timestamp! non-null scalar​

CreditFacilityDisbursalExecuted.effective ● Date! non-null scalar​

CreditFacilityDisbursalExecuted.txId ● UUID! non-null scalar​

Implemented By​

CreditFacilityHistoryEntry union

CreditFacilityIncrementalPayment​

No description

type CreditFacilityIncrementalPayment {
  cents: UsdCents!
  recordedAt: Timestamp!
  effective: Date!
  txId: UUID!
}

Fields​

CreditFacilityIncrementalPayment.cents ● UsdCents! non-null scalar​

CreditFacilityIncrementalPayment.recordedAt ● Timestamp! non-null scalar​

CreditFacilityIncrementalPayment.effective ● Date! non-null scalar​

CreditFacilityIncrementalPayment.txId ● UUID! non-null scalar​

Implemented By​

CreditFacilityHistoryEntry union

CreditFacilityInterestAccrued​

No description

type CreditFacilityInterestAccrued {
  cents: UsdCents!
  recordedAt: Timestamp!
  effective: Date!
  txId: UUID!
  days: Int!
}

Fields​

CreditFacilityInterestAccrued.cents ● UsdCents! non-null scalar​

CreditFacilityInterestAccrued.recordedAt ● Timestamp! non-null scalar​

CreditFacilityInterestAccrued.effective ● Date! non-null scalar​

CreditFacilityInterestAccrued.txId ● UUID! non-null scalar​

CreditFacilityInterestAccrued.days ● Int! non-null scalar​

Implemented By​

CreditFacilityHistoryEntry union

CreditFacilityPaymentAllocation​

No description

type CreditFacilityPaymentAllocation {
  id: ID!
  creditFacilityPaymentAllocationId: UUID!
  amount: UsdCents!
  createdAt: Timestamp!
  creditFacility: CreditFacility!
}

Fields​

CreditFacilityPaymentAllocation.id ● ID! non-null scalar​

CreditFacilityPaymentAllocation.creditFacilityPaymentAllocationId ● UUID! non-null scalar​

CreditFacilityPaymentAllocation.amount ● UsdCents! non-null scalar​

CreditFacilityPaymentAllocation.createdAt ● Timestamp! non-null scalar​

CreditFacilityPaymentAllocation.creditFacility ● CreditFacility! non-null object​

Member Of​

PaymentEntry object

CreditFacilityRepaymentAmountReceived​

No description

type CreditFacilityRepaymentAmountReceived {
  cents: UsdCents!
  recordedAt: Timestamp!
  effective: Date!
  txId: UUID!
}

Fields​

CreditFacilityRepaymentAmountReceived.cents ● UsdCents! non-null scalar​

CreditFacilityRepaymentAmountReceived.recordedAt ● Timestamp! non-null scalar​

CreditFacilityRepaymentAmountReceived.effective ● Date! non-null scalar​

CreditFacilityRepaymentAmountReceived.txId ● UUID! non-null scalar​

Implemented By​

CreditFacilityHistoryEntry union

CreditFacilityRepaymentPlanEntry​

No description

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

Fields​

CreditFacilityRepaymentPlanEntry.repaymentType ● CreditFacilityRepaymentType! non-null enum​

CreditFacilityRepaymentPlanEntry.status ● CreditFacilityRepaymentStatus! non-null enum​

CreditFacilityRepaymentPlanEntry.initial ● UsdCents! non-null scalar​

CreditFacilityRepaymentPlanEntry.outstanding ● UsdCents! non-null scalar​

CreditFacilityRepaymentPlanEntry.accrualAt ● Timestamp! non-null scalar​

CreditFacilityRepaymentPlanEntry.dueAt ● Timestamp! non-null scalar​

Member Of​

CreditFacility object

Customer​

No description

type Customer {
  id: ID!
  customerId: UUID!
  kycVerification: KycVerification!
  level: KycLevel!
  createdAt: Timestamp!
  email: String!
  telegramHandle: String!
  customerType: CustomerType!
  personalInfo: PersonalInfo
  depositAccount: DepositAccount!
  creditFacilities: [CreditFacility!]!
}

Fields​

Customer.id ● ID! non-null scalar​

Customer.customerId ● UUID! non-null scalar​

Customer.kycVerification ● KycVerification! non-null enum​

Customer.level ● KycLevel! non-null enum​

Customer.createdAt ● Timestamp! non-null scalar​

Customer.email ● String! non-null scalar​

Customer.telegramHandle ● String! non-null scalar​

Customer.customerType ● CustomerType! non-null enum​

Customer.personalInfo ● PersonalInfo object​

Customer.depositAccount ● DepositAccount! non-null object​

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

Member Of​

Me object

Deposit​

No description

type Deposit {
  id: ID!
  depositId: UUID!
  accountId: UUID!
  amount: UsdCents!
  createdAt: Timestamp!
  reference: String!
  status: DepositStatus!
}

Fields​

Deposit.id ● ID! non-null scalar​

Deposit.depositId ● UUID! non-null scalar​

Deposit.accountId ● UUID! non-null scalar​

Deposit.amount ● UsdCents! non-null scalar​

Deposit.createdAt ● Timestamp! 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 {
  id: ID!
  depositAccountId: UUID!
  customerId: UUID!
  createdAt: Timestamp!
  balance: DepositAccountBalance!
  deposits: [Deposit!]!
  withdrawals: [Withdrawal!]!
  history(
    first: Int!
    after: String
  ): DepositAccountHistoryEntryConnection!
}

Fields​

DepositAccount.id ● ID! non-null scalar​

DepositAccount.depositAccountId ● UUID! non-null scalar​

DepositAccount.customerId ● UUID! non-null scalar​

DepositAccount.createdAt ● Timestamp! non-null scalar​

DepositAccount.balance ● DepositAccountBalance! non-null object​

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

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

DepositAccount.history ● DepositAccountHistoryEntryConnection! non-null object​

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

Member Of​

Customer object

DepositAccountBalance​

No description

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

Fields​

DepositAccountBalance.settled ● UsdCents! non-null scalar​

DepositAccountBalance.pending ● UsdCents! non-null scalar​

Member Of​

DepositAccount object

DepositAccountHistoryEntryConnection​

No description

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

Fields​

DepositAccountHistoryEntryConnection.pageInfo ● PageInfo! non-null object​

Information to aid in pagination.

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

A list of edges.

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

A list of nodes.

Member Of​

DepositAccount object

DepositAccountHistoryEntryEdge​

An edge in a connection.

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

Fields​

DepositAccountHistoryEntryEdge.node ● DepositAccountHistoryEntry! non-null union​

The item at the end of the edge

DepositAccountHistoryEntryEdge.cursor ● String! non-null scalar​

A cursor for use in pagination

Member Of​

DepositAccountHistoryEntryConnection object

DepositEntry​

No description

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

Fields​

DepositEntry.recordedAt ● Timestamp! non-null scalar​

DepositEntry.deposit ● Deposit! non-null object​

Implemented By​

DepositAccountHistoryEntry union

DisbursalEntry​

No description

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

Fields​

DisbursalEntry.recordedAt ● Timestamp! non-null scalar​

DisbursalEntry.disbursal ● CreditFacilityDisbursal! non-null object​

Implemented By​

DepositAccountHistoryEntry union

Disbursed​

No description

type Disbursed {
  total: Total!
  outstanding: Outstanding!
  dueOutstanding: Outstanding!
}

Fields​

Disbursed.total ● Total! non-null object​

Disbursed.outstanding ● Outstanding! non-null object​

Disbursed.dueOutstanding ● Outstanding! 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

FacilityRemaining​

No description

type FacilityRemaining {
  usdBalance: UsdCents!
}

Fields​

FacilityRemaining.usdBalance ● UsdCents! non-null scalar​

Member Of​

CreditFacilityBalance object

FreezeEntry​

No description

type FreezeEntry {
  txId: UUID!
  recordedAt: Timestamp!
  amount: UsdCents!
}

Fields​

FreezeEntry.txId ● UUID! non-null scalar​

FreezeEntry.recordedAt ● Timestamp! non-null scalar​

FreezeEntry.amount ● UsdCents! non-null scalar​

Implemented By​

DepositAccountHistoryEntry union

Interest​

No description

type Interest {
  total: Total!
  outstanding: Outstanding!
  dueOutstanding: Outstanding!
}

Fields​

Interest.total ● Total! non-null object​

Interest.outstanding ● Outstanding! non-null object​

Interest.dueOutstanding ● Outstanding! non-null object​

Member Of​

CreditFacilityBalance object

Me​

No description

type Me {
  customer: Customer!
}

Fields​

Me.customer ● Customer! non-null object​

Returned By​

me query

Outstanding​

No description

type Outstanding {
  usdBalance: UsdCents!
}

Fields​

Outstanding.usdBalance ● UsdCents! non-null scalar​

Member Of​

CreditFacilityBalance object ● Disbursed object ● Interest object

PageInfo​

Information about pagination in a connection

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

Fields​

PageInfo.hasPreviousPage ● Boolean! non-null scalar​

When paginating backwards, are there more items?

PageInfo.hasNextPage ● Boolean! non-null scalar​

When paginating forwards, are there more items?

PageInfo.startCursor ● String scalar​

When paginating backwards, the cursor to continue.

PageInfo.endCursor ● String scalar​

When paginating forwards, the cursor to continue.

Member Of​

DepositAccountHistoryEntryConnection object

PaymentEntry​

No description

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

Fields​

PaymentEntry.recordedAt ● Timestamp! non-null scalar​

PaymentEntry.payment ● CreditFacilityPaymentAllocation! non-null object​

Implemented By​

DepositAccountHistoryEntry union

PendingCreditFacilityCollateralizationUpdated​

No description

type PendingCreditFacilityCollateralizationUpdated {
  state: PendingCreditFacilityCollateralizationState!
  collateral: Satoshis!
  price: UsdCents!
  recordedAt: Timestamp!
  effective: Date!
}

Fields​

PendingCreditFacilityCollateralizationUpdated.state ● PendingCreditFacilityCollateralizationState! non-null enum​

PendingCreditFacilityCollateralizationUpdated.collateral ● Satoshis! non-null scalar​

PendingCreditFacilityCollateralizationUpdated.price ● UsdCents! non-null scalar​

PendingCreditFacilityCollateralizationUpdated.recordedAt ● Timestamp! non-null scalar​

PendingCreditFacilityCollateralizationUpdated.effective ● Date! non-null scalar​

Implemented By​

CreditFacilityHistoryEntry union

PersonalInfo​

No description

type PersonalInfo {
  firstName: String!
  lastName: String!
  dateOfBirth: String
  nationality: String
  address: String
}

Fields​

PersonalInfo.firstName ● String! non-null scalar​

PersonalInfo.lastName ● String! non-null scalar​

PersonalInfo.dateOfBirth ● String scalar​

PersonalInfo.nationality ● String scalar​

PersonalInfo.address ● String scalar​

Member Of​

Customer object

RealtimePrice​

No description

type RealtimePrice {
  usdCentsPerBtc: UsdCents!
}

Fields​

RealtimePrice.usdCentsPerBtc ● UsdCents! non-null scalar​

Returned By​

realtimePrice query

TermValues​

No description

type TermValues {
  annualRate: AnnualRatePct!
  accrualInterval: InterestInterval!
  accrualCycleInterval: InterestInterval!
  oneTimeFeeRate: OneTimeFeeRatePct!
  duration: Duration!
  liquidationCvl: CVLPct!
  marginCallCvl: CVLPct!
  initialCvl: CVLPct!
}

Fields​

TermValues.annualRate ● AnnualRatePct! non-null scalar​

TermValues.accrualInterval ● InterestInterval! non-null enum​

TermValues.accrualCycleInterval ● InterestInterval! non-null enum​

TermValues.oneTimeFeeRate ● OneTimeFeeRatePct! non-null scalar​

TermValues.duration ● Duration! non-null object​

TermValues.liquidationCvl ● CVLPct! non-null scalar​

TermValues.marginCallCvl ● CVLPct! non-null scalar​

TermValues.initialCvl ● CVLPct! non-null scalar​

Member Of​

CreditFacility object

Total​

No description

type Total {
  usdBalance: UsdCents!
}

Fields​

Total.usdBalance ● UsdCents! non-null scalar​

Member Of​

Disbursed object ● Interest object

UnfreezeEntry​

No description

type UnfreezeEntry {
  txId: UUID!
  recordedAt: Timestamp!
  amount: UsdCents!
}

Fields​

UnfreezeEntry.txId ● UUID! non-null scalar​

UnfreezeEntry.recordedAt ● Timestamp! non-null scalar​

UnfreezeEntry.amount ● UsdCents! non-null scalar​

Implemented By​

DepositAccountHistoryEntry union

UnknownEntry​

No description

type UnknownEntry {
  txId: UUID!
  recordedAt: Timestamp!
}

Fields​

UnknownEntry.txId ● UUID! non-null scalar​

UnknownEntry.recordedAt ● Timestamp! non-null scalar​

Implemented By​

DepositAccountHistoryEntry union

Withdrawal​

No description

type Withdrawal {
  id: ID!
  withdrawalId: UUID!
  accountId: UUID!
  amount: UsdCents!
  status: WithdrawalStatus!
  createdAt: Timestamp!
  reference: String!
}

Fields​

Withdrawal.id ● ID! non-null scalar​

Withdrawal.withdrawalId ● UUID! non-null scalar​

Withdrawal.accountId ● UUID! non-null scalar​

Withdrawal.amount ● UsdCents! non-null scalar​

Withdrawal.status ● WithdrawalStatus! non-null enum​

Withdrawal.createdAt ● Timestamp! non-null scalar​

Withdrawal.reference ● String! 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​

CollateralDirection​

No description

enum CollateralDirection {
  ADD
  REMOVE
}

Values​

CollateralDirection.ADD​

CollateralDirection.REMOVE​

Member Of​

CreditFacilityCollateralUpdated object

CollateralizationState​

No description

enum CollateralizationState {
  FULLY_COLLATERALIZED
  UNDER_MARGIN_CALL_THRESHOLD
  UNDER_LIQUIDATION_THRESHOLD
  NO_COLLATERAL
  NO_EXPOSURE
}

Values​

CollateralizationState.FULLY_COLLATERALIZED​

CollateralizationState.UNDER_MARGIN_CALL_THRESHOLD​

CollateralizationState.UNDER_LIQUIDATION_THRESHOLD​

CollateralizationState.NO_COLLATERAL​

CollateralizationState.NO_EXPOSURE​

Member Of​

CreditFacility object ● CreditFacilityCollateralizationUpdated object

CreditFacilityRepaymentStatus​

No description

enum CreditFacilityRepaymentStatus {
  UPCOMING
  NOT_YET_DUE
  DUE
  OVERDUE
  DEFAULTED
  PAID
}

Values​

CreditFacilityRepaymentStatus.UPCOMING​

CreditFacilityRepaymentStatus.NOT_YET_DUE​

CreditFacilityRepaymentStatus.DUE​

CreditFacilityRepaymentStatus.OVERDUE​

CreditFacilityRepaymentStatus.DEFAULTED​

CreditFacilityRepaymentStatus.PAID​

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
  MATURED
  CLOSED
}

Values​

CreditFacilityStatus.ACTIVE​

CreditFacilityStatus.MATURED​

CreditFacilityStatus.CLOSED​

Member Of​

CreditFacility object

CustomerType​

No description

enum CustomerType {
  INDIVIDUAL
  GOVERNMENT_ENTITY
  PRIVATE_COMPANY
  BANK
  FINANCIAL_INSTITUTION
  FOREIGN_AGENCY_OR_SUBSIDIARY
  NON_DOMICILED_COMPANY
}

Values​

CustomerType.INDIVIDUAL​

CustomerType.GOVERNMENT_ENTITY​

CustomerType.PRIVATE_COMPANY​

CustomerType.BANK​

CustomerType.FINANCIAL_INSTITUTION​

CustomerType.FOREIGN_AGENCY_OR_SUBSIDIARY​

CustomerType.NON_DOMICILED_COMPANY​

Member Of​

Customer object

DepositStatus​

No description

enum DepositStatus {
  CONFIRMED
  REVERTED
}

Values​

DepositStatus.CONFIRMED​

DepositStatus.REVERTED​

Member Of​

Deposit object

DisbursalStatus​

No description

enum DisbursalStatus {
  NEW
  APPROVED
  DENIED
  CONFIRMED
}

Values​

DisbursalStatus.NEW​

DisbursalStatus.APPROVED​

DisbursalStatus.DENIED​

DisbursalStatus.CONFIRMED​

Member Of​

CreditFacilityDisbursal object

InterestInterval​

No description

enum InterestInterval {
  END_OF_MONTH
  END_OF_DAY
}

Values​

InterestInterval.END_OF_MONTH​

InterestInterval.END_OF_DAY​

Member Of​

TermValues object

KycLevel​

No description

enum KycLevel {
  NOT_KYCED
  BASIC
  ADVANCED
}

Values​

KycLevel.NOT_KYCED​

KycLevel.BASIC​

KycLevel.ADVANCED​

Member Of​

Customer object

KycVerification​

No description

enum KycVerification {
  NO_KYC
  VERIFIED
  REJECTED
}

Values​

KycVerification.NO_KYC​

KycVerification.VERIFIED​

KycVerification.REJECTED​

Member Of​

Customer object

PendingCreditFacilityCollateralizationState​

No description

enum PendingCreditFacilityCollateralizationState {
  FULLY_COLLATERALIZED
  UNDER_COLLATERALIZED
  NOT_YET_COLLATERALIZED
}

Values​

PendingCreditFacilityCollateralizationState.FULLY_COLLATERALIZED​

PendingCreditFacilityCollateralizationState.UNDER_COLLATERALIZED​

PendingCreditFacilityCollateralizationState.NOT_YET_COLLATERALIZED​

Member Of​

PendingCreditFacilityCollateralizationUpdated object

Period​

No description

enum Period {
  MONTHS
}

Values​

Period.MONTHS​

Member Of​

Duration object

WithdrawalStatus​

No description

enum WithdrawalStatus {
  PENDING_APPROVAL
  PENDING_CONFIRMATION
  CONFIRMED
  DENIED
  CANCELLED
  REVERTED
}

Values​

WithdrawalStatus.PENDING_APPROVAL​

WithdrawalStatus.PENDING_CONFIRMATION​

WithdrawalStatus.CONFIRMED​

WithdrawalStatus.DENIED​

WithdrawalStatus.CANCELLED​

WithdrawalStatus.REVERTED​

Member Of​

Withdrawal object

Scalars​

AnnualRatePct​

No description

scalar AnnualRatePct

Member Of​

TermValues object

Boolean​

The Boolean scalar type represents true or false.

scalar Boolean

Member Of​

include directive ● PageInfo object ● skip directive

CVLPct​

No description

scalar CVLPct

Member Of​

CreditFacility object ● TermValues object

Date​

An ISO 8601 calendar date without time or timezone (e.g., 2024-01-15). Represents a business date; timezone-naive by design.

scalar Date

Member Of​

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

ID​

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.

scalar ID

Member Of​

CreditFacility object ● CreditFacilityDisbursal object ● CreditFacilityPaymentAllocation object ● Customer object ● Deposit object ● DepositAccount object ● Withdrawal 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 ● Duration object

OneTimeFeeRatePct​

No description

scalar OneTimeFeeRatePct

Member Of​

TermValues object

Satoshis​

No description

scalar Satoshis

Member Of​

Collateral object ● CreditFacilityCollateralizationUpdated object ● CreditFacilityCollateralSentOut object ● CreditFacilityCollateralUpdated object ● PendingCreditFacilityCollateralizationUpdated 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​

Customer object ● Deposit object ● DepositAccountHistoryEntryEdge object ● deprecated directive ● PageInfo object ● PersonalInfo object ● specifiedBy directive ● 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 ● CreditFacilityRepaymentAmountReceived object ● CreditFacilityRepaymentPlanEntry object ● Customer object ● Deposit object ● DepositAccount object ● DepositEntry object ● DisbursalEntry object ● FreezeEntry object ● PaymentEntry object ● PendingCreditFacilityCollateralizationUpdated object ● UnfreezeEntry object ● UnknownEntry object ● Withdrawal object ● WithdrawalEntry object

UsdCents​

No description

scalar UsdCents

Member Of​

CreditFacility object ● CreditFacilityApproved object ● CreditFacilityCollateralizationUpdated object ● CreditFacilityDisbursal object ● CreditFacilityDisbursalExecuted object ● CreditFacilityIncrementalPayment object ● CreditFacilityInterestAccrued object ● CreditFacilityPaymentAllocation object ● CreditFacilityRepaymentAmountReceived object ● CreditFacilityRepaymentPlanEntry object ● Deposit object ● DepositAccountBalance object ● FacilityRemaining object ● FreezeEntry object ● Outstanding object ● PendingCreditFacilityCollateralizationUpdated object ● RealtimePrice object ● Total object ● UnfreezeEntry object ● Withdrawal object

UUID​

No description

scalar UUID

Member Of​

creditFacility query ● CreditFacility object ● CreditFacilityApproved object ● CreditFacilityCollateralSentOut object ● CreditFacilityCollateralUpdated object ● CreditFacilityDisbursal object ● CreditFacilityDisbursalExecuted object ● CreditFacilityIncrementalPayment object ● CreditFacilityInterestAccrued object ● CreditFacilityPaymentAllocation object ● CreditFacilityRepaymentAmountReceived object ● Customer object ● Deposit object ● DepositAccount object ● FreezeEntry object ● UnfreezeEntry object ● UnknownEntry object ● 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 | UnknownEntry

Possible types​

DepositAccountHistoryEntry.DepositEntry object​

DepositAccountHistoryEntry.WithdrawalEntry object​

DepositAccountHistoryEntry.CancelledWithdrawalEntry object​

DepositAccountHistoryEntry.DisbursalEntry object​

DepositAccountHistoryEntry.PaymentEntry object​

DepositAccountHistoryEntry.FreezeEntry object​

DepositAccountHistoryEntry.UnfreezeEntry object​

DepositAccountHistoryEntry.UnknownEntry object​

Member Of​

DepositAccountHistoryEntryConnection object ● DepositAccountHistoryEntryEdge 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

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.