POST api/OuterGate/PayBankPaymentSlip

Permette il pagamento di un bollettino 896, 674, 123, 451

Request Information

URI Parameters

None.

Body Parameters

Oggetto da valorizzare con i dati del bollettino da pagare

Name	Description	Type	Additional information
CustomTags	Lista dei CustomTag	Collection of OuterBillerCustomTagModelIn	None.
MetaTags	Lista dei MetaTag	Collection of OuterBillerMetaTagModelIn	None.
ForceDuplicates	Se Passato true in caso di pagamento di bollettini duplicati non sarà possibile effettuare lo storno	boolean	None.
CustomerAlternativeAddressId	Id dell'indirizzo alternativo del cliente intestatario del bollettino	integer	None.
CustomerSepafinId	Id intestatario bollettino obbligatorio	integer	Required
CustomerExecutorSepafinId	Id del cliente esecutore del bollettino	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
PaymentType	Tipo di pagamento (Contanti o carta di credito/debito)	PaymentType	Required
PayeeCcp	Numero di conto corrente del beneficiario	long integer	Required
TransferAmount	Importo della transazione	decimal number	Required Data type: Currency Matching regular expression pattern: ^[0-9]+([.,][0-9]{0,2})?$ Range: inclusive between 0,01 and 1E+15
BankPaymentSlipCode	Codice del bollettino	string	None.
BankPaymentSlipType	Tipo di bollettino	BankPaymentSlipType	Required Range: inclusive between 123 and 2147483647
Cause	Causale.Se ci sono dei CUSTOM TAG, la CAUSALE LIBERA viene ignorata. Se NON ci sono dei CUSTOM TAG, la CAUSALE LIBERA se valorizzata viene inserita nella causale effettiva del bonifico, quindi è obbligatorio farla inserire al cliente per evitare problemi di riconciliazione con il Biller. I META TAG possono essere presenti sempre, sia quando ci sono i CUSTOM TAG che la CAUSALE LIBERA, non influiscono sulla causale custom o libera.	string	Matching regular expression pattern: ^[a-zA-Z0-9\-_?()+ ,;'=$%@\.]$ String length: inclusive between 0 and 60
PosCode	Identificativo POS	integer	Range: inclusive between 0 and 99999999

Request Formats

application/json, text/json

Sample:

{
  "CustomTags": [
    {
      "TagLabel": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "TagLabel": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "MetaTags": [
    {
      "TagLabel": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "TagLabel": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "ForceDuplicates": true,
  "CustomerAlternativeAddressId": 1,
  "CustomerSepafinId": 1,
  "CustomerExecutorSepafinId": 1,
  "CreatedByIpAddress": "sample string 2",
  "PaymentType": 0,
  "PayeeCcp": 1,
  "TransferAmount": 3.0,
  "BankPaymentSlipCode": "sample string 4",
  "BankPaymentSlipType": 123,
  "Cause": "sample string 5",
  "PosCode": 1
}

application/xml, text/xml

Sample:

<OuterBankPaymentSlipModelIn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels">
  <BankPaymentSlipCode>sample string 4</BankPaymentSlipCode>
  <BankPaymentSlipType>B123</BankPaymentSlipType>
  <Cause>sample string 5</Cause>
  <CreatedByIpAddress>sample string 2</CreatedByIpAddress>
  <CustomerExecutorSepafinId>1</CustomerExecutorSepafinId>
  <CustomerSepafinId>1</CustomerSepafinId>
  <PayeeCcp>1</PayeeCcp>
  <PaymentType>Cash</PaymentType>
  <PosCode>1</PosCode>
  <TransferAmount>3</TransferAmount>
  <CustomTags>
    <OuterBillerCustomTagModelIn>
      <TagLabel>sample string 1</TagLabel>
      <TagRegEx>sample string 3</TagRegEx>
      <Value>sample string 2</Value>
    </OuterBillerCustomTagModelIn>
    <OuterBillerCustomTagModelIn>
      <TagLabel>sample string 1</TagLabel>
      <TagRegEx>sample string 3</TagRegEx>
      <Value>sample string 2</Value>
    </OuterBillerCustomTagModelIn>
  </CustomTags>
  <CustomerAlternativeAddressId>1</CustomerAlternativeAddressId>
  <ForceDuplicates>true</ForceDuplicates>
  <MetaTags>
    <OuterBillerMetaTagModelIn>
      <TagLabel>sample string 1</TagLabel>
      <Value>sample string 2</Value>
    </OuterBillerMetaTagModelIn>
    <OuterBillerMetaTagModelIn>
      <TagLabel>sample string 1</TagLabel>
      <Value>sample string 2</Value>
    </OuterBillerMetaTagModelIn>
  </MetaTags>
</OuterBankPaymentSlipModelIn>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OuterBankPayBankPaymentSlipModelOut

Name	Description	Type	Additional information
CustomTags	Lista dei CustomTag	Collection of OuterBillerCustomTagModelIn	None.
MetaTags	Lista dei MetaTag	Collection of OuterBillerMetaTagModelIn	None.
ForceDuplicates	Se Passato true in caso di pagamento di bollettini duplicati non sarà possibile effettuare lo storno	boolean	None.
CustomerAlternativeAddressId	Id dell'indirizzo alternativo del cliente intestatario del bollettino	integer	None.
IdBulletin	Identificativo interno della transazione	integer	None.
CurrencyDate	Data di valuta calcolata	date time	None.
PaymentDate	Data di pagamento	date time	None.
PayeeName	Biller	string	None.
PayeePostalAccount	QUESTO CAMPO VERRA' DISMESSO IN QUANTO E' PRESENTE UN ALTRO CAMPO PER MOSTRARE IL NUMERO DI CONTO CORRENTE DEL BENEFICIARIO (PayeeCcp)	long integer	None.
PaymentReason	Causale	string	None.
CustomerName	cliente (nome)	string	None.
CustomerLastNameOrBusinessName	Cliente (cognome)	string	None.
CustomerAddress	Indirizzo	string	None.
CustomerCity	Città	string	None.
EmployeeUsername	Operatore	string	None.
UniqueKey	Codice univoco della transazione utilizzato per recuperare il bollettino da portale.	string	None.
TypeOfBullettin	tipologia di bollettino in formato testo	string	None.
CRO	identificativo CRO del pagamento risolto	string	None.
FeesAmount	Commissioni	decimal number	None.
PosPid	Codice univo del pagamento con POS	string	None.
CustomData1	Campo customizabile	string	None.
CustomData2	Campo customizabile	string	None.
CustomData3	Campo customizabile	string	None.
CustomerSepafinId	Id intestatario bollettino obbligatorio	integer	Required
CustomerExecutorSepafinId	Id del cliente esecutore del bollettino	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
PaymentType	Tipo di pagamento (Contanti o carta di credito/debito)	PaymentType	Required
PayeeCcp	Numero di conto corrente del beneficiario	long integer	Required
TransferAmount	Importo della transazione	decimal number	Required Data type: Currency Matching regular expression pattern: ^[0-9]+([.,][0-9]{0,2})?$ Range: inclusive between 0,01 and 1E+15
BankPaymentSlipCode	Codice del bollettino	string	None.
BankPaymentSlipType	Tipo di bollettino	BankPaymentSlipType	Required Range: inclusive between 123 and 2147483647
Cause	Causale.Se ci sono dei CUSTOM TAG, la CAUSALE LIBERA viene ignorata. Se NON ci sono dei CUSTOM TAG, la CAUSALE LIBERA se valorizzata viene inserita nella causale effettiva del bonifico, quindi è obbligatorio farla inserire al cliente per evitare problemi di riconciliazione con il Biller. I META TAG possono essere presenti sempre, sia quando ci sono i CUSTOM TAG che la CAUSALE LIBERA, non influiscono sulla causale custom o libera.	string	Matching regular expression pattern: ^[a-zA-Z0-9\-_?()+ ,;'=$%@\.]$ String length: inclusive between 0 and 60
PosCode	Identificativo POS	integer	Range: inclusive between 0 and 99999999

Response Formats

application/json, text/json

Sample:

{
  "CustomTags": [
    {
      "TagLabel": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "TagLabel": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "MetaTags": [
    {
      "TagLabel": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "TagLabel": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "ForceDuplicates": true,
  "CustomerAlternativeAddressId": 1,
  "IdBulletin": 2,
  "CurrencyDate": "2025-05-14T05:09:29.4203252+02:00",
  "PaymentDate": "2025-05-14T05:09:29.4203252+02:00",
  "PayeeName": "sample string 3",
  "PayeePostalAccount": 1,
  "PaymentReason": "sample string 4",
  "CustomerName": "sample string 5",
  "CustomerLastNameOrBusinessName": "sample string 6",
  "CustomerAddress": "sample string 7",
  "CustomerCity": "sample string 8",
  "EmployeeUsername": "sample string 9",
  "UniqueKey": "sample string 10",
  "TypeOfBullettin": "sample string 11",
  "CRO": "sample string 12",
  "FeesAmount": 1.0,
  "PosPid": "sample string 13",
  "CustomData1": "sample string 14",
  "CustomData2": "sample string 15",
  "CustomData3": "sample string 16",
  "CustomerSepafinId": 1,
  "CustomerExecutorSepafinId": 1,
  "CreatedByIpAddress": "sample string 17",
  "PaymentType": 0,
  "PayeeCcp": 1,
  "TransferAmount": 18.0,
  "BankPaymentSlipCode": "sample string 19",
  "BankPaymentSlipType": 123,
  "Cause": "sample string 20",
  "PosCode": 1
}

application/xml, text/xml

Sample:

<OuterBankPayBankPaymentSlipModelOut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels">
  <BankPaymentSlipCode>sample string 19</BankPaymentSlipCode>
  <BankPaymentSlipType>B123</BankPaymentSlipType>
  <Cause>sample string 20</Cause>
  <CreatedByIpAddress>sample string 17</CreatedByIpAddress>
  <CustomerExecutorSepafinId>1</CustomerExecutorSepafinId>
  <CustomerSepafinId>1</CustomerSepafinId>
  <PayeeCcp>1</PayeeCcp>
  <PaymentType>Cash</PaymentType>
  <PosCode>1</PosCode>
  <TransferAmount>18</TransferAmount>
  <CRO>sample string 12</CRO>
  <CurrencyDate>2025-05-14T05:09:29.4203252+02:00</CurrencyDate>
  <CustomData1>sample string 14</CustomData1>
  <CustomData2>sample string 15</CustomData2>
  <CustomData3>sample string 16</CustomData3>
  <CustomerAddress>sample string 7</CustomerAddress>
  <CustomerCity>sample string 8</CustomerCity>
  <CustomerLastNameOrBusinessName>sample string 6</CustomerLastNameOrBusinessName>
  <CustomerName>sample string 5</CustomerName>
  <EmployeeUsername>sample string 9</EmployeeUsername>
  <FeesAmount>1</FeesAmount>
  <IdBulletin>2</IdBulletin>
  <PayeeName>sample string 3</PayeeName>
  <PayeePostalAccount>1</PayeePostalAccount>
  <PaymentDate>2025-05-14T05:09:29.4203252+02:00</PaymentDate>
  <PaymentReason>sample string 4</PaymentReason>
  <PosPid>sample string 13</PosPid>
  <TypeOfBullettin>sample string 11</TypeOfBullettin>
  <UniqueKey>sample string 10</UniqueKey>
  <CustomTags>
    <OuterBillerCustomTagModelIn>
      <TagLabel>sample string 1</TagLabel>
      <TagRegEx>sample string 3</TagRegEx>
      <Value>sample string 2</Value>
    </OuterBillerCustomTagModelIn>
    <OuterBillerCustomTagModelIn>
      <TagLabel>sample string 1</TagLabel>
      <TagRegEx>sample string 3</TagRegEx>
      <Value>sample string 2</Value>
    </OuterBillerCustomTagModelIn>
  </CustomTags>
  <CustomerAlternativeAddressId>1</CustomerAlternativeAddressId>
  <ForceDuplicates>true</ForceDuplicates>
  <MetaTags>
    <OuterBillerMetaTagModelIn>
      <TagLabel>sample string 1</TagLabel>
      <Value>sample string 2</Value>
    </OuterBillerMetaTagModelIn>
    <OuterBillerMetaTagModelIn>
      <TagLabel>sample string 1</TagLabel>
      <Value>sample string 2</Value>
    </OuterBillerMetaTagModelIn>
  </MetaTags>
</OuterBankPayBankPaymentSlipModelOut>