Financial Instruments and External Cash Transactions API

Financial Instruments

Fetch a Financial Instrument
fetchFinancialInstrument
GET /billing/{tenantLocator}/financialInstruments/{locator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Security Group:financial-instruments   Permission:read
FinancialInstrumentResponse
required
locator locator
isDefault boolean

optional
accountLocator locator?
institutionName string?
defaultTransactionMethod Enum? ach | cash | eft | standard | wire
expirationTime datetime?
externalAccountNumber string?
externalIdentifier string?
instrumentType Enum? checking | savings | creditCard | debitCard
nickname string?
Fetch Financial Instruments for a Tenant
listFinancialInstruments
GET /billing/{tenantLocator}/financialInstruments/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Security Group:financial-instruments   Permissions:read,list
FinancialInstrumentListResponse
required
listCompleted boolean
Create a Financial Instrument
createFinancialInstrument
POST /billing/{tenantLocator}/financialInstruments
FinancialInstrumentCreateRequest
optional
accountLocator locator?
institutionName string?
defaultTransactionMethod Enum? ach | cash | eft | standard | wire
expirationTime datetime?
externalAccountNumber string?
externalIdentifier string?
instrumentType Enum? checking | savings | creditCard | debitCard
nickname string?
Set the Default Financial Instrument for a Tenant
setFinancialInstrumentAsDefault
POST /billing/{tenantLocator}/financialInstruments/{locator}/setAsDefault
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    valuequeryboolean?optional
    Security Group:financial-instruments   Permission:write
Update a Financial Instrument
updateFinancialInstrument
PATCH /billing/{tenantLocator}/financialInstruments/{locator}

External Cash Transactions

Fetch an External Cash Transaction
fetchExternalCashTransaction
GET /billing/{tenantLocator}/externalCashTransactions/{locator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Security Group:external-cash-transactions   Permission:read
ExternalCashTransactionResponse
required
locator locator
transactionMethod Enum ach | cash | eft | standard | wire

optional
financialInstrumentLocator locator?
transactionNumber string?