PUT api/Transfer/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

ScheduledTransfer
NameDescriptionTypeAdditional information
StartDate

date

None.

Frequency

Frequency

None.

NextDate

date

None.

EndDate

date

None.

NumberOfTransfers

integer

None.

Receipts

Collection of Receipt

None.

TransferID

integer

None.

FromAccountID

integer

None.

FromSuffixID

integer

None.

FromInstitution

string

None.

FromAccount

string

None.

ToAccountID

integer

None.

ToSuffixID

integer

None.

ToInstitution

string

None.

ToSharedBranching

boolean

None.

ToAccount

string

None.

Amount

decimal number

None.

Memo

string

None.

Request Formats

application/json, text/json

Sample:
{
  "StartDate": "2021-05-17T09:16:08.9428884Z",
  "Frequency": 0,
  "NextDate": "2021-05-17T09:16:08.9428884Z",
  "EndDate": "2021-05-17T09:16:08.9428884Z",
  "NumberOfTransfers": 1,
  "Receipts": [
    {
      "$id": "2",
      "ReceiptID": 1,
      "TransferID": 1,
      "P2PID": 1,
      "Type": 0,
      "Time": "2021-05-17T09:16:08.9428884Z",
      "TraceNumber": "sample string 3",
      "FromInstitution": "sample string 4",
      "FromAccount": "sample string 5",
      "FromDescription": "sample string 6",
      "ToToken": "sample string 7",
      "ToInstitution": "sample string 8",
      "ToAccount": "sample string 9",
      "ToDescription": "sample string 10",
      "ToName": "sample string 11",
      "ToContact": "sample string 12",
      "Memo": "sample string 13",
      "Amount": 14.0,
      "FromLedgerBalance": 1.0,
      "FromAvailableBalance": 1.0,
      "ToLedgerBalance": 1.0,
      "ToAvailableBalance": 1.0,
      "NextPaymentDate": "2021-05-17T09:16:08.9428884Z",
      "ResponseCode": "sample string 15",
      "ResponseDescription": "sample string 16",
      "NonImmediate": true,
      "PaymentPath": "sample string 17",
      "ItemNumber": 18,
      "ItemCount": 19
    },
    {
      "$ref": "2"
    }
  ],
  "TransferID": 1,
  "FromAccountID": 2,
  "FromSuffixID": 3,
  "FromInstitution": "sample string 4",
  "FromAccount": "sample string 5",
  "ToAccountID": 6,
  "ToSuffixID": 7,
  "ToInstitution": "sample string 8",
  "ToSharedBranching": true,
  "ToAccount": "sample string 10",
  "Amount": 11.0,
  "Memo": "sample string 12"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ScheduledTransfer
NameDescriptionTypeAdditional information
StartDate

date

None.

Frequency

Frequency

None.

NextDate

date

None.

EndDate

date

None.

NumberOfTransfers

integer

None.

Receipts

Collection of Receipt

None.

TransferID

integer

None.

FromAccountID

integer

None.

FromSuffixID

integer

None.

FromInstitution

string

None.

FromAccount

string

None.

ToAccountID

integer

None.

ToSuffixID

integer

None.

ToInstitution

string

None.

ToSharedBranching

boolean

None.

ToAccount

string

None.

Amount

decimal number

None.

Memo

string

None.

Response Formats

application/json, text/json

Sample:
{
  "StartDate": "2021-05-17T09:16:08.9428884Z",
  "Frequency": 0,
  "NextDate": "2021-05-17T09:16:08.9428884Z",
  "EndDate": "2021-05-17T09:16:08.9428884Z",
  "NumberOfTransfers": 1,
  "Receipts": [
    {
      "$id": "2",
      "ReceiptID": 1,
      "TransferID": 1,
      "P2PID": 1,
      "Type": 0,
      "Time": "2021-05-17T09:16:08.9428884Z",
      "TraceNumber": "sample string 3",
      "FromInstitution": "sample string 4",
      "FromAccount": "sample string 5",
      "FromDescription": "sample string 6",
      "ToToken": "sample string 7",
      "ToInstitution": "sample string 8",
      "ToAccount": "sample string 9",
      "ToDescription": "sample string 10",
      "ToName": "sample string 11",
      "ToContact": "sample string 12",
      "Memo": "sample string 13",
      "Amount": 14.0,
      "FromLedgerBalance": 1.0,
      "FromAvailableBalance": 1.0,
      "ToLedgerBalance": 1.0,
      "ToAvailableBalance": 1.0,
      "NextPaymentDate": "2021-05-17T09:16:08.9428884Z",
      "ResponseCode": "sample string 15",
      "ResponseDescription": "sample string 16",
      "NonImmediate": true,
      "PaymentPath": "sample string 17",
      "ItemNumber": 18,
      "ItemCount": 19
    },
    {
      "$ref": "2"
    }
  ],
  "TransferID": 1,
  "FromAccountID": 2,
  "FromSuffixID": 3,
  "FromInstitution": "sample string 4",
  "FromAccount": "sample string 5",
  "ToAccountID": 6,
  "ToSuffixID": 7,
  "ToInstitution": "sample string 8",
  "ToSharedBranching": true,
  "ToAccount": "sample string 10",
  "Amount": 11.0,
  "Memo": "sample string 12"
}