POST api/OuterGateVoucher/TransferOrder

Crea una disposizione di bonifico

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
AgencyUsername	AgencyUsername del PO a cui fa riferimento il voucher OBBLIGATORIO	string	Required
VoucherCode	Codice identificativo del voucher OBBLIGATORIO	string	Required
CustomerFiscalCode	Codice fiscale del cliente OBBLIGATORIO	string	Required Fiscal code validation Max length: 20
CustomerLastNameOrBusinessName	Cognome o ragione sociale del cliente OBBLIGATORIO	string	Required Min length: 3
CustomerName	None del cliente OBBLIGATORIO	string	Required Min length: 3
CustomerAddress	Indirizzo del cliente OBBLIGATORIO	string	Max length: 255 Min length: 3
CustomerCap	CAP del cliente OBBLIGATORIO	string	Max length: 5 Min length: 5
CustomerCity	Città del cliente OBBLIGATORIO	string	Max length: 255 Min length: 3
CustomerProvince	Provincia del cliente OBBLIGATORIO	string	String length: inclusive between 0 and 2
CustomerTwoLetterISOLanguageName	Nome ISO a due lettere della nazione (Italia = IT) della residenza o domicilio del cliente OBBLIGATORIO	string	String length: inclusive between 0 and 2
CustomerIdDocument	ID del documento del cliente OBBLIGATORIO	string	Required Max length: 50 Min length: 3
CustomerDocumentType	Tipo documento del cliente OBBLIGATORIO	DocumentType	Required
PaymentReason	Causale OBBLIGATORIO	string	Required Max length: 27
CreatedByIpAddress	Indirizzo IP di chi sta effettuando la richiesta OBBLIGATORIO	string	Required Matching regular expression pattern: \b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b
TransferOrderType	Indica il tipo di operazione	TransferOrderType	None.
TransferExecutionDate	Data esecuzione bonifico OBBLIGATORIO	date time	Required
TransferAmount	Importo del bonifico	decimal number	Required Matching regular expression pattern: ^\d+(\,\d{1,2})?$ Range: inclusive between 0 and 1E+15

Request Formats

application/json, text/json

Sample:

{
  "AgencyUsername": "sample string 1",
  "VoucherCode": "sample string 2",
  "CustomerFiscalCode": "sample string 3",
  "CustomerLastNameOrBusinessName": "sample string 4",
  "CustomerName": "sample string 5",
  "CustomerAddress": "sample string 6",
  "CustomerCap": "sample string 7",
  "CustomerCity": "sample string 8",
  "CustomerProvince": "sample string 9",
  "CustomerTwoLetterISOLanguageName": "sample string 10",
  "CustomerIdDocument": "sample string 11",
  "CustomerDocumentType": 0,
  "PaymentReason": "sample string 12",
  "CreatedByIpAddress": "sample string 13",
  "TransferOrderType": 1,
  "TransferExecutionDate": "2025-05-14T04:51:36.7457567+02:00",
  "TransferAmount": 15.0
}

application/xml, text/xml

Sample:

<OuterTransferOrderValidateModelIn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.TransferOrder.Voucher">
  <CreatedByIpAddress xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.TransferOrder">sample string 13</CreatedByIpAddress>
  <TransferAmount xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.TransferOrder">15</TransferAmount>
  <TransferExecutionDate xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.TransferOrder">2025-05-14T04:51:36.7457567+02:00</TransferExecutionDate>
  <TransferOrderType xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.TransferOrder">BankBullettin</TransferOrderType>
  <AgencyUsername>sample string 1</AgencyUsername>
  <CustomerAddress>sample string 6</CustomerAddress>
  <CustomerCap>sample string 7</CustomerCap>
  <CustomerCity>sample string 8</CustomerCity>
  <CustomerDocumentType>None</CustomerDocumentType>
  <CustomerFiscalCode>sample string 3</CustomerFiscalCode>
  <CustomerIdDocument>sample string 11</CustomerIdDocument>
  <CustomerLastNameOrBusinessName>sample string 4</CustomerLastNameOrBusinessName>
  <CustomerName>sample string 5</CustomerName>
  <CustomerProvince>sample string 9</CustomerProvince>
  <CustomerTwoLetterISOLanguageName>sample string 10</CustomerTwoLetterISOLanguageName>
  <PaymentReason>sample string 12</PaymentReason>
  <VoucherCode>sample string 2</VoucherCode>
</OuterTransferOrderValidateModelIn>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OuterTransferOrderOut

