Add 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The uuid of the batch.

Body Params

Details of Mode 1 & Mode 2.

int64

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

int64

The ID of the existing or automatically created payee

string
enum

Use PAYEE_ID if you are paying existing approved payees (Mode 1).

Allowed:
int64

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

string
length ≤ 50

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

string
length ≤ 50

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

Responses

Language
Credentials
Bearer
API Access Token
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json