Disbursements API

Fetch Disbursement

fetchDisbursement

GET /billing/{tenantLocator}/disbursements/{locator}

Request Parameters:

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

Response:DisbursementResponse

Security Group:disbursements Permission:read

Fetch Multiple Disbursements

¶

fetchMultipleDisbursements

GET /billing/{tenantLocator}/disbursements/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional
accountLocator	query	locator?	optional

Response:DisbursementResponse[]

Security Group:disbursements Permissions:read,list

DisbursementResponse

¶

required
locator locator
currency string
disbursementState Enum draft | validated | approved | executed | reversed | rejected | discarded
amount number
type string
data map<string,object>
createdAt datetime
createdBy uuid
sources CreditItem[]

optional
accountLocator locator?
externalCashTransactionLocator locator?
disbursementNumber string?
validationResult ValidationResult?

Create a Disbursement

¶

createDisbursement

POST /billing/{tenantLocator}/disbursements

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:DisbursementCreateRequest

Response:DisbursementResponse

Security Group:disbursements Permission:write

DisbursementCreateRequest

¶

required
amount number
type string
useDefaultFinancialInstrument boolean
data map<string,object>
sources CreditItem[]

optional
accountLocator locator?
financialInstrumentLocator locator?
currency string?
transactionMethod Enum? ach | cash | eft | standard | wire
transactionNumber string?

Update a Disbursement

¶

updateDisbursement

PATCH /billing/{tenantLocator}/disbursements/{locator}

Request Parameters:

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

Request:DisbursementUpdateRequest

Response:DisbursementResponse

Security Group:disbursements Permission:write

DisbursementUpdateRequest

¶

required
addSources CreditItem[]
removeData map<string,object>
removeSources locator[]
setData map<string,object>

optional
accountLocator locator?
financialInstrumentLocator locator?
currency string?
amount number?
transactionMethod Enum? ach | cash | eft | standard | wire
transactionNumber string?
type string?
useDefaultFinancialInstrument boolean?

Update a Disbursement and Replace Extension Data

¶

updateDisbursementReplaceData

Updates the disbursement and replaces all existing data extensions with the data.

PUT /billing/{tenantLocator}/disbursements/{locator}

Request Parameters:

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

Request:DisbursementUpdateReplaceDataRequest

Response:DisbursementResponse

Security Group:disbursements Permission:write

DisbursementUpdateReplaceDataRequest

¶

required
amount number
type string
useDefaultFinancialInstrument boolean
data map<string,object>
sources CreditItem[]

optional
accountLocator locator?
financialInstrumentLocator locator?
currency string?
transactionMethod Enum? ach | cash | eft | standard | wire
transactionNumber string?

Validate a Disbursement

¶

validateDisbursement

PATCH /billing/{tenantLocator}/disbursements/{locator}/validate

Request Parameters:

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

Response:DisbursementResponse

Security Group:disbursements Permission:write

Approve a Disbursement

¶

approveDisbursement

PATCH /billing/{tenantLocator}/disbursements/{locator}/approve

Request Parameters:

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

Response:DisbursementResponse

Security Group:disbursements Permission:write

Execute a Disbursement

¶

executeDisbursement

PATCH /billing/{tenantLocator}/disbursements/{locator}/execute

Request Parameters:

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

Response:DisbursementResponse

Security Group:disbursements Permission:write

Reject a Disbursement

¶

rejectDisbursement

PATCH /billing/{tenantLocator}/disbursements/{locator}/reject

Request Parameters:

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

Response:DisbursementResponse

Security Group:disbursements Permission:write

Reset a Disbursement

¶

resetDisbursement

PATCH /billing/{tenantLocator}/disbursements/{locator}/reset

Request Parameters:

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

Response:DisbursementResponse

Security Group:disbursements Permission:write

Reverse a Disbursement

¶

reverseDisbursement

PATCH /billing/{tenantLocator}/disbursements/{locator}/reverse

Request Parameters:

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

Response:DisbursementResponse

Security Group:disbursements Permission:write

Discard a Disbursement

¶

discardDisbursement

PATCH /billing/{tenantLocator}/disbursements/{locator}/discard

Request Parameters:

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

Response:DisbursementResponse

Security Group:disbursements Permission:write

Disbursements API

See Also