Saltar al contenido principal
Version: 0.61.0-rc.33

Referencia de API de Cliente

Esta referencia de API ha sido generada automaticamente a partir del esquema GraphQL de Cliente.

Consultas​

creditFacility​

No description

creditFacility(
  id: CreditFacilityId!
): CreditFacility

Arguments​

creditFacility.id ● CreditFacilityId! non-null scalar​

Type​

CreditFacility object​

me​

No description

me: Me!

Type​

Me object​

realtimeExchangeRate​

No description

realtimeExchangeRate: RealtimeExchangeRate!

Type​

RealtimeExchangeRate object​

Mutaciones​

creditFacilityProposalCustomerApprovalConclude​

No description

creditFacilityProposalCustomerApprovalConclude(
  input: CreditFacilityProposalCustomerApprovalConcludeInput!
): CreditFacilityProposalCustomerApprovalConcludePayload!

Arguments​

creditFacilityProposalCustomerApprovalConclude.input ● CreditFacilityProposalCustomerApprovalConcludeInput! non-null input​

Type​

CreditFacilityProposalCustomerApprovalConcludePayload object​

Directivas (Operaciones)​

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​

Objetos​

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 {
  activatedAt: Timestamp!
  balance: CreditFacilityBalance!
  collateralizationState: CollateralizationState!
  creditFacilityId: CreditFacilityId!
  creditFacilityTerms: TermValues!
  currentLtv: LtvPct!
  disbursals: [CreditFacilityDisbursal!]!
  facilityAmount: Money!
  history: [CreditFacilityHistoryEntry!]!
  maturesAt: Timestamp!
  publicId: PublicId!
  repaymentPlan: [CreditFacilityRepaymentPlanEntry!]!
  status: CreditFacilityStatus!
}

Fields​

CreditFacility.activatedAt ● Timestamp! non-null scalar​

CreditFacility.balance ● CreditFacilityBalance! 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.maturesAt ● Timestamp! non-null scalar​

CreditFacility.publicId ● PublicId! non-null scalar​

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

CreditFacility.status ● CreditFacilityStatus! non-null enum​

Returned By​

creditFacility query

Member Of​

CreditFacilityPaymentAllocation object ● Customer object

CreditFacilityApproved​

No description

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

Fields​

CreditFacilityApproved.amount ● Money! non-null object​

CreditFacilityApproved.effective ● Date! 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: Collateral!
  disbursed: Disbursed!
  dueOutstanding: Outstanding!
  facilityRemaining: FacilityRemaining!
  interest: Interest!
  outstanding: Outstanding!
}

Fields​

CreditFacilityBalance.collateral ● Collateral! non-null object​

CreditFacilityBalance.disbursed ● Disbursed! non-null object​

CreditFacilityBalance.dueOutstanding ● Outstanding! non-null object​

CreditFacilityBalance.facilityRemaining ● FacilityRemaining! non-null object​

CreditFacilityBalance.interest ● Interest! non-null object​

CreditFacilityBalance.outstanding ● Outstanding! non-null object​

Member Of​

CreditFacility object

CreditFacilityCollateralizationUpdated​

No description

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

Fields​

CreditFacilityCollateralizationUpdated.collateral ● Satoshis! non-null scalar​

CreditFacilityCollateralizationUpdated.effective ● Date! non-null scalar​

CreditFacilityCollateralizationUpdated.exchangeRate ● UsdCents! non-null 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: Satoshis!
  effective: Date!
  ledgerTransactionId: LedgerTransactionId!
  recordedAt: Timestamp!
}

Fields​

CreditFacilityCollateralSentOut.amount ● Satoshis! non-null scalar​

CreditFacilityCollateralSentOut.effective ● Date! 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!
  direction: CollateralDirection!
  effective: Date!
  ledgerTransactionId: LedgerTransactionId!
  recordedAt: Timestamp!
}

Fields​

CreditFacilityCollateralUpdated.amount ● Money! non-null object​

CreditFacilityCollateralUpdated.direction ● CollateralDirection! non-null enum​

CreditFacilityCollateralUpdated.effective ● Date! non-null scalar​

CreditFacilityCollateralUpdated.ledgerTransactionId ● LedgerTransactionId! 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: Date!
  ledgerTransactionId: LedgerTransactionId!
  recordedAt: Timestamp!
}

Fields​

CreditFacilityDisbursalExecuted.amount ● Money! non-null object​

CreditFacilityDisbursalExecuted.effective ● Date! non-null scalar​

CreditFacilityDisbursalExecuted.ledgerTransactionId ● LedgerTransactionId! non-null scalar​

CreditFacilityDisbursalExecuted.recordedAt ● Timestamp! non-null scalar​

Implemented By​

CreditFacilityHistoryEntry union

CreditFacilityIncrementalPayment​

No description

type CreditFacilityIncrementalPayment {
  cents: UsdCents!
  effective: Date!
  paymentAllocationId: PaymentAllocationId!
  recordedAt: Timestamp!
}

Fields​

