PUT Api/FDI

Adds new FDI in the system.

Request Information

URI Parameters

None.

Body Parameters

APIFDIAddModel
NameDescriptionTypeAdditional information
ACHCompanyID

Company ID. Either Company ID or Principle MID is required if biller's payment consolidator is not enabled or partner's payment consolidator biller funds movement is not ACH and AR File (Sponsor Bank).

 string

String length: inclusive between 0 and 128
ACHCompanyName

Company Name. Required if biller's payment consolidator is not enabled or partner's payment consolidator biller funds movement is not ACH and AR File (Sponsor Bank).

 string

String length: inclusive between 0 and 256
ACHPassword

ACH Password

 string

String length: inclusive between 0 and 512
ACHURL

ACH URL

 string

String length: inclusive between 0 and 256
ACHUsername

ACH Username

 string

String length: inclusive between 0 and 256
Active

Specifies whether the FDI Code should be active. False by default.

 boolean

None.
CCClientID

CC Client ID

 string

String length: inclusive between 0 and 100
CCMerchantKey

CC Merchant Key

 string

String length: inclusive between 0 and 100
CCPassword

CC Password

 string

String length: inclusive between 0 and 512
CCURL

CC URL

 string

String length: inclusive between 0 and 256
CCUsername

CC Username

 string

String length: inclusive between 0 and 256
DDAAccountType

DDA Account Type

 int?

None.
Default

Specifies whether the FDI Code should be the default. False by default.

 boolean

None.
DepositoryDDA

Depository DDA. Required if biller's AR file processor requires DDA or payment processor is ACH Batch Processing (Balanced), ACH Batch Processing (Balanced ODFI), or ACH Batch Processing (Balanced TraceID).

 string

String length: inclusive between 0 and 20
DepositoryRoutingNumber

Routing Transit Number. Required if biller's payment processor is ACH Batch Processing (Balanced), ACH Batch Processing (Balanced ODFI), or ACH Batch Processing (Balanced TraceID).

 string

String length: inclusive between 0 and 50
Description

Description of the FDI Code

 string

String length: inclusive between 0 and 100
ElavonBankNumber

Elavon Bank Number

 string

String length: inclusive between 0 and 64
FDICode

The FDI Code. Required and no longer than 20 characters.

 string

Required

String length: inclusive between 0 and 20
PaymentConsolidatorMerchantID

Payment Consolidator Merchant ID. Required if biller's payment consolidator is enabled.

 string

String length: inclusive between 0 and 100
PCCompanyID

Company ID. Required if biller's payment consolidator is enabled and partner's payment consolidator biller funds movement is ACH and AR File (Sponsor Bank).

 string

String length: inclusive between 0 and 128
PCCompanyName

Company Name. Required if biller's payment consolidator is enabled and partner's payment consolidator biller funds movement is ACH and AR File (Sponsor Bank).

 string

String length: inclusive between 0 and 256
PCDDAAccountType

DDA Account Type. Required if biller's payment consolidator is enabled and partner's payment consolidator biller funds movement is ACH and AR File (Sponsor Bank).

 int?

None.
PCDepositoryDDA

Depository DDA. Required if biller's payment consolidator is enabled and partner's payment consolidator biller funds movement is ACH and AR File (Sponsor Bank).

 string

String length: inclusive between 0 and 64
PCDepositoryRoutingNumber

Depository R/T. Required if biller's payment consolidator is enabled and partner's payment consolidator biller funds movement is ACH and AR File (Sponsor Bank).

 string

String length: inclusive between 0 and 64
PrincipleMID

Principle MID. Either Principle MID or Company ID is required if biller's payment consolidator is not enabled or partner's payment consolidator biller funds movement is not ACH and AR File (Sponsor Bank).

 string

String length: inclusive between 0 and 400
RTPAccountNumber

RTP Payment Account Number, address related fields are required if RTP Account Number is provided

 string

String length: inclusive between 0 and 64
RTPAddress

RTP biller's Address, require

 string

String length: inclusive between 0 and 256
RTPCity

RTP biller's City

 string

String length: inclusive between 0 and 50
RTPClientID

RTP biller's Client ID or Account Key if applicable

 string

String length: inclusive between 0 and 128
RTPCountry

RTP biller's Country code

 string

String length: inclusive between 0 and 3
RTPRoutingNumber

RTP Payment Account Routing Number

 string

String length: inclusive between 0 and 50
RTPState

RTP biller's State

 string

String length: inclusive between 0 and 20
RTPUltimateClientKey

RTP Ultimate ClientKey if applicable

 string

String length: inclusive between 0 and 50
RTPZipCode

RTP biller's Zip code

 string

String length: inclusive between 0 and 14

Request Formats

application/json, text/json

Sample: 
{
  "Active": true,
  "Default": true,
  "FDICode": "sample string 3",
  "RTPAccountNumber": "sample string 4",
  "ACHPassword": "sample string 5",
  "ACHURL": "sample string 6",
  "ACHUsername": "sample string 7",
  "CCClientID": "sample string 8",
  "CCMerchantKey": "sample string 9",
  "CCURL": "sample string 10",
  "CCUsername": "sample string 11",
  "CCPassword": "sample string 12",
  "ACHCompanyID": "sample string 13",
  "ACHCompanyName": "sample string 14",
  "DepositoryDDA": "sample string 15",
  "Description": "sample string 16",
  "DepositoryRoutingNumber": "sample string 17",
  "DDAAccountType": 1,
  "ElavonBankNumber": "sample string 18",
  "PrincipleMID": "sample string 19",
  "PaymentConsolidatorMerchantID": "sample string 20",
  "PCCompanyID": "sample string 21",
  "PCCompanyName": "sample string 22",
  "PCDDAAccountType": 1,
  "PCDepositoryDDA": "sample string 23",
  "PCDepositoryRoutingNumber": "sample string 24",
  "RTPClientID": "sample string 25",
  "RTPRoutingNumber": "sample string 26",
  "RTPUltimateClientKey": "sample string 27",
  "RTPAddress": "sample string 28",
  "RTPCountry": "sample string 29",
  "RTPCity": "sample string 30",
  "RTPState": "sample string 31",
  "RTPZipCode": "sample string 32"
}

Response Information

Resource Description

Adds new FDI in the system.

APIFDIResponseModel
NameDescriptionTypeAdditional information
ErrorCode

Name of the error condition. See ErrorCode model for details.

 ErrorCode

None.
ErrorID

Internal error identification number that uniquely identifies this specific error that occurred.

 string

None.
ErrorNum

Numeric value of the ErrorCode

 int

None.
Errors

List of errors that occurred when performing the fdi request.

 Collection of string

None.
Result

APIFDIResultModel

None.
Success

Indicates success or failure of the REST request.

 boolean

None.

Response Formats

application/json, text/json

Sample:

Sample not available.