Name	Description	Type	Additional information
IdTransferOrder	Id della disposizione di bonifico	integer	None.
CRO		string	None.
PayerCoordinates	Codice Iban del dell'ordinante	string	Max length: 35
PaymentReason	Causale del pagamento	string	Required Max length: 140
PayeeBank	Banca del beneficiario formato Swift o Coordinate bancarie https://it.wikipedia.org/wiki/Coordinate_bancarie#Codice_BIC_.28o_SWIFT.29	string	Required Matching regular expression pattern: ^([a-zA-z0-9]{8})$\|^([a-zA-z0-9]{11})$
PayeeCountry	Nazione del beneficiario	string	Required Matching regular expression pattern: ^[a-zA-z]{2}$
PayeeIban	Codice Iban del beneficiario	string	Required Max length: 35
PayeeName	Nome del beneficiario	string	Required Max length: 70
PayeeAddress	Indirizzo del beneficiario	string	Required Max length: 70
PayeeCap	CAP del beneficiario	string	Required Max length: 16
PayeeCityAndProvince	Comune e provincia del beneficiario	string	Required Max length: 35
PayerRegistryEffective	Anagrafica ordinante effettivo	string	Required Max length: 70
PayerAddressEffective	Indirizzo dell'ordinante effettivo	string	Required Max length: 70
PayerCityAndProvinceEffective	Comune e provincia del dell'ordinante effettivo	string	Required Max length: 35
PayerCapEffective	CAP del dell'ordinante effettivo	string	Required Max length: 16
PayerNationEffective	Nazione del dell'ordinante effettivo	string	Required Matching regular expression pattern: ^[a-zA-z]{2}$
CreatedByIpAddress	Indirizzo IP di chi sta effettuando la richiesta OBBLIGATORIO	string	Required Matching regular expression pattern: \b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b
TransferOrderType	Indica il tipo di operazione	TransferOrderType	None.
TransferExecutionDate	Data esecuzione bonifico OBBLIGATORIO	date time	Required
TransferAmount	Importo del bonifico	decimal number	Required Matching regular expression pattern: ^\d+(\,\d{1,2})?$ Range: inclusive between 0 and 1E+15

Response Formats

application/json, text/json

Sample:

{
  "IdTransferOrder": 1,
  "CRO": "sample string 2",
  "PayerCoordinates": "sample string 3",
  "PaymentReason": "sample string 4",
  "PayeeBank": "sample string 5",
  "PayeeCountry": "sample string 6",
  "PayeeIban": "sample string 7",
  "PayeeName": "sample string 8",
  "PayeeAddress": "sample string 9",
  "PayeeCap": "sample string 10",
  "PayeeCityAndProvince": "sample string 11",
  "PayerRegistryEffective": "sample string 12",
  "PayerAddressEffective": "sample string 13",
  "PayerCityAndProvinceEffective": "sample string 14",
  "PayerCapEffective": "sample string 15",
  "PayerNationEffective": "sample string 16",
  "CreatedByIpAddress": "sample string 17",
  "TransferOrderType": 1,
  "TransferExecutionDate": "2025-05-14T04:51:36.7457567+02:00",
  "TransferAmount": 19.0
}

application/xml, text/xml

Sample:

<OuterTransferOrderOut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.TransferOrder">
  <CreatedByIpAddress>sample string 17</CreatedByIpAddress>
  <TransferAmount>19</TransferAmount>
  <TransferExecutionDate>2025-05-14T04:51:36.7457567+02:00</TransferExecutionDate>
  <TransferOrderType>BankBullettin</TransferOrderType>
  <PayeeAddress>sample string 9</PayeeAddress>
  <PayeeBank>sample string 5</PayeeBank>
  <PayeeCap>sample string 10</PayeeCap>
  <PayeeCityAndProvince>sample string 11</PayeeCityAndProvince>
  <PayeeCountry>sample string 6</PayeeCountry>
  <PayeeIban>sample string 7</PayeeIban>
  <PayeeName>sample string 8</PayeeName>
  <PayerAddressEffective>sample string 13</PayerAddressEffective>
  <PayerCapEffective>sample string 15</PayerCapEffective>
  <PayerCityAndProvinceEffective>sample string 14</PayerCityAndProvinceEffective>
  <PayerCoordinates>sample string 3</PayerCoordinates>
  <PayerNationEffective>sample string 16</PayerNationEffective>
  <PayerRegistryEffective>sample string 12</PayerRegistryEffective>
  <PaymentReason>sample string 4</PaymentReason>
  <CRO>sample string 2</CRO>
  <IdTransferOrder>1</IdTransferOrder>
</OuterTransferOrderOut>