# Elenco pagamenti Ritorna l'elenco dei pagamenti registrati, con il numero totale dei record restituiti. Ogni voce contiene i dati del pagamento: tipo (rata di dilazione, rata di abbonamento o pagamento in unica soluzione), importo, numero della rata, stato e riferimenti a cliente ed esercente. L'identificativo `_id` di ogni voce si usa con l'endpoint [Dettaglio pagamento](/riferimento-api/pagamenti/dettaglio-pagamento). ## Richiesta Http ```bash GET https://api.jatapay.it/pagamenti ``` ## Parametri di query Nessun parametro è obbligatorio. I risultati si filtrano passando il nome del campo come parametro di query (`campo=valore`); i filtri presenti vengono applicati in combinazione tra loro. | Parametro | Richiesto | Tipo | Descrizione | | -------------- | -------------- | -------------- |-------------- | | page | No | integer | Numero della pagina dei risultati, a partire da 0 | | limit | No | integer | Numero di risultati restituiti per pagina | | sort | No | string | Nome di uno dei campi filtrabili su cui ordinare i risultati | | dir | No | string | Direzione dell'ordinamento applicata a `sort` (ad esempio `asc` o `desc`) | ### Campi filtrabili Ogni campo del pagamento è anche un parametro di filtro e può essere usato in `sort`; il valore va indicato nello stesso formato restituito dalla risposta. | Campo | Tipo | Descrizione | Esempio | | -------------- | -------------- | -------------- | -------------- | | _id | string | Identificativo del pagamento | `_id=6ae07f601d7bc659f6125dcc` | | tipo | string | `rata_dilazione`, `rata_abbonamento` o `pagamento` | `tipo=rata_dilazione` | | importo | integer | Importo del pagamento, in centesimi di euro | `importo=33333` | | dilazione | string | Dilazione di appartenenza (collection `dilazioni`); per le rate di abbonamento si usa `abbonamento` | `dilazione=6ae07f601d7bc659f6125dc0` | | abbonamento | string | Abbonamento di appartenenza (collection `subscriptions`), alternativo a `dilazione` | `abbonamento=6ad9de671d7bc659f6125dac` | | numero | integer | Numero della rata | `numero=12` | | numero_txt | string | Numero della rata in formato testuale | `numero_txt=12` | | totale_rate | integer | Numero totale delle rate della pratica | `totale_rate=12` | | data_pagamento | string | Data del pagamento (`AAAA-MM-GG` o `AAAA-MM-GGThh:mm`), vuota se non ancora pagato | `data_pagamento=` | | stato | string | Stato del pagamento (ad esempio `unpaid`) | `stato=unpaid` | | fee | object | Dati delle commissioni applicate | — | | stripe | object | Dati del gateway Stripe | — | | credit_management | object | Gestione del credito: `rating` (integer) | — | | payment_method | string | Metodo di pagamento: `sdd` o `card` | `payment_method=card` | | vendor | string | Gateway di pagamento utilizzato | `vendor=stripe` | | no_billing | boolean | Esclude il pagamento dalla fatturazione | `no_billing=true` | | client | string | Client applicativo che ha generato il pagamento | `client=JataPay` | | cliente | string | Identificativo del cliente (collection `clienti`) | `cliente=6a218ca738c301f9262b9017` | | esercente | string | Identificativo dell'esercente (collection `esercenti`) | `esercente=6a55ecdfb180394de3e29aa5` | | note | string | Note del pagamento | `note=` | | data_fallimento | string | Data dell'ultimo tentativo fallito (`AAAA-MM-GG` o `AAAA-MM-GGThh:mm`) | `data_fallimento=` | | tentativo_pagamento | integer | Numero di tentativi di pagamento effettuati | `tentativo_pagamento=0` | | data_controllo | string | Data del prossimo controllo del pagamento (`AAAA-MM-GG` o `AAAA-MM-GGThh:mm`) | `data_controllo=2027-09-01T03:00` | | prossimo_tentativo | string | Data del prossimo tentativo di addebito (`AAAA-MM-GG` o `AAAA-MM-GGThh:mm`) | `prossimo_tentativo=2027-09-01T03:00` | | base | integer | Importo base del pagamento, in centesimi di euro | `base=33333` | | data_inserimento | string | Data di inserimento del pagamento (`AAAA-MM-GG` o `AAAA-MM-GGThh:mm`) | `data_inserimento=2026-10-27T10:39` | ### Esempio di ricerca ```bash GET https://api.jatapay.it/pagamenti?page=0&limit=25&sort=data_pagamento&dir=desc&tipo=rata_dilazione ``` **shell** ```bash curl -X GET "https://api.jatapay.it/pagamenti" \ -H "Authorization: Bearer IL_TOKEN_DI_ACCESSO" ``` **PHP** ```php $token = 'IL_TOKEN_DI_ACCESSO'; $url = curl_init("https://api.jatapay.it/pagamenti"); $authorization = "Authorization: Bearer ".$token; curl_setopt($url, CURLOPT_CUSTOMREQUEST, "GET"); curl_setopt($url, CURLOPT_RETURNTRANSFER, true); curl_setopt($url, CURLOPT_HTTPHEADER, array( $authorization )); $result = curl_exec($url); curl_close($url); $api_response = json_decode($result); ``` **Python** ```python import requests token = "IL_TOKEN_DI_ACCESSO" headers = { "Authorization": "Bearer " + token } response = requests.get("https://api.jatapay.it/pagamenti", headers=headers) print(response.status_code) print(response.json()) ``` **Node.js** ```javascript const token = 'IL_TOKEN_DI_ACCESSO'; const response = await fetch('https://api.jatapay.it/pagamenti', { method: 'GET', headers: { 'Authorization': `Bearer ${token}` } }); console.log(response.status, await response.json()); ``` **Go** ```go package main import ( "fmt" "io" "net/http" ) func main() { const token = "IL_TOKEN_DI_ACCESSO" req, err := http.NewRequest("GET", "https://api.jatapay.it/pagamenti", nil) if err != nil { panic(err) } req.Header.Set("Authorization", "Bearer "+token) res, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer res.Body.Close() data, err := io.ReadAll(res.Body) if err != nil { panic(err) } fmt.Println(res.StatusCode, string(data)) } ``` **.NET** ```csharp using System; using System.Net.Http; using System.Net.Http.Headers; using System.Threading.Tasks; class Program { static async Task Main() { const string token = "IL_TOKEN_DI_ACCESSO"; using var client = new HttpClient(); client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token); var response = await client.GetAsync("https://api.jatapay.it/pagamenti"); Console.WriteLine((int)response.StatusCode); Console.WriteLine(await response.Content.ReadAsStringAsync()); } } ``` **Java** ```java import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; public class Main { public static void main(String[] args) throws Exception { String token = "IL_TOKEN_DI_ACCESSO"; HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.jatapay.it/pagamenti")) .header("Authorization", "Bearer " + token) .GET() .build(); HttpResponse response = HttpClient.newHttpClient() .send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.statusCode()); System.out.println(response.body()); } } ``` ## Risposta La risposta contiene `data`, l'array dei pagamenti della pagina richiesta con lo schema `Pagamento`, e `count` con il numero di record. Ogni voce contiene tutti i campi del modello dati, gli stessi documentati in *Campi filtrabili*. ```json { "data": [ { "_id": "6ae07f601d7bc659f6125dcc", "tipo": "rata_dilazione", "importo": 33333, "dilazione": "6ae07f601d7bc659f6125dc0", "numero": 12, "numero_txt": "12", "totale_rate": 12, "data_pagamento": "", "stato": "unpaid", "fee": {}, "stripe": {}, "credit_management": { "rating": 0 }, "payment_method": "card", "vendor": "stripe", "no_billing": true, "client": "JataPay", "cliente": "6a218ca738c301f9262b9017", "esercente": "6a55ecdfb180394de3e29aa5", "note": "", "data_fallimento": "", "tentativo_pagamento": 0, "data_controllo": "2027-09-01T03:00", "prossimo_tentativo": "2027-09-01T03:00", "base": 33333, "data_inserimento": "2026-10-27T10:39" } ], "count": 1 } ``` ## Errori | Codice | Descrizione | | -------------- | -------------- | | 400 | Richiesta non valida, parametri mancanti o non coerenti | | 401 | Token mancante, scaduto o non valido | | 403 | Ruolo non abilitato all'operazione | | 500 | Errore interno del server | Il corpo della risposta di errore contiene sempre `error_code` (il codice simbolico dell'errore, ad esempio `bad_request`, oppure il codice HTTP corrispondente) e `error_message` con il messaggio descrittivo: ```json { "error_code": "bad_request", "error_message": "Messaggio di errore" } ``` :::warning La richiesta deve avere l'header `Authorization: Bearer ` e, quando è presente un corpo, l'header `Content-Type: application/json`. :::