POST api/OuterGatePaPay/IdentificationAsync

Effettua l'identificazione e ritorna un token utile ad effettuare i pagamenti e informazioni dell’utente a cui verrà ricaricata la mensa (il bambino)

Request Information

URI Parameters

None.

Body Parameters

The identification model.

OuterIdentificationModelIn

Name	Description	Type	Additional information
CreatedByIpAddress	Indirizzo IP di chi effettua la richiesta	string	Required Matching regular expression pattern: \b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b
TicketColumns	Definisce il numero delle colonne (caratteri per riga) che costituiranno la “larghezza” dello scontrino; il WEB service dovrà “restituire” lo scontrino considerando questa richiesta. I valori ammessi sono 40 o 80. DEFAULT 40	integer	Matching regular expression pattern: 40\|80
InputValue	Codice PAN dello studente	string	Required String length: inclusive between 9 and 14

Name

Description

Type

Additional information

CreatedByIpAddress

Indirizzo IP di chi effettua la richiesta

string

Required

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

TicketColumns

Definisce il numero delle colonne (caratteri per riga) che costituiranno la “larghezza” dello scontrino; il WEB service dovrà “restituire” lo scontrino considerando questa richiesta. I valori ammessi sono 40 o 80. DEFAULT 40

integer

Matching regular expression pattern: 40|80

InputValue

Codice PAN dello studente

string

Required

String length: inclusive between 9 and 14

Request Formats

application/json, text/json

Sample:

{
  "CreatedByIpAddress": "sample string 1",
  "TicketColumns": 1,
  "InputValue": "sample string 2"
}

application/xml, text/xml

Sample:

<OuterIdentificationModelIn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.PaPay">
  <InputValue>sample string 2</InputValue>
  <CreatedByIpAddress>sample string 1</CreatedByIpAddress>
  <TicketColumns>1</TicketColumns>
</OuterIdentificationModelIn>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OuterIdentificationModelOut

Name	Description	Type	Additional information
Token	Campo Token restituito dalla funzione GSPATM_Identification().	string	None.
CstDescription	Descrizione del cliente (comune)	string	String length: inclusive between 0 and 100
DstDescription	Descrizione della classe di appartenenza del consumatore	string	String length: inclusive between 0 and 100
CsmCode	Matricola del consumatore	string	String length: inclusive between 0 and 100
CsmFirstName	Nome del consumatore	string	String length: inclusive between 0 and 50
CsmLastName	Cognome del consumatore	string	String length: inclusive between 0 and 50
CreditAmount	Credito (saldo) del consumatore considerando anche l’esecuzione della transazione corrente.	decimal number double precision	None.
CreditLastUpdate	Date ed ora cui fa riferimento il valore di CreditAmount	date time	None.
ProposedTransactionAmount	Importo proposto per la transazione	decimal number double precision	None.
IsProposedTransactionAmountLocked	Flag che stabilisce se l’ATM bancario dovrà consentire o meno la modifica dell’importo da “caricare”; i valori ammessi sono: 0 – False 1 - True	boolean	None.
CustomTags	Lista dei CustomTags richiesti dal Biller	Collection of OuterBillerCustomTagModelOut	None.
MetaTags	Lista dei MetaTags richiesti dal Biller	Collection of OuterBillerMetaTagModelOut	None.
ErrorCode	Codice numerico dell’eventuale errore riscontrato durante l’esecuzione di qualsiasi metodo. In caso di esito positivo sarà restituito il valore 0.	integer	None.
ErrorDescription	Descrizione dell’eventuale errore riscontrato durante l’esecuzione di qualsiasi metodo. In caso di esito positivo sarà restituito il valore.	string	None.
PaPayTransactionMethodGenerateError	Codice di errore restituito dal servizio esterno	PaPayTransactionMethodGenerateError	None.

Response Formats

application/json, text/json

Sample:

