v1
latestOpenAPI 3.1.02026-07-136388308.2 KBAdd a bank transfer to a batch.
This endpoint will add a new bank transfer payment to a batch. There are two ways to process bank transfers - by Payee ID (Mode 1) or by Payee Account Details (Mode 2).
Mode 1: Use the payee IDs of existing approved payees set up against your account. These batches can be approved in the normal manner.
Mode 2: Use the account details of the payee. In the event that these details correspond to an existing approved payee, the batch can be approved as normal. If the account details are new, a batch of New Payees will automatically be created. This batch will need to be approved before the Payment batch can be approved. These payees will then exist as approved payees for future batches. You will need to enable PERM_BUSINESS_POST_BATCH_BANKTRANSFERS to use this endpoint.
Path parameters
The uuid of the batch.
Request body
Example request
{
"icanFrom": 2001,
"payeeId": 15002,
"payeeType": "PAYEE_ID",
"amount": 500,
"myRef": "Payment to John Smith for Consultancy in device.",
"yourRef": "ACME LTD - INV 23434"
}Response
Batch payment added successfully. Note* Please use batchUuid when submitting a batch, not batchItemUuid.
Example response
{
"batchItemUuid": "fba4a76a-ce51-4fc1-b562-98ec01299e4d"
}