POST api/OuterGateCircuitoPrivativo/InitiateDirectDebitsToAgency

Addebita all'agenzia indicata tramite codice univoco l'importo impostato.

Request Information

URI Parameters

None.

Body Parameters

The direct debit agency model.

Name	Description	Type	Additional information
CreditorAgencyUniqueCode	Il codice univoco dell'agenzia Creditrice	string	Required
DebtorAgencyId	Id dell'agenzia Debitrice	integer	Required
CreatedByIpAddress	Indirizzo IP di chi sta effettuando la richiesta.	string	Required Matching regular expression pattern: \b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b
TransferAmount	Ammontare del trasferimento	decimal number	Required Data type: Currency Matching regular expression pattern: ^[0-9]+([.,][0-9]{0,2})?$ Range: inclusive between 0,01 and 1E+15
Cause	Causale del movimento	string	String length: inclusive between 0 and 100
CustomData1	Parametro libero	string	None.
CustomData2	Parametro libero	string	None.
CustomData3	Parametro libero	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CreditorAgencyUniqueCode": "sample string 1",
  "DebtorAgencyId": 2,
  "CreatedByIpAddress": "sample string 3",
  "TransferAmount": 4.0,
  "Cause": "sample string 5",
  "CustomData1": "sample string 6",
  "CustomData2": "sample string 7",
  "CustomData3": "sample string 8"
}

application/xml, text/xml

Sample:

<OuterDirectDebitsToAgencyIn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.PrivativeCircuit">
  <Cause>sample string 5</Cause>
  <CreatedByIpAddress>sample string 3</CreatedByIpAddress>
  <CustomData1>sample string 6</CustomData1>
  <CustomData2>sample string 7</CustomData2>
  <CustomData3>sample string 8</CustomData3>
  <TransferAmount>4</TransferAmount>
  <CreditorAgencyUniqueCode>sample string 1</CreditorAgencyUniqueCode>
  <DebtorAgencyId>2</DebtorAgencyId>
</OuterDirectDebitsToAgencyIn>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OuterDirectDebitsToAgencyOut

Name	Description	Type	Additional information
State	Stato della transazione	string	None.
TransactionId	Identificativo della transazione	integer	None.
DataValutaAddebito	Data valuta del movimento	date time	None.
UniqueKey	Codice univoco della transazione	string	None.
CustomData1	Parametro libero	string	None.
CustomData2	Parametro libero	string	None.
CustomData3	Parametro libero	string	None.

Response Formats

application/json, text/json

Sample:

{
  "State": "sample string 1",
  "TransactionId": 2,
  "DataValutaAddebito": "2025-05-14T06:29:03.9909484+02:00",
  "UniqueKey": "sample string 4",
  "CustomData1": "sample string 5",
  "CustomData2": "sample string 6",
  "CustomData3": "sample string 7"
}

application/xml, text/xml

Sample:

<OuterDirectDebitsToAgencyOut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.PrivativeCircuit">
  <CustomData1>sample string 5</CustomData1>
  <CustomData2>sample string 6</CustomData2>
  <CustomData3>sample string 7</CustomData3>
  <DataValutaAddebito>2025-05-14T06:29:03.9909484+02:00</DataValutaAddebito>
  <State>sample string 1</State>
  <TransactionId>2</TransactionId>
  <UniqueKey>sample string 4</UniqueKey>
</OuterDirectDebitsToAgencyOut>