
Integra e innova i tuoi pagamenti
Abbiamo strumenti pensati per gli sviluppatori ed integrazioni pronte all’uso.
Le API (acronimo di Application Programming Interface) di Paycloud.it consentono ai tuoi prodotti o servizi di comunicare direttamente con il Prestatore Servizi di Pagamento (PSP), semplificando così lo sviluppo delle tue applicazioni e ottenendo un netto risparmio di tempo e denaro.
Le API offrono flessibilità, semplificano la progettazione, l’amministrazione e garantiscono opportunità di innovazione.
Pagamenti
Abilita i canali di pagamento nella tua applicazione web o mobile.
1. Introduzione
La documentazione tecnica che trovi qui e nelle sezioni successive, descrive come interfacciarsi con Paycloud.it in un ambiente di test e di produzione.
Questo documento presuppone che il lettore abbia familiarità con i servizi web e comprenda termini come HTTP, GET, POST, WSDL, JSON, SOAP, … (vedi Glossario)
I webservices descritti in questo documento sono in fase beta e potranno essere modificati durante lo sviluppo.
I webservices sono ospitati in server fisici geolocalizzati tra la Germania e la Finlandia.
Sistemi Operativi: Windows Server 2019
Server Web: IIS
Tecnologia: .NET Framework
Linguaggio: C#
I pagamenti verranno effettuati con delle coordinate bancarie fittizie auto generate.
Il codice OTP da fornire per la validazione è: 0000.
I parametri data dovranno essere rappresentati in (yyyy/mm/dd)
Attualmente i webservices sono disponibili in SOAP; per le versioni REST e per qualsiasi domanda/approfondimento scrivi a api@paycloud.it.
2. API SOAP
2.1 – PayPerLink Creator
Webservice per la creazione di link di pagamento. I metodi presenti in questo webservice generano i link di pagamento, il QR-Code da apporre ai documenti ed inviano una comunicazione tramite e-mail con il link generato.
Tutti i link punteranno ad una pagina di test che permetterà di completare il pagamento tramite l’inserimento di coordinate bancarie preimpostate, utili per la simulazione di transazioni completate ed in errore.
Il codice OTP da fornire per la validazione è: 0000.
2.1.1 – GenerateLink
Webservice URL: http://test.paycloud.it/Payments/WebServices/Payperlink.asmx
Metodo: GenerateLink
Descrizione
Questo metodo genera il link di pagamento e restituisce il link generato ed il QR-Code da apporre ai documenti.
Nessun messaggio verrà spedito in questo metodo.
Parametri
- ApiKey (OBBLIGATORIO): chiave d’accesso.
- Req (OBBLIGATORIO): oggetto PayPerLinkRequest contenente la richiesta (Vedi Appendice A).
- Params: oggetto OptionalParameters contenente gli eventuali parametri opzionali (Vedi Appendice A)
Risposta
Questo metodo restituisce un oggetto PayPerLinkResult (Vedi Appendice A).
Il parametro Success (booleano) indentifica il risultato della chiamata.
In caso d’errore Il parametro ErrorCode ne conterrà il relativo codice (Vedi Appendice B), mentre il parametro Description la sua descrizione.
2.1.2 – GenerateAndSendLink
Webservice URL: http://test.paycloud.it/Payments/WebServices/Payperlink.asmx
Metodo: GenerateAndSendLink
Descrizione
Questo metodo genera il link di pagamento invia una e-mail al Debitore e restituisce il link generato.
Nessun QR Code verrà restituito in questo metodo.
Parametri
- ApiKey (OBBLIGATORIO): chiave d’accesso.
- Req (OBBLIGATORIO): oggetto PayPerLinkRequest contenente la richiesta (Vedi Appendice A).
- Options (OBBLIGATORIO): oggetto PayPerLinkDeliveryOptions contenente la tipologia del messaggio da inviare (Email / SMS). Se i parametri specifici per ogni tipologia non verranno valorizzati saranno utilizzati quelli di default. (Vedi Appendice A).
- Params: oggetto OptionalParameters contenente gli eventuali parametri opzionali (Vedi Appendice A)
Risposta
Questo metodo restituisce un oggetto PayPerLinkResult (Vedi Appendice A).
Il parametro Success (booleano) indentifica il risultato della chiamata, e per questo metodo anche il risultato dell’invio dell’email.
In caso d’errore Il parametro ErrorCode ne conterrà il relativo codice (Vedi Appendice B), mentre il parametro Description la sua descrizione.
Per questo metodo il parametro relativo al QR-Code sarà null.
3. API REST
3.1 – PayperLink
API per la creazione di Link di Pagamento.
Questo metodo genera il link di pagamento, il QR-Code da appore ai documenti e può inviare una comunicazione tramite e-mail con il link generato.
Tutti i link punteranno ad una pagina di test che permetterà di completare il pagamento tramite l’inserimento di coordinate bancarie preimpostate, utili per la simulazione di transazioni completate ed in errore.
Il codice OTP da fornire per la validazione è: 0000.
3.1.1 – GenerateLink
URL: https://test.paycloud.it/Payments/API/PayPerLink.svc
Action: GenerateLink
Payload Type: JSON
Descrizione
Questo metodo genera il link di pagamento, restituisce il link generato ed il QR-Code da apporre ai documenti e se specificato invia una e-mail al debitore con il link di pagamento.
Richiesta JSON
Si deve creare un JSON con i parametri descritti nella sezione Webservice (2.1).
Esempio:
{
“Request”: {
“Type”: 1,
“ProductName”: “Test 1”,
“Amount”: 5000.0,
“Language”: 1,
“Debitor”: {
“ID”: 0,
“FatherID”: 0,
“ChildID”: 0,
“Code”: “xyz”,
“FirstName”: “prova 2”,
“LastName”: “prova 2”,
“Email”: “info@paycloud.it”,
“Address”: “Via Pasubio 5”,
“City”: “Dalmine”,
“Province”: “BG”,
“ZipCode”: “24044”,
“Country”: “Italia”,
“FiscalCode”: “MRIRSS82L07B157U”,
“TaxNumber”: “”,
“Phone”: “1111111111”,
“IBAN”: null,
“CreationDate”: “\/Date(1590073631842+0200)\/”
},
“OriginUrl”: “https://www.paycloud.it”,
“Date”: “21/05/2020 17:07:09”,
“LinkValidityFrom”: “21/05/2020 17:07:12”,
“LinkValidityTo”: “22/05/2020 17:07:12”,
“Reason”: “scadenza test 1”
},
“DeliveryOptions”: null,
“Parameters”: null
}
Per inviare un messaggio e-mail è necessario valorizzare il parametro DeliveryOptions (sezione Webservice 2.1).
Esempio:
“DeliveryOptions”: {
“DeliveryWith”: 1,
“EMail”: {
“ParamFrom”: “info@paycloud.it”,
“FromName”: “Mario”,
“Subject”: “oggetto “,
“HtmlTEmplate”: “corpo email con placeholder come descritto nella sezione Webservices [[[LINK]]”
}
}
Il payload del messaggio va incluso in un JSON contenitore e codificato in Base 64 con la seguente struttura:
{ “ApiKey” : “[APIKEY]”, “Req” : “[REQ]” }
Parametri
- [APIKEY] (OBBLIGATORIO): chiave d’accesso.
- [REQ] (OBBLIGATORIO): Payload codificato in Base64.
Risposta JSON
La risposta è rappresentata con il JSON seguente (esempio):
{
“GenerateLinkResult”: {
“Description”: “Processing ok”,
“ErrorCode”: null,
“Success”: true,
“Link”: “link di pagamento”,
“QrCode”: [
/* .. byte[] … */
],
“TransactionCode”: “c8FdP”
}
}
3.2 – Report
API per la ricezione degli esiti di Pagamento utili per la riconciliazione automatica.
I metodi presenti in questa API restituiscono gli esiti di pagamento.
In caso di più tentativi verrà restituito lo storico contente tutte le transazioni effettuate, sia quelle in errore che quella andata a buon fine.
La chiave per recuperare gli esiti è il codice restituito dai metodi di generazione link (Vedi Sezione PayPerLink)
3.2.1 – GetPayPerLinkReport
URL: https://test.paycloud.it/Payments/API/Reports.svc
Action: GetPayPerLinkReport
Payload Type: JSON
Descrizione
Questo metodo recupera lo stato delle transazioni tramite il loro codice e ne restituisce gli esiti per la riconciliazione.
Richiesta JSON
Si deve creare un JSON con i parametri descritti nella sezione Webservice (2.2)
Esempio:
[
“8rWEj” // codice PayPerLink
]
Il payload del messaggio va incluso in un JSON contenitore e codificato in Base 64 con la seguente struttura:
{ “ApiKey” : “[APIKEY]”, “Req” : “[REQ]” }
Parametri
- [APIKEY] (OBBLIGATORIO): chiave d’accesso.
- [REQ] (OBBLIGATORIO): Payload codificato in Base64.
Risposta
La risposta è rappresentata con il JSON seguente:
{
“Links”: [
{
“Code”: “vJ4Wj”,
“CustomerCode”: “xyz”,
“CreationDate”: “07/05/2020 15:52:18”,
“LinkStatus”: 30,
“ValidUntil”: “08/05/2020 15:52:18”,
“IsSepa”: false,
“SepaTransactions”: [],
“CcTransactions”: [
{
“SyncResponseID”: “53c703ca-778c-4b9a-bf49-5ff0c9359f6e”,
“TransactionRef”: “1588859561HOM-530-730249”,
“Result”: “OK – Payment accepted”,
“ResultCode”: “200”,
“Status”: 30,
“Amount”: 6.000,
“CardTruncateNumber”: “100000XXXXXX2004”,
“CardType”: “CB”,
“TransactionDate”: “07/05/2020”,
“CreationDate”: “07/05/2020 16:17:04”
}
]
}
],
“Success”: true,
“Description”: “OK”,
“ErrorCode”: null
}
3.2.2 – GetPayPerLinkReportCSV
URL: https://test.paycloud.it/Payments/API/Reports.svc
Action: GetPayPerLinkReportCSV
Payload Type: JSON
Descrizione
Questo metodo recupera lo stato delle transazioni tramite il loro codice e ne restituisce gli esiti in un file CSV per la riconciliazione.
Richiesta JSON
Si deve creare un JSON con i parametri descritti nella sezione Webservice (2.2)
[
“8rWEj” // codice PayPerLink
]
Il payload del messaggio va incluso in un JSON contenitore e codificato in Base 64 con la seguente struttura:
{ “ApiKey” : “[APIKEY]”, “Req” : “[REQ]” }
Parametri
[APIKEY] (OBBLIGATORIO): chiave d’accesso.
[REQ] (OBBLIGATORIO): Payload codificato in Base64.
Risposta
La risposta è rappresentata con il JSON seguente:
{
“CSV”: [
/* byte[] CSV nel formato descritto nella sezione Webservices 2.2*/
],
“Success”: true,
“Description”: “OK”,
“ErrorCode”: null
}
4. Personalizzazione
Durante il set-up dell’utente si possono definire diverse personalizzazioni relative a:
- Callback: si possono definire custom callback.
- E-mail Callback: si può definire il corpo del messaggio secondo le esigenze.
- Pagine esito pagamento: le pagine che portano il debitore all’esito finale del pagamento possono essere brandizzate secondo le esigenze.
- E-mail d’invio richiesta di pagamento: le e-mail che avvisano l’utente della richiesta di pagamento possono essere brandizzate secondo le esigenze. In particolare:
– Durante la chiamata webservice è possibile inviare un template custom.
– Si può anche definire un template standard per l’utente in modo da non doverlo sempre inviare tramite Webservices. - Listino Prezzi: è possibile concordare un listino prezzi personalizzato.
Riconciliazione
Automatizza il controllo puntuale di quanto incassato.
1. Introduzione
Differenti strumenti per riconciliare i flussi:
- Archivio Web: archivio delle transazioni con download file CBI, CSV e TXT
- Webservice: creazione documento JSON, CBI e CSV
- SFTP: protocollo di trasferimento file, utile per trasferire dati sensibili in maniera sicura dalla nostra piattaforma al gestionale del Cliente
Per qualsiasi domanda/approfondimento scrivi a api@paycloud.it.
2. Reports
Webservice per la ricezione degli esiti di Pagamento utili per la riconciliazione automatica.
I metodi presenti in questo Webservice restituiscono gli esiti di pagamento.
In caso di più tentativi verrà restituito lo storico contente tutte le transazioni effettuate, sia quelle in errore che quella andata a buon fine.
La chiave per recuperare gli esiti è il codice restituito dai metodi di generazione link (Vedi Sezione PayPerLink).
2.1 – GetPayPerLinkReport
Webservice URL: http://test.paycloud.it/Payments/WebServices/Reports.asmx
Metodo: GetPayPerLinkReport
Descrizione
Questo metodo recupera lo stato delle transazioni tramite il loro codice e ne restituisce gli esiti per la riconciliazione.
Parametri
- ApiKey (OBBLIGATORIO): chiave d’accesso.
- Codes (OBBLIGATORIO): array di stringhe contenente i codici dei link da ricercare.
Risposta
Questo metodo restituisce un oggetto PayPerLinkReportResult (Vedi Appendice A).
Il parametro Success (booleano) indentifica il risultato della chiamata.
In caso d’errore Il parametro ErrorCode ne conterrà il relativo codice (Vedi Appendice B), mentre il parametro Description la sua descrizione.
2.2 – GetPayPerLinkReportCSV
Webservice URL: http://test.paycloud.it/Payments/WebServices/Reports.asmx
Metodo: GetPayPerLinkReportCSV
Descrizione
Questo metodo recupera lo stato delle transazioni tramite il loro codice e ne restituisce gli esiti in un file CSV per la riconciliazione.
Parametri
- ApiKey (OBBLIGATORIO): chiave d’accesso.
- Codes (OBBLIGATORIO): array di stringhe contenente i codici dei link da ricercare.
Risposta
Questo metodo restituisce un oggetto PayPerLinkCSVReportResult (Vedi Appendice A).
Il parametro Success (booleano) indentifica il risultato della chiamata.
In caso d’errore Il parametro ErrorCode ne conterrà il relativo codice (Vedi Appendice B), mentre il parametro Description la sua descrizione.
3. Callback
PayCloud.it mette a disposizione una callback per l’inoltro in tempo reale delle notifiche di avvenuto pagamento o errore.
La callback si inserisce alla fine del processo di pagamento da parte del debitore, e precisamente prima che lo stesso sia reindirizzato alle pagine di completamento del pagamento (Vedi Personalizzazione).
3.1 – Metodologie
La callback può essere inviata tramite:
- POST
- GET
- REST (JSON)
- EMAIL (Vedi Personalizzazione)
3.2 – Richiesta
Per le metodologie di callback che richiedono una comunicazione tramite HTTP la richiesta avviene con il JSON seguente:
{
“TransactionType”:””,
“TransactionCode”:””,
“Status”:,
“StatusDescription”:””
}
Esempio chiamata relativa ad un pagamento con Carta di Credito:
{
“TransactionType”:”D”,
“TransactionCode”:”wIxD6″,
“Status”:60,
“StatusDescription”:”Payed”
}
Parametri
- TransactionType: oggetto PaymentType (vedi Appendice A)
- TransactionCode: codice PayperLink restituito dal webservice.
- Status: valore oggetto PaymentStatus (vedi Appendice A).
- StatusDescription: nome oggetto PaymentStatus (vedi Appendice A).
3.3 – Risposta
Per le metodologie di callback che richiedono una comunicazione tramite HTTP la risposta deve avvenire con il JSON seguente:
{
“Result”:””
}
Parametri
- Result: OK o KO seguito dal messaggio d’errore.
Appendice
Oggetti complessi e parametri dell’infrastruttura.
1. Introduzione
In questa sezione vengono descritti gli oggetti complessi (classi, enum, struct) utilizzati come parametri dall’infrastruttura Paycloud.it
Per qualsiasi domanda/approfondimento scrivi a api@paycloud.it.
2. Appendice A
2.1 -PaymentStatus
Descrizione
Enum contenente gli stati del pagamento.
public enum PaymentStatus
{
None = 0,
Requested = 10,
Open = 20,
Payed = 30,
NotPayed = 40,
Expired = 50,
Error = 999
}
2.2 – PaymentType
Descrizione
Enum contenente le tipologie di pagamento supportate.
public enum PaymentType
{
None,
/// <summary>
/// Immediate CC Debit
/// </summary>
D,
/// <summary>
/// Pre Autorization Payment (check if user can pay)
/// </summary>
PA,
/// <summary>
/// SOISY
/// </summary>
P3F,
/// <summary>
/// Alias Creation
/// </summary>
ALS,
/// <summary>
/// Credit Card Subscription
/// </summary>
SUBD,
/// <summary>
/// Direct Debit Subscription
/// </summary>
SUBS,
/// <summary>
/// Sepa Direct Debit
/// </summary>
SDD,
/// <summary>
/// Sepa Direct Debit Recurring
/// </summary>
SDDR,
}
2.3 – PaymentLanguage
Descrizione
Enum contenente la lingua della pagina di pagamento.
public enum PaymentLanguage
{
None,
/// <summary>
/// Default
/// </summary>
IT,
EN
}
2.4 – DebitUser
Descrizione
Questa classe rappresenta il debitore.
Ogni debitore deve essere identificato da un codice univoco, che verrà utilizzato come chiave.
Ogni debitore, verrà salvato a Database e ne verrà restituito il codice durante la fase si riconciliazione.
Parametri
- Code (OBBLIGATORIO) [string]: codice identificativo univoco.
- FirstName (OBBLIGATORIO) [string]: Nome.
- LastName (OBBLIGATORIO) [string]: Cognome.
- Email (OBBLIGATORIO) [string]: indirizzo email.
- Address (OBBLIGATORIO) [string]: Indirizzo.
- City (OBBLIGATORIO) [string]: Comune.
- Province (OBBLIGATORIO) [string]: Provincia.
- ZipCode (OBBLIGATORIO) [string]: CAP.
- Country (OBBLIGATORIO) [string]: Nazione.
- FiscalCode (OBBLIGATORIO SE TaxNumber NON VALORIZZATO) [string]: Codice Fiscale.
- TaxNumber (OBBLIGATORIO SE FiscalCode NON VALORIZZATO) [string]: Partita Iva.
- Phone (OBBLIGATORIO) [string]: cellulare.
- IBAN [string]: IBAN.
2.5 – PayPerLinkRequest
Descrizione
Questa classe contiene la richiesta di generazione di un Link di Pagamento.
Parametri
- Type (OBBLIGATORIO) [PaymentType]: tipologia di pagamento.
- ProductName (OBBLIGATORIO) [string]: prodotto.
- Amount (OBBLIGATORIO) [double]: importo in centesimi di Euro (ES 1000 = 10 €).
- Language (OBBLIGATORIO) [PaymentLanguage]: localizzazione pagina di pagamento.
- Debitor (OBBLIGATORIO) [DebitUser]: debitore.
- OriginUrl (OBBLIGATORIO) [string]: indirizzo WEB di origine.
- Date (OBBLIGATORIO) [string]: data del pagamento.
- LinkValidityFrom (OBBLIGATORIO) [string]: link valido dal.
- LinkValidityTo (OBBLIGATORIO) [string]: link valido fino a (dopo questa data non si potrà più effettuare il pagamento ed al link verrà assegnato lo stato scaduto).
- Reason (OBBLIGATORIO) [string]: causale di pagamento.
2.6 – OptionalParameters
Descrizione
Parametri opzionali, attualmente non implementati, passare null.
Parametri
- Name (OBBLIGATORIO) [string]: Nome del parametro.
- Value (OBBLIGATORIO) [string]: Valore del parametro.
2.7 – EmailMessage
Descrizione
Questa classe descrive il messaggio e-mail da inviare al debitore.
Il testo del messaggio deve contenere il placeholder [[LINK]] al quale verrà sostituito il link di pagamento.
Parametri
- ParamFrom (OBBLIGATORIO) [string]: indirizzo e-mail mittente.
- FromName (OBBLIGATORIO) [string]: Nome mittente.
- Subject (OBBLIGATORIO) [string]: Oggetto messaggio.
- HtmlTemplate (OBBLIGATORIO) [string]: corpo del messaggio.
2.8 – DeliveryMethod
Descrizione
Enum contenente i metodi d’invio.
public enum DeliveryMethod
{
None,
//SMS, PEC, LETTER
}
2.9 – PayPerLinkDeliveryOptions
Descrizione
Questa classe contiene le opzioni per l’invio del messaggio contenente il link.
Attualmente è disponibile solo l’invio tramite e-mail valorizzando la classe EmailMessage.
Se la classe EmailMessage viene valorizzata con il valore null verranno recuperati i valori di default relativi all’applicazione o all’utente (in caso di customizzazione).
Parametri
- DeliveryWith (OBBLIGATORIO) [DeliveryMethod]: metodo d’invio.
- EMail (OBBLIGATORIO) [EmailMessage]: opzioni relative al messaggio e-mail.
2.10 – StdResult
Descrizione
Questa classe rappresenta il valore di ritorno standard.
Tutti gli altri valori di ritorno ereditano da questa classe.
Parametri
- Success (OBBLIGATORIO) [bool]: in caso di errore viene valorizzato a false.
- Description (OBBLIGATORIO) [string]: OK se succes == true, altrimenti contiene la descrizione dell’errore.
- ErrorCode (OBBLIGATORIO) [string]: codice d’errore.
2.11 – PayPerLinkResults
Descrizione
Questa classe rappresenta il valore di ritorno dei metodi relativi alla generazione dei link di pagamento.
Eredita da StdResult.
Parametri
- TransactionCode (OBBLIGATORIO) [string]: codice della transazione, da utilizzare per la riconciliazione.
- Link (OBBLIGATORIO) [string]: Link di pagamento.
- QrCode (OBBLIGATORIO) [byte[]]: se presente contiene il byte[] in formato PNG del QR-CODE.
2.12 – SepaReportResult
Descrizione
Questa classe contiene lo stato di una transazione SEPA.
Parametri
- SyncResponseID (OBBLIGATORIO) [string]: codice risposta.
- TransactionRef (OBBLIGATORIO) [string]: codice transazione.
- Result (OBBLIGATORIO) [string]: risultato transazione.
- ResultCode (OBBLIGATORIO) [string]: codice di stato transazione.
- Status (OBBLIGATORIO) [PaymentStatus]: stato della transazione.
- Label (OBBLIGATORIO) [string]: causale.
- Amount (OBBLIGATORIO) [string]: importo in centesimi di Euro (ES 1000 = 10 €).
- Rum (OBBLIGATORIO [string]): RUM (utilizzato per il SEPA ricorrente).
- IBAN (OBBLIGATORIO) [string]: IBAN.
- BIC (OBBLIGATORIO) [string]: BIC.
- TransactionDate (OBBLIGATORIO) [string]: data della transazione.
- CreationDate (OBBLIGATORIO) [string]: data creazione della transazione.
2.13 – CreditCardReportResult
Descrizione
Questa classe contiene lo stato di una transazione non SEPA.
Parametri
- SyncResponseID (OBBLIGATORIO) [string]: codice risposta.
- TransactionRef (OBBLIGATORIO) [string]: codice transazione.
- Result (OBBLIGATORIO) [string]: risultato transazione.
- ResultCode (OBBLIGATORIO) [string]: codice di stato transazione.
- Status (OBBLIGATORIO) [PaymentStatus]: stato della transazione.
- Amount (OBBLIGATORIO) [string]: importo in centesimi di Euro (ES 1000 = 10 €).
- CardTruncateNumber (OBBLIGATORIO [string]): codice carta offuscato.
- CardType (OBBLIGATORIO) [string]: Tipo Carta.
- TransactionDate (OBBLIGATORIO) [string]: data della transazione.
- CreationDate (OBBLIGATORIO) [string]: data creazione della transazione.
2.14 – PayPerLinkReport
Descrizione
Questa classe contiene lo stato di una transazione generata tramite link.
Parametri
- Code (OBBLIGATORIO) [string]: codice risposta fornito dal webservice di creazione.
- CustomerCode (OBBLIGATORIO) [string]: codice debitore associato.
- CreationDate (OBBLIGATORIO) [string]: data di creazione della transazione.
- Status (OBBLIGATORIO) [PaymentStatus]: stato della transazione.
- ValidUntil (OBBLIGATORIO) [string]: ultima data utile per il pagamento, oltre la quale il link passerò in stato scaduto.
- IsSepa (OBBLIGATORIO) [string]: indica se la transazione è sepa (Serve per capire quale array deve essere analizzato).
- SepaTransactions (OBBLIGATORIO) [SepaReportResult[]]: array contenente le transazioni SEPA.
- CcTransactions (OBBLIGATORIO) [CreditCardReportResult[]]: array contenente le transazioni non SEPA.
2.15 – PayPerLinkReportResult
Descrizione
Questa classe rappresenta il valore di ritorno dei metodi relativi alla riconciliazione.
Eredita da StdResult.
Parametri
- Links (OBBLIGATORIO) [PayPerLinkReport[]]: array contenete le transazioni.
2.16 – PayPerLinkCSVReportResult
Descrizione
Questa classe rappresenta il valore di ritorno dei metodi relativi alla riconciliazione.
Eredita da StdResult.
Parametri
- CSV (OBBLIGATORIO) [byte[]]:contiene il byte[] del CSV.
Note
Il CSV contiene li stessi parametri dell’oggetto PayPerLinkReport.
L’header è così composto:
- Link Code
- Customer Code
- Creation Date
- Link Status
- Valid Until
- Is Sepa
- Sync Response ID
- Transaction Ref
- Result
- Result Code
- Payment Status
- Label
- Amount
- Rum
- IBAN
- BIC
- Card Truncated Number
- Card Type
- Transaction Date
- CreationDate
3. Appendice B
In questa sezione vengono riportati i codici d’errore utilizzati.
Tutti i codici vengono forniti con la relativa descrizione, parametro Description della classe StdResult dalla quale derivano tutte le classi Result di PayCloud.it.
- 101: Errore generico
- 280: Login fallito, accesso non autorizzato
- 201: Errore durante la validazione della richiesta
eCommerce
Sono disponibili i connettori ai più diffusi Content Management System.
1. Prestashop Extension
2. WooCommerce Extension
3. Magento Extension
4. Drupal Commerce Extension
5. Hika Shop Extension
Comunicazione
Abilita invio, ricezione e monitoraggio di link e documenti attraverso vari canali
1. Introduzione
I Web Services eMessage (comunicazione/efattura/conservazione sostitutiva) sono:
- Auto-descrittivi attraverso i documenti WSDL
- Comunicanti con i clients tramite SOAP via HTTP/HTTPS
eMessage pubblica le proprie API in un formato XML denominato Web Service Definition Language (WSDL).
2. Lettere
Il servizio di invio lettere (posta ibrida) consente di inviare documenti attraverso le seguenti modalità:
– Prioritaria
– Raccomandata semplice e con ricevuta di ritorno
– Massiva
I vettori di recapito sono:
– Poste Italiane
– Sailpost
– Fulmine Recapiti
– Web Service URL: https://ct.emessage.it/webservices/WSLetters.asmx
3. SMS
Invia messaggi di testo a uno o più dispositivi mobili e personalizza ogni SMS con campi variabili.
– Alta Qualità: solo con operatori italiani
– Notifica di avvenuta ricezione
– Consegna garantita al terminale mobile entro pochi secondi
– Concatenati: oltre il limite di 160 caratteri (max 2.000)
– Personalizzazione mittente: testo alfanumerico fino a 11 caratteri
– Copertura internazionale: 147 Paesi
– SMS https://ct.emessage.it/webservices/WSSms.asmx
4. Email
Potrai inviare email puntuali e massive e visualizzare le statistiche in tempo reale.
– Personalizza il mittente nella sezione “Gestione del mittente”.
– Campi personalizzati: imposta i campi variabili in modo da poter caricare dati specifici per i tuoi destinatari.
– Modelli: gestione template in HTML
– Traking & Tracing: monitora tutti le fasi di invio, consegna e notifica
– Report:blocchi / bounces / spam
5. tNotice
Invia una raccomandata elettronica a qualsiasi indirizzo email. Allega i documenti, ricevi immediatamente il certificato postale forense.
– Web Service URL: https://ct.emessage.it/Webservices/WSRegisteredEmail.asmx
6. Fattura elettronica
Il servizio di invio e ricezione di fatture elettroniche tra aziende, privati e verso la Pubblica Amministrazione.
Gestisci le e-fatture anche in modalità multicanale (email ed sms).
Web Service URL: https://ct.emessage.it/WebServices/WSEInvoice.asmx
7. Reports
Esiti di invio, tracking & tracing con aggiornamenti di stato in tempo reale.
– Web Service URL: https://ct.emessage.it/webservices/WSReports.asmx
8. Contatti
Gestione Rubriche
– Web Service URL: https://ct.emessage.it/webservice/WSContactFolders.asmx
Gestione anagrafiche
– Web Service URL: https://ct.emessage.it/webservices/WSContacts.asmx
9. Condomini
Gestione di anagrafiche per software house e system integrator che operano nel settore dell’amministrazione condominiale.
– Web Service URL: https://ct.emessage.it/webservice/WSCondominiums.asmx
10. Multilivello
Per aziende con più sedi, uffici periferici e dipartimenti. Distribuzione budget e crediti per centri di costo.
– Web Service URL: https://ct.emessage.it/webservices/WSGroups.asmx
11. Conservazione sostitutiva
Conserva tutti i tuoi documenti che transitano con un click, senza stampare alcun foglio e a norma di legge.
– Web Service URL: https://ct.emessage.it/WebServices/WSELCA.asmx
12. Crediti/Listini prezzi
Tutti i servizi di comunicazione / efattura / conservazione sostitutiva sono servizi a consumo e vengono scalati dal credito caricato sul proprio account.
Il business model standard è attraverso ricarica prepagata. Per altre modalità, contatta il commerciale di Paycloud.it.
Listino prezzi
– Web Service URL: https://ct.emessage.it/webservices/WSPrice.asmx
Gestione crediti
– Web Service URL: https://ct.emessage.it/webservices/WSPurchases.asmx