{
  "Token": "sample string 1",
  "CstDescription": "sample string 2",
  "DstDescription": "sample string 3",
  "CsmCode": "sample string 4",
  "CsmFirstName": "sample string 5",
  "CsmLastName": "sample string 6",
  "CreditAmount": 7.1,
  "CreditLastUpdate": "2025-11-02T09:34:00.3923645+01:00",
  "ProposedTransactionAmount": 9.1,
  "IsProposedTransactionAmountLocked": true,
  "CustomTags": [
    {
      "Id": 1,
      "BillerId": 2,
      "TagCharNumber": 1,
      "TagName": "sample string 3",
      "TagLabel": "sample string 4",
      "TagType": 0,
      "TypeOfBulletin": 0,
      "TypeOfBulletinDesc": "MAV"
    },
    {
      "Id": 1,
      "BillerId": 2,
      "TagCharNumber": 1,
      "TagName": "sample string 3",
      "TagLabel": "sample string 4",
      "TagType": 0,
      "TypeOfBulletin": 0,
      "TypeOfBulletinDesc": "MAV"
    }
  ],
  "MetaTags": [
    {
      "Id": 1,
      "BillerId": 2,
      "TagLabel": "sample string 3",
      "TagName": "sample string 4",
      "TagType": 0,
      "TypeOfBulletin": 0,
      "TypeOfBulletinDesc": "MAV"
    },
    {
      "Id": 1,
      "BillerId": 2,
      "TagLabel": "sample string 3",
      "TagName": "sample string 4",
      "TagType": 0,
      "TypeOfBulletin": 0,
      "TypeOfBulletinDesc": "MAV"
    }
  ],
  "ErrorCode": 11,
  "ErrorDescription": "sample string 12",
  "PaPayTransactionMethodGenerateError": 0
}

application/xml, text/xml

Sample:

<OuterIdentificationModelOut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.PaPay">
  <ErrorCode>11</ErrorCode>
  <ErrorDescription>sample string 12</ErrorDescription>
  <PaPayTransactionMethodGenerateError>None</PaPayTransactionMethodGenerateError>
  <CreditAmount>7.1</CreditAmount>
  <CreditLastUpdate>2025-11-02T09:34:00.3923645+01:00</CreditLastUpdate>
  <CsmCode>sample string 4</CsmCode>
  <CsmFirstName>sample string 5</CsmFirstName>
  <CsmLastName>sample string 6</CsmLastName>
  <CstDescription>sample string 2</CstDescription>
  <CustomTags xmlns:d2p1="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels">
    <d2p1:OuterBillerCustomTagModelOut>
      <d2p1:BillerId>2</d2p1:BillerId>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:TagCharNumber>1</d2p1:TagCharNumber>
      <d2p1:TagLabel>sample string 4</d2p1:TagLabel>
      <d2p1:TagName>sample string 3</d2p1:TagName>
      <d2p1:TagRegEx>sample string 5</d2p1:TagRegEx>
      <d2p1:TagType>TagText</d2p1:TagType>
      <d2p1:TypeOfBulletin>Mav</d2p1:TypeOfBulletin>
    </d2p1:OuterBillerCustomTagModelOut>
    <d2p1:OuterBillerCustomTagModelOut>
      <d2p1:BillerId>2</d2p1:BillerId>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:TagCharNumber>1</d2p1:TagCharNumber>
      <d2p1:TagLabel>sample string 4</d2p1:TagLabel>
      <d2p1:TagName>sample string 3</d2p1:TagName>
      <d2p1:TagRegEx>sample string 5</d2p1:TagRegEx>
      <d2p1:TagType>TagText</d2p1:TagType>
      <d2p1:TypeOfBulletin>Mav</d2p1:TypeOfBulletin>
    </d2p1:OuterBillerCustomTagModelOut>
  </CustomTags>
  <DstDescription>sample string 3</DstDescription>
  <IsProposedTransactionAmountLocked>true</IsProposedTransactionAmountLocked>
  <MetaTags xmlns:d2p1="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels">
    <d2p1:OuterBillerMetaTagModelOut>
      <d2p1:BillerId>2</d2p1:BillerId>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:TagLabel>sample string 3</d2p1:TagLabel>
      <d2p1:TagName>sample string 4</d2p1:TagName>
      <d2p1:TagType>TagText</d2p1:TagType>
      <d2p1:TypeOfBulletin>Mav</d2p1:TypeOfBulletin>
    </d2p1:OuterBillerMetaTagModelOut>
    <d2p1:OuterBillerMetaTagModelOut>
      <d2p1:BillerId>2</d2p1:BillerId>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:TagLabel>sample string 3</d2p1:TagLabel>
      <d2p1:TagName>sample string 4</d2p1:TagName>
      <d2p1:TagType>TagText</d2p1:TagType>
      <d2p1:TypeOfBulletin>Mav</d2p1:TypeOfBulletin>
    </d2p1:OuterBillerMetaTagModelOut>
  </MetaTags>
  <ProposedTransactionAmount>9.1</ProposedTransactionAmount>
  <Token>sample string 1</Token>
</OuterIdentificationModelOut>