POST api/OuterGate/PayMav

Permette il pagamento di un MAV

Request Information

URI Parameters

None.

Body Parameters

Oggetto da valorizzare con i dati del MAV da pagare

OuterMavRavModelIn
NameDescriptionTypeAdditional information
PosCode

Identificativo POS

 integer

Range: inclusive between 0 and 99999999
CustomerAlternativeAddressId

Id dell'indirizzo alternativo del cliente intestatario del bollettino

 integer

None.
Code

Codice

 string

Required

Matching regular expression pattern: ^([0-9]{17})$
TransferAmount

Importo del MAV/RAV

 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

 string

Matching regular expression pattern: ^[a-zA-Z0-9\-_?()+ ,;'=*$%@\.]*$
CreatedByIpAddress

Indirizzo IP

 string

Required

Matching regular expression pattern: \b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b
PaymentType

Tipo di pagamento

 PaymentType

Required
CustomerSepafinId

Id cliente intestatario bollettino

 integer

Required
CustomerExecutorSepafinId

Id del cliente esecutore del bollettino

 integer

Required
CustomData1

Campo personalizzabile

 string

None.
CustomData2

Campo personalizzabile

 string

None.
CustomData3

Campo personalizzabile

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "PosCode": 1,
  "CustomerAlternativeAddressId": 1,
  "Code": "sample string 1",
  "TransferAmount": 2.0,
  "Cause": "sample string 3",
  "CreatedByIpAddress": "sample string 4",
  "PaymentType": 0,
  "CustomerSepafinId": 1,
  "CustomerExecutorSepafinId": 1,
  "CustomData1": "sample string 5",
  "CustomData2": "sample string 6",
  "CustomData3": "sample string 7"
}

application/xml, text/xml

Sample: 
<OuterMavRavModelIn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels">
  <Cause>sample string 3</Cause>
  <Code>sample string 1</Code>
  <CreatedByIpAddress>sample string 4</CreatedByIpAddress>
  <CustomData1>sample string 5</CustomData1>
  <CustomData2>sample string 6</CustomData2>
  <CustomData3>sample string 7</CustomData3>
  <CustomerExecutorSepafinId>1</CustomerExecutorSepafinId>
  <CustomerSepafinId>1</CustomerSepafinId>
  <PaymentType>Cash</PaymentType>
  <TransferAmount>2</TransferAmount>
  <CustomerAlternativeAddressId>1</CustomerAlternativeAddressId>
  <PosCode>1</PosCode>
</OuterMavRavModelIn>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OuterPayMavRavModelOut
NameDescriptionTypeAdditional information
PosCode

Identificativo POS

 integer

Range: inclusive between 0 and 99999999
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.
CustomerLastNameOrBusinessName

Cognome cliente

 string

None.
CustomerName

Nome cliente

 string

None.
CustomerAddress

Indirizzo cliente

 string

None.
EmployeeUsername

Operatore

 string

None.
UniqueKey

Codice univoco della transazione utilizzato per recuperare il bollettino da portale.

 string

None.
FeesAmount

decimal number

None.
PosPid

Codice univo della transazione POS

 string

None.
Code

Codice

 string

Required

Matching regular expression pattern: ^([0-9]{17})$
TransferAmount

Importo del MAV/RAV

 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

 string

Matching regular expression pattern: ^[a-zA-Z0-9\-_?()+ ,;'=*$%@\.]*$
CreatedByIpAddress

Indirizzo IP

 string

Required

Matching regular expression pattern: \b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b
PaymentType

Tipo di pagamento

 PaymentType

Required
CustomerSepafinId

Id cliente intestatario bollettino

 integer

Required
CustomerExecutorSepafinId

Id del cliente esecutore del bollettino

 integer

Required
CustomData1

Campo personalizzabile

 string

None.
CustomData2

Campo personalizzabile

 string

None.
CustomData3

Campo personalizzabile

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "PosCode": 1,
  "CustomerAlternativeAddressId": 1,
  "IdBulletin": 1,
  "CurrencyDate": "2025-05-14T04:33:08.2802444+02:00",
  "PaymentDate": "2025-05-14T04:33:08.2802444+02:00",
  "CustomerLastNameOrBusinessName": "sample string 4",
  "CustomerName": "sample string 5",
  "CustomerAddress": "sample string 6",
  "EmployeeUsername": "sample string 7",
  "UniqueKey": "sample string 8",
  "FeesAmount": 9.0,
  "PosPid": "sample string 10",
  "Code": "sample string 11",
  "TransferAmount": 12.0,
  "Cause": "sample string 13",
  "CreatedByIpAddress": "sample string 14",
  "PaymentType": 0,
  "CustomerSepafinId": 1,
  "CustomerExecutorSepafinId": 1,
  "CustomData1": "sample string 15",
  "CustomData2": "sample string 16",
  "CustomData3": "sample string 17"
}

application/xml, text/xml

Sample: 
<OuterPayMavRavModelOut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels">
  <Cause>sample string 13</Cause>
  <Code>sample string 11</Code>
  <CreatedByIpAddress>sample string 14</CreatedByIpAddress>
  <CustomData1>sample string 15</CustomData1>
  <CustomData2>sample string 16</CustomData2>
  <CustomData3>sample string 17</CustomData3>
  <CustomerExecutorSepafinId>1</CustomerExecutorSepafinId>
  <CustomerSepafinId>1</CustomerSepafinId>
  <PaymentType>Cash</PaymentType>
  <TransferAmount>12</TransferAmount>
  <CurrencyDate>2025-05-14T04:33:08.2802444+02:00</CurrencyDate>
  <CustomerAddress>sample string 6</CustomerAddress>
  <CustomerLastNameOrBusinessName>sample string 4</CustomerLastNameOrBusinessName>
  <CustomerName>sample string 5</CustomerName>
  <EmployeeUsername>sample string 7</EmployeeUsername>
  <FeesAmount>9</FeesAmount>
  <IdBulletin>1</IdBulletin>
  <PaymentDate>2025-05-14T04:33:08.2802444+02:00</PaymentDate>
  <PosPid>sample string 10</PosPid>
  <UniqueKey>sample string 8</UniqueKey>
  <CustomerAlternativeAddressId>1</CustomerAlternativeAddressId>
  <PosCode>1</PosCode>
</OuterPayMavRavModelOut>