POST api/OuterGatePagoPa/ConfirmTransaction

In caso di verifica della posizione debitoria con esito positivo, permette di confermare il pagamento del PagoPa o del Bollo. Ritorna un esito positivo o uno stato di errore

Request Information

URI Parameters

None.

Body Parameters

The transaction model in.

OuterConfirmPagoPaTransactionModelIn
NameDescriptionTypeAdditional information
CheckVerificationDebtPositionId

Identificativo interno della verifica della posizione debitoria

integer

None.

PosCode

Identificativo del POS dato in dotazione

integer

None.

PaymentType

Modalità di pagamento: Contanti o Carte

PaymentType

Required

CustomData1

Campo personalizzabile

string

None.

CustomData2

Campo personalizzabile

string

None.

CustomData3

Campo personalizzabile

string

None.

IdempotencyKey

Chiave d'idempotenza

string

Max length: 10

Min length: 10

Request Formats

application/json, text/json

Sample:
{
  "CheckVerificationDebtPositionId": 1,
  "PosCode": 1,
  "PaymentType": 0,
  "CustomData1": "sample string 2",
  "CustomData2": "sample string 3",
  "CustomData3": "sample string 4",
  "IdempotencyKey": "sample string 5"
}

application/xml, text/xml

Sample:
<OuterConfirmPagoPaTransactionModelIn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.PagoPa">
  <CheckVerificationDebtPositionId>1</CheckVerificationDebtPositionId>
  <CustomData1>sample string 2</CustomData1>
  <CustomData2>sample string 3</CustomData2>
  <CustomData3>sample string 4</CustomData3>
  <IdempotencyKey>sample string 5</IdempotencyKey>
  <PaymentType>Cash</PaymentType>
  <PosCode>1</PosCode>
</OuterConfirmPagoPaTransactionModelIn>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OuterConfirmPagoPaTransactionModelOut
NameDescriptionTypeAdditional information
CheckVerificationDebtPositionId

Identificativo interno della verifica della posizione debitoria

integer

None.

UniqueKey

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

string

None.

CustomData1

Campo personalizzabile

string

None.

CustomData2

Campo personalizzabile

string

None.

CustomData3

Campo personalizzabile

string

None.

PAIdentifier

Identificativo PA (codice fiscale o partita IVA Ente) da 1 a 16 caratteri

string

None.

ErrorCode

Codice dell'esito dell'operazione, attesta che la Pa ha risposto in maniera positiva (In caso di esito positivo sarà restituito il valore E000001, altrimenti verrà generata un'eccezione)

string

None.

ErrorDescription

Messaggio dell'esito dell'operazione, attesta che la PA ha risposto in maniera positiva (In caso di esito positivo sarà restituito il valore "Esito positivo da parte di EasyChannel", altrimenti verrà generata un'eccezione)

string

None.

Response Formats

application/json, text/json

Sample:
{
  "CheckVerificationDebtPositionId": 1,
  "PagoPaTransactionId": 2,
  "UniqueKey": "sample string 3",
  "CustomData1": "sample string 4",
  "CustomData2": "sample string 5",
  "CustomData3": "sample string 6",
  "PAIdentifier": "sample string 7",
  "ErrorCode": "sample string 8",
  "ErrorDescription": "sample string 9"
}

application/xml, text/xml

Sample:
<OuterConfirmPagoPaTransactionModelOut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tocode.Sepafin.Api.OuterModels.PagoPa">
  <ErrorCode>sample string 8</ErrorCode>
  <ErrorDescription>sample string 9</ErrorDescription>
  <PAIdentifier>sample string 7</PAIdentifier>
  <CheckVerificationDebtPositionId>1</CheckVerificationDebtPositionId>
  <CustomData1>sample string 4</CustomData1>
  <CustomData2>sample string 5</CustomData2>
  <CustomData3>sample string 6</CustomData3>
  <PagoPaTransactionId>2</PagoPaTransactionId>
  <UniqueKey>sample string 3</UniqueKey>
</OuterConfirmPagoPaTransactionModelOut>