Financial Instruments and External Cash Transactions API

Endpoint Index

Action	Endpoint
Fetch a Financial Instrument	GET /billing/{tenantLocator}/financialInstruments/{locator}
Fetch Financial Instruments for a Tenant	GET /billing/{tenantLocator}/financialInstruments/list
Create a Financial Instrument	POST /billing/{tenantLocator}/financialInstruments
Set the Default Financial Instrument for a Tenant	POST /billing/{tenantLocator}/financialInstruments/{locator}/setAsDefault
Update a Financial Instrument	PATCH /billing/{tenantLocator}/financialInstruments/{locator}
Fetch an External Cash Transaction	GET /billing/{tenantLocator}/externalCashTransactions/{locator}

Financial Instruments

Fetch a Financial Instrument

¶

fetchFinancialInstrument

GET /billing/{tenantLocator}/financialInstruments/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:FinancialInstrumentResponse

Security Group:financial-instruments Permission:read

FinancialInstrumentResponse

¶

required
locator string
isDefault boolean

optional
accountLocator string?
institutionName string?
retryPlanName 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:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional
account	query	string?	optional

Response:FinancialInstrumentListResponse

Security Group:financial-instruments Permissions:read,list

FinancialInstrumentListResponse

¶

required
listCompleted boolean
items FinancialInstrumentResponse[]

Create a Financial Instrument

¶

createFinancialInstrument

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

¶

optional
accountLocator string?
institutionName string?
retryPlanName 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:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
value	query	boolean?	optional

Response:FinancialInstrumentResponse

Security Group:financial-instruments Permission:write

Update a Financial Instrument

¶

updateFinancialInstrument

PATCH /billing/{tenantLocator}/financialInstruments/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Request:FinancialInstrumentCreateRequest

Response:FinancialInstrumentResponse

Security Group:financial-instruments Permission:write

External Cash Transactions

Fetch an External Cash Transaction

¶

fetchExternalCashTransaction

GET /billing/{tenantLocator}/externalCashTransactions/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:ExternalCashTransactionResponse

Security Group:external-cash-transactions Permission:read

ExternalCashTransactionResponse

¶

required
locator string
transactionMethod Enum ach | cash | eft | standard | wire

optional
financialInstrumentLocator string?
transactionNumber string?