Schema

Attributes

AttributeTypeDefinitionExample
idUUIDID of recordc8d0164d-28df-46c6-a836-1a3da5a470d8
created_dateDateTimeDate wallet was created
currencyISO4217Currency of bank accountUSD
account_numberBankAccountNumberBank account number123456789
routing_codeBankRoutingCodeBank account routing code123456789
swift_bicSwiftBicSWIFT BIC code of bankBOFIIE2D
name_on_bank_accountStringName on bank accountJerry
bank_nameStringName of bankWells Fargo
bank_address1StringAddress line 1 of bank1305 E 6th St.
bank_address2StringAddress line 2 of bankUnit 10
bank_cityStringCity of bank addressAustin
bank_state_province_regionStringState, region, or province of bank addressTexas
bank_postal_codePostalCodePostal code of bank address78702
bank_countryISO3166_12-letter ISO code of the country the bank resides inUS
balanceStringFunds in wallet100.00
available_balanceStringFunds available to use50.00

GraphQL

type Wallet {
  id: UUID
  created_date: DateTime
  organization: Organization
  entity: Entity
  currency: ISO4217
  balance: String
  available_balance: String
}

type EntityWallets {
  entity_id: UUID
  entity_name: String
  wallets: [Wallet]
}

enum FundingInstructionTypes {
  wire
  debit
  transfer_only
  none
}

type FundingInstructions {
  type: FundingInstructionTypes
  message: String
  amount: String
  currency: ISO4217
  bank_name: String
  bank_address1: String
  bank_address2: String
  bank_city: String
  bank_state_province_region: String
  bank_postal_code: PostalCode
  bank_country: ISO3166_1
  account_number: BankAccountNumber
  routing_code: BankRoutingCode
  swift_bic: SwiftBic
  account_holder_name: String
  account_holder_address1: String
  account_holder_address2: String
  account_holder_city: String
  account_holder_state_province_region: String
  account_holder_postal_code: String
  account_holder_country: String
  reference: String
}

type Query {
  wallet(
    wallet_id: UUID!
  ): Wallet 

  entityWallets(
    entity_id: UUID!
  ): [Wallet] 

  organizationEntityWallets(
    listFilter: ListFilter
  ): [EntityWallets] 

  walletFundingInstructions(
    wallet_id: UUID!
  ): FundingInstructions 
}

type Mutation {
  createWallet(
    entity_id: UUID!
    currency: ISO4217!
  ): UUID 

  addBalanceToWallet(
    wallet_id: UUID!
    amount: String!
  ): String
}