Financial Instruments and External Cash Transactions API

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

Fetch a Financial InstrumentfetchFinancialInstrument

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:FinancialInstrumentResponse

Security Group:financial-instruments

Permission:

read

FinancialInstrumentResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`isDefault`	`boolean`

Optional properties

Property	Type	Description
`accountLocator`	`ulid?`
`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

Fetch Financial Instruments for a TenantlistFinancialInstruments

GET/billing/{tenantLocator}/financialInstruments/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No
`account`	query	`ulid?`	No

Response:FinancialInstrumentListResponse

Security Group:financial-instruments

Permissions:

read,list

FinancialInstrumentListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`FinancialInstrumentResponse[]`

Create a Financial Instrument

Create a Financial InstrumentcreateFinancialInstrument

POST/billing/{tenantLocator}/financialInstruments

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes

Request:FinancialInstrumentCreateRequest

Response:FinancialInstrumentResponse

Security Group:financial-instruments

Permission:

write

FinancialInstrumentCreateRequest

Properties

Property	Type	Description
`accountLocator`	`ulid?`
`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

Set the Default Financial Instrument for a TenantsetFinancialInstrumentAsDefault

POST/billing/{tenantLocator}/financialInstruments/{locator}/setAsDefault

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`value`	query	`boolean?`	No

Response:FinancialInstrumentResponse

Security Group:financial-instruments

Permission:

write

Update a Financial Instrument

Update a Financial InstrumentupdateFinancialInstrument

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:FinancialInstrumentCreateRequest

Response:FinancialInstrumentResponse

Security Group:financial-instruments

Permission:

write

External Cash Transactions

Fetch an External Cash Transaction

Fetch an External Cash TransactionfetchExternalCashTransaction

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:ExternalCashTransactionResponse

Security Group:external-cash-transactions

Permission:

read

ExternalCashTransactionResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`transactionMethod`	`Enum ach \| cash \| eft \| standard \| wire`

Optional properties

Property	Type	Description
`financialInstrumentLocator`	`ulid?`
`transactionNumber`	`string?`

Financial Instruments and External Cash Transactions API

On this page