CreditFacilityIncrementalPayment.cents ● UsdCents! non-null scalar​

CreditFacilityIncrementalPayment.effective ● Date! non-null scalar​

CreditFacilityIncrementalPayment.paymentAllocationId ● PaymentAllocationId! non-null scalar​

CreditFacilityIncrementalPayment.recordedAt ● Timestamp! non-null scalar​

Implemented By​

CreditFacilityHistoryEntry union

CreditFacilityInterestAccrued​

No description

type CreditFacilityInterestAccrued {
  cents: UsdCents!
  days: Int!
  effective: Date!
  ledgerTransactionId: LedgerTransactionId!
  recordedAt: Timestamp!
}

Fields​

CreditFacilityInterestAccrued.cents ● UsdCents! non-null scalar​

CreditFacilityInterestAccrued.days ● Int! non-null scalar​

CreditFacilityInterestAccrued.effective ● Date! 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: UsdCents!
  createdAt: Timestamp!
  creditFacility: CreditFacility!
  creditFacilityPaymentAllocationId: CreditFacilityPaymentAllocationId!
}

Fields​

CreditFacilityPaymentAllocation.amount ● UsdCents! non-null scalar​

CreditFacilityPaymentAllocation.createdAt ● Timestamp! non-null scalar​

CreditFacilityPaymentAllocation.creditFacility ● CreditFacility! non-null object​

CreditFacilityPaymentAllocation.creditFacilityPaymentAllocationId ● CreditFacilityPaymentAllocationId! non-null scalar​

Member Of​

PaymentEntry 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 {
  cents: UsdCents!
  effective: Date!
  ledgerTransactionId: LedgerTransactionId!
  recordedAt: Timestamp!
}

Fields​

CreditFacilityRepaymentAmountReceived.cents ● UsdCents! non-null scalar​

CreditFacilityRepaymentAmountReceived.effective ● Date! 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: Date!
  initial: UsdCents!
  outstanding: UsdCents!
  repaymentType: CreditFacilityRepaymentType!
  status: CreditFacilityRepaymentStatus!
}

Fields​

CreditFacilityRepaymentPlanEntry.accrualAt ● Timestamp! non-null scalar​

CreditFacilityRepaymentPlanEntry.dueAt ● Date! non-null scalar​

CreditFacilityRepaymentPlanEntry.initial ● UsdCents! non-null scalar​

CreditFacilityRepaymentPlanEntry.outstanding ● UsdCents! non-null scalar​

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​

DepositAccount object ● Money object

Customer​

No description

type Customer {
  createdAt: Timestamp!
  creditFacilities: [CreditFacility!]!
  creditFacilityProposals: [CreditFacilityProposal!]!
  customerId: CustomerId!
  depositAccount: 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.depositAccount ● DepositAccount 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!
  publicId: PublicId!
  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.publicId ● PublicId! non-null scalar​

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 {
  disbursal: CreditFacilityDisbursal!
  recordedAt: Timestamp!
}

Fields​

DisbursalEntry.disbursal ● CreditFacilityDisbursal! non-null object​

DisbursalEntry.recordedAt ● Timestamp! non-null scalar​

Implemented By​

DepositAccountHistoryEntry union

Disbursed​

No description

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

Fields​

Disbursed.dueOutstanding ● Outstanding! non-null object​

Disbursed.outstanding ● Outstanding! non-null object​

Disbursed.total ● Total! 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

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

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: Outstanding!
  outstanding: Outstanding!
  total: Total!
}

Fields​

Interest.dueOutstanding ● Outstanding! non-null object​

Interest.outstanding ● Outstanding! non-null object​

Interest.total ● Total! 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

Money​

No description

type Money {
  amount: Int!
  currency: Currency!
}

Fields​

Money.amount ● Int! non-null scalar​

Money.currency ● Currency! non-null object​

Member Of​

CreditFacility object ● CreditFacilityApproved object ● CreditFacilityCollateralizationUpdated object ● CreditFacilityCollateralUpdated object ● CreditFacilityDisbursal object ● CreditFacilityDisbursalExecuted object ● CreditFacilityProposal object ● Deposit object ● DepositAccountBalance object ● FreezeEntry object ● PendingCreditFacility object ● UnfreezeEntry object ● Withdrawal object

OrganizationParty​

No description

type OrganizationParty {
  customerType: CustomerType!
  email: String!
  organizationPartyId: OrganizationPartyId!
  personalInfo: PersonalInfo
}

Fields​

OrganizationParty.customerType ● CustomerType! non-null enum​

OrganizationParty.email ● String! non-null scalar​

OrganizationParty.organizationPartyId ● OrganizationPartyId! non-null scalar​

OrganizationParty.personalInfo ● PersonalInfo object​

Implemented By​

Party union

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 {
  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

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!
}

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​

Member Of​

Customer object

PendingCreditFacilityCollateralizationUpdated​

No description

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

Fields​

PendingCreditFacilityCollateralizationUpdated.collateral ● Satoshis! non-null scalar​

PendingCreditFacilityCollateralizationUpdated.effective ● Date! non-null scalar​

