Financial Instruments and External Cash Transactions API
Financial Instruments
GET /billing/{tenantLocator}/financialInstruments/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:FinancialInstrumentResponse
Security Group:financial-instruments  Permission:read
FinancialInstrumentResponse
¶requiredlocator locatorisDefault booleanoptionalaccountLocator locator?institutionName string?defaultTransactionMethod Enum? ach | cash | eft | standard | wireexpirationTime datetime?externalAccountNumber string?externalIdentifier string?instrumentType Enum? checking | savings | creditCard | debitCardnickname string?
GET /billing/{tenantLocator}/financialInstruments/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
offset | query | int? | optional |
count | query | int? | optional |
extended | query | boolean? | optional |
Response:FinancialInstrumentListResponse
Security Group:financial-instruments  Permissions:read,list
FinancialInstrumentListResponse
¶requiredlistCompleted booleanitems FinancialInstrumentResponse[]
POST /billing/{tenantLocator}/financialInstruments
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
Request:FinancialInstrumentCreateRequest
Response:FinancialInstrumentResponse
Security Group:financial-instruments  Permission:write
FinancialInstrumentCreateRequest
¶optionalaccountLocator locator?institutionName string?defaultTransactionMethod Enum? ach | cash | eft | standard | wireexpirationTime datetime?externalAccountNumber string?externalIdentifier string?instrumentType Enum? checking | savings | creditCard | debitCardnickname string?
POST /billing/{tenantLocator}/financialInstruments/{locator}/setAsDefault
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
value | query | boolean? | optional |
Response:FinancialInstrumentResponse
Security Group:financial-instruments  Permission:write
PATCH /billing/{tenantLocator}/financialInstruments/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:FinancialInstrumentCreateRequest
Response:FinancialInstrumentResponse
Security Group:financial-instruments  Permission:write
External Cash Transactions
GET /billing/{tenantLocator}/externalCashTransactions/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:ExternalCashTransactionResponse
Security Group:external-cash-transactions  Permission:read
ExternalCashTransactionResponse
¶requiredlocator locatortransactionMethod Enum ach | cash | eft | standard | wireoptionalfinancialInstrumentLocator locator?transactionNumber string?