v1

latestOpenAPI 3.1.02026-07-136388308.2 KB

Batch Payments

Add an internal transfer to a Batch

This endpoint will add an internal transfer payment to an existing batch. Simply specify the source account, destination account, amount and a reference. You will need to enable PERM_BUSINESS_POST_BATCH_INTERNALTRANSFERS to use this endpoint.

post/v1/batches/{batchUuid}/internaltransfers

Path parameters

batchUuidstring required

The uuid of the batch.

Example:4ADFB67A-0F5B-4A9A-9D74-34437250045C

Request body

icanFrominteger

The account ID for the fire.com account the funds are taken from

icanTointeger

The account ID for the fire.com account the funds are directed to

amountinteger

The amount of funds to be transferred. Note the last two digits represent pennies/cents, (e.g., £1.00 = 100).

refstring

The reference on the transaction

Example request

{
  "icanFrom": 2001,
  "icanTo": 3221,
  "amount": 10000,
  "ref": "Moving funds to Operating Account"
}

Response

Batch payment added successfully. Note* Please use batchUuid when submitting a batch, not batchItemUuid.

batchItemUuidstring

A Batch Item UUID for this item. Note* Do not confuse this for BatchUuid when submitting a batch.

Example response

{
  "batchItemUuid": "fba4a76a-ce51-4fc1-b562-98ec01299e4d"
}