Disbursements API

Action	Endpoint
Fetch Disbursement	GET/billing/{tenantLocator}/disbursements/{locator}
Fetch Multiple Disbursements	GET/billing/{tenantLocator}/disbursements/list
Create a Disbursement	POST/billing/{tenantLocator}/disbursements
Update a Disbursement	PATCH/billing/{tenantLocator}/disbursements/{locator}
Update a Disbursement and Replace Extension Data	PUT/billing/{tenantLocator}/disbursements/{locator}
Validate a Disbursement	PATCH/billing/{tenantLocator}/disbursements/{locator}/validate
Approve a Disbursement	PATCH/billing/{tenantLocator}/disbursements/{locator}/approve
Execute a Disbursement	PATCH/billing/{tenantLocator}/disbursements/{locator}/execute
Reject a Disbursement	PATCH/billing/{tenantLocator}/disbursements/{locator}/reject
Reset a Disbursement	PATCH/billing/{tenantLocator}/disbursements/{locator}/reset
Reverse a Disbursement	PATCH/billing/{tenantLocator}/disbursements/{locator}/reverse
Discard a Disbursement	PATCH/billing/{tenantLocator}/disbursements/{locator}/discard
Fetch Disbursements With Number	GET/billing/{tenantLocator}/disbursements/numbers/{disbursementNumber}
Set Disbursement Number	POST/billing/{tenantLocator}/disbursements/{locator}/number/set
Generate Disbursement Number	POST/billing/{tenantLocator}/disbursements/{locator}/number/generate

Fetch

Fetch Disbursement

Fetch DisbursementfetchDisbursement

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

Parameters

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

Response:DisbursementResponse

Security Group:disbursements

Permission:

read

Fetch Multiple Disbursements

Fetch Multiple DisbursementsfetchMultipleDisbursements

GET/billing/{tenantLocator}/disbursements/list

Parameters

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

Response:DisbursementListResponse

Security Group:disbursements

Permissions:

read,list

DisbursementListResponse

Required properties

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

DisbursementResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`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 properties

Property	Type	Description
`accountLocator`	`ulid?`
`externalCashTransactionLocator`	`ulid?`
`anonymizedAt`	`datetime?`
`disbursementNumber`	`string?`
`validationResult`	`ValidationResult?`

Lifecycle

Create a Disbursement

Create a DisbursementcreateDisbursement

POST/billing/{tenantLocator}/disbursements

Parameters

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

Request:DisbursementCreateRequest

Response:DisbursementResponse

Security Group:disbursements

Permission:

write

DisbursementCreateRequest

Required properties

Property	Type	Description
`amount`	`number`
`type`	`string`
`useDefaultFinancialInstrument`	`boolean`
`data`	`map<string, object>`
`sources`	`CreditItem[]`

Optional properties

Property	Type	Description
`accountLocator`	`ulid?`
`financialInstrumentLocator`	`ulid?`
`currency`	`string?`
`transactionMethod`	`Enum? ach \| cash \| eft \| standard \| wire`
`transactionNumber`	`string?`

Update a Disbursement

Update a DisbursementupdateDisbursement

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

Parameters

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

Request:DisbursementUpdateRequest

Response:DisbursementResponse

Security Group:disbursements

Permission:

write

DisbursementUpdateRequest

Required properties

Property	Type	Description
`addSources`	`CreditItem[]`
`removeData`	`map<string, object>`
`removeSources`	`ulid[]`
`setData`	`map<string, object>`

Optional properties

Property	Type	Description
`accountLocator`	`ulid?`
`financialInstrumentLocator`	`ulid?`
`currency`	`string?`
`amount`	`number?`
`transactionMethod`	`Enum? ach \| cash \| eft \| standard \| wire`
`transactionNumber`	`string?`
`type`	`string?`
`useDefaultFinancialInstrument`	`boolean?`

Update a Disbursement and Replace Extension Data

Update a Disbursement and Replace Extension DataupdateDisbursementReplaceData

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

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

Parameters

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

Request:DisbursementUpdateReplaceDataRequest

Response:DisbursementResponse

Security Group:disbursements

Permission:

write

DisbursementUpdateReplaceDataRequest

Required properties

Property	Type	Description
`amount`	`number`
`type`	`string`
`useDefaultFinancialInstrument`	`boolean`
`data`	`map<string, object>`
`sources`	`CreditItem[]`

Optional properties

Property	Type	Description
`accountLocator`	`ulid?`
`financialInstrumentLocator`	`ulid?`
`currency`	`string?`
`transactionMethod`	`Enum? ach \| cash \| eft \| standard \| wire`
`transactionNumber`	`string?`

Validate a Disbursement

Validate a DisbursementvalidateDisbursement

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

Parameters

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

Response:DisbursementResponse

Security Group:disbursements

Permission:

write

Approve a Disbursement

Approve a DisbursementapproveDisbursement

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

Parameters

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

Response:DisbursementResponse

Security Group:disbursements

Permission:

write

Execute a Disbursement

Execute a DisbursementexecuteDisbursement

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

Parameters

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

Response:DisbursementResponse

Security Group:disbursements

Permission:

write

Reject a Disbursement

Reject a DisbursementrejectDisbursement

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

Parameters

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

Response:DisbursementResponse

Security Group:disbursements

Permission:

write

Reset a Disbursement

Reset a DisbursementresetDisbursement

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

Parameters

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

Response:DisbursementResponse

Security Group:disbursements

Permission:

write

Reverse a Disbursement

Reverse a DisbursementreverseDisbursement

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

Parameters

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

Response:DisbursementResponse

Security Group:disbursements

Permission:

write

Discard a Disbursement

Discard a DisbursementdiscardDisbursement

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

Parameters

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

Response:DisbursementResponse

Security Group:disbursements

Permission:

write

Numbering

Fetch Disbursements With Number

Fetch Disbursements With NumberfetchDisbursementsWithNumber

GET/billing/{tenantLocator}/disbursements/numbers/{disbursementNumber}

Parameters

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

Response:DisbursementResponse[]

Security Group:disbursements

Permissions:

read,list

Set Disbursement Number

Set Disbursement NumbersetDisbursementNumber

POST/billing/{tenantLocator}/disbursements/{locator}/number/set

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`disbursementNumber`	query	`string`	Yes

Response:DisbursementResponse

Security Group:disbursements

Permission:

write

Generate Disbursement Number

Generate Disbursement NumbergenerateDisbursementNumber

POST/billing/{tenantLocator}/disbursements/{locator}/number/generate

Parameters

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

Response:DisbursementResponse

Security Group:disbursements

Permission:

write

Disbursements API

Fetch

Fetch Disbursement

Fetch Multiple Disbursements

Lifecycle

Create a Disbursement

Update a Disbursement

Update a Disbursement and Replace Extension Data

Validate a Disbursement

Approve a Disbursement

Execute a Disbursement

Reject a Disbursement

Reset a Disbursement

Reverse a Disbursement

Discard a Disbursement

Numbering

Fetch Disbursements With Number

Set Disbursement Number

Generate Disbursement Number

See Also

On this page