Sign in

v1

latestOpenAPI 3.1.02026-07-136388308.2 KB
Batch Payments

Add an international transfer to a Batch

This endpoint allows you to add an international transfer to a batch. International transfers must be added to a batch using the Payee ID (Mode 1). Payees must be set up using the web application.

Mode 1: Use the payee IDs of existing approved payees set up against your account. These batches can be approved in the normal manner.

post/v2/batches/{batchUuid}/internationaltransfers

Path parameters

batchUuidstring required

The uuid of the batch.

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

Request body

icanFrominteger

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

payeeIdinteger

The ID of the existing payee

amountinteger

The value of the payment in the beneficiary currency. Note the last two digits represent pennies/cents, (e.g., £1.00 = 100).

myRefstring

The reference on the transaction for your records - not shown to the beneficiary.

yourRefstring

The reference on the transaction - displayed on the beneficiary bank statement.

paymentReasonstring

The reason for the payment, used for transaction monitoring purposes. Must be one of Invoice Payment|Salary/Dividend Payment|Expenses|Savings|Other

Example request

{
  "icanFrom": 2001,
  "payeeId": 15002,
  "amount": 500,
  "myRef": "Payment to John Smith for Consultancy in device.",
  "yourRef": "ACME LTD - INV 23434",
  "paymentReason": "Invoice Payment, Salary/Dividend Payment"
}

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"
}