POST api/transfer/interaccount

Transfer funds between bank accounts (also Deposit Cash/Cheques from Cash Held) Processes this transfer API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The process iat data contract supplied with the request.

ProcessIatDataContract
NameDescriptionTypeAdditional information
Amount

The amount value.

decimal number

None.

EntityId

The unique identifier of the related entity resource.

integer

None.

EntityType

The entity type classification.

IatType

None.

SourceBankAccountId

The unique identifier of the related source bank account resource.

integer

None.

RecipientBankAccountId

The unique identifier of the related recipient bank account resource.

integer

None.

DateTime

The date time, expressed as a date and time.

date

None.

ReceiptIds

The unique identifiers of the related receipt resources.

Collection of integer

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "Amount": 1.0,
  "EntityId": 2,
  "EntityType": 0,
  "SourceBankAccountId": 3,
  "RecipientBankAccountId": 4,
  "DateTime": "2026-08-05T00:18:59.6826623Z",
  "ReceiptIds": [
    1,
    2
  ]
}

Response Information

Resource Description

The response returned after the operation completes.

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.