PendingCreditFacilityCollateralizationUpdated.exchangeRate ● UsdCents! non-null scalar​

PendingCreditFacilityCollateralizationUpdated.recordedAt ● Timestamp! non-null scalar​

PendingCreditFacilityCollateralizationUpdated.state ● PendingCreditFacilityCollateralizationState! non-null enum​

Implemented By​

CreditFacilityHistoryEntry union

PersonalInfo​

No description

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

Fields​

PersonalInfo.address ● String scalar​

PersonalInfo.companyName ● String scalar​

PersonalInfo.dateOfBirth ● String scalar​

PersonalInfo.firstName ● String! non-null scalar​

PersonalInfo.lastName ● String! non-null scalar​

PersonalInfo.nationality ● String scalar​

Member Of​

IndividualParty object ● OrganizationParty object

RealtimeExchangeRate​

No description

type RealtimeExchangeRate {
  usdCentsPerBtc: UsdCents!
}

Fields​

RealtimeExchangeRate.usdCentsPerBtc ● UsdCents! non-null scalar​

Returned By​

realtimeExchangeRate query

TermValues​

No description

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

Fields​

TermValues.accrualCycleInterval ● InterestInterval! non-null enum​

TermValues.accrualInterval ● 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

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 {
  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

UnknownEntry​

No description

type UnknownEntry {
  ledgerTransactionId: LedgerTransactionId!
  recordedAt: Timestamp!
}

Fields​

UnknownEntry.ledgerTransactionId ● LedgerTransactionId! non-null scalar​

UnknownEntry.recordedAt ● Timestamp! non-null scalar​

Implemented By​

DepositAccountHistoryEntry union

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

Enumeraciones​

CollateralDirection​

No description

enum CollateralDirection {
  ADD
  REMOVE
}

Values​

CollateralDirection.ADD​

CollateralDirection.REMOVE​

Member Of​

CreditFacilityCollateralUpdated object

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

DepositStatus​

No description

enum DepositStatus {
  CONFIRMED
  REVERTED
}

Values​

DepositStatus.CONFIRMED​

DepositStatus.REVERTED​

Member Of​

Deposit object

DisbursalStatus​

No description

enum DisbursalStatus {
  APPROVED
  CONFIRMED
  DENIED
  NEW
}

Values​

DisbursalStatus.APPROVED​

DisbursalStatus.CONFIRMED​

DisbursalStatus.DENIED​

DisbursalStatus.NEW​

Member Of​

CreditFacilityDisbursal 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

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

Tipos de Entrada​

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

Escalares​

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 ● PageInfo object ● skip directive

CollateralId​

No description

scalar CollateralId

Member Of​

PendingCreditFacility 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

CreditFacilityProposalId​

No description

scalar CreditFacilityProposalId

Member Of​

CreditFacilityProposal object ● CreditFacilityProposalCustomerApprovalConcludeInput input

CurrencyCode​

No description

scalar CurrencyCode

Member Of​

Currency 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). 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 ● CreditFacilityRepaymentPlanEntry object ● PendingCreditFacilityCollateralizationUpdated 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 ● Money object

LedgerTransactionId​

No description

scalar LedgerTransactionId

Member Of​

CreditFacilityApproved object ● CreditFacilityCollateralSentOut object ● CreditFacilityCollateralUpdated object ● CreditFacilityDisbursalExecuted object ● CreditFacilityInterestAccrued object ● CreditFacilityRepaymentAmountReceived object ● FreezeEntry object ● UnfreezeEntry object ● UnknownEntry object

LtvPctValue​

No description

scalar LtvPctValue

Member Of​

FiniteLtvPct 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

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

Satoshis​

No description

scalar Satoshis

Member Of​

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

Deposit object ● DepositAccountHistoryEntryEdge object ● deprecated directive ● IndividualParty object ● OrganizationParty object ● 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 ● CreditFacilityProposal object ● CreditFacilityRepaymentAmountReceived object ● CreditFacilityRepaymentPlanEntry object ● Customer object ● Deposit object ● DepositAccount object ● DepositEntry object ● DisbursalEntry object ● FreezeEntry object ● PaymentEntry object ● PendingCreditFacility object ● PendingCreditFacilityCollateralizationUpdated object ● UnfreezeEntry object ● UnknownEntry object ● Withdrawal object ● WithdrawalEntry object

UsdCents​

No description

scalar UsdCents

Member Of​

CreditFacilityCollateralizationUpdated object ● CreditFacilityIncrementalPayment object ● CreditFacilityInterestAccrued object ● CreditFacilityPaymentAllocation object ● CreditFacilityRepaymentAmountReceived object ● CreditFacilityRepaymentPlanEntry object ● FacilityRemaining object ● Outstanding object ● PendingCreditFacilityCollateralizationUpdated object ● RealtimeExchangeRate object ● Total object

WithdrawalId​

No description

scalar WithdrawalId

Member Of​

Withdrawal object

Uniones​

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

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

Directivas (Tipos)​

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.