Batch payments

Creating a new Bulk payment

POST /api/batchpayment

{
	"bankAccountId": "MITGBP",
	"description": "API 3",
	"allocations": [
		{
			"docId": "PIN1",
			"allocAmountCurrency": 100
		},
		{
			"DocId": "PIN2",
			"AllocAmountCurrency": 200
		}
	]
}

This creates a new Bulk Payment for the specified bank account, allocating the specified invoices and amounts for payment.

Reference: POST /api/BatchPayment

Updating Bulk payment reference

Updateable fields of the Bulk payment can be updated by patching:

PATCH /api/batchpayment/(id)

{
	"Description": "API 123",
	"BankRef": "Payment 123"
}

Reference: PATCH /api/BatchPayment/(id)

Abandoning a Bulk payment

Bulk payments can be abandoned if they are in a draft state.

POST /api/batchpayment/{batchPaymentRef}/abandon

Submitting a Bulk payment

Bulk payments can be submitted if they are in a draft state.

POST /api/batchpayment/{batchPaymentRef}/submit

The submission is an asynchronous process, and a response of 200 OK means it has been queued for processing.

As the document goes for validation and authorisation, its status will change.

Amending a Bulk payment

Bulk payments that are in an approved or processed state can be set back to a draft state for amending.

POST /api/batchpayment/{batchPaymentRef}/amend

Processing a Bulk payment

Bulk payments can be processed if they are in an approved state.

POST /api/batchpayment/{batchPaymentRef}/process

Posting a Bulk payment

Bulk payments can be posted if they are in an processed state.

POST /api/batchpayment/{batchPaymentRef}/post

Unposting a Bulk payment

Bulk payments can be unposted if they are in an posted state.

POST /api/batchpayment/{batchPaymentRef}/unpost