List all payment receipts
curl --request GET \
--url https://api.getlago.com/api/v1/payment_receipts \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.getlago.com/api/v1/payment_receipts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.getlago.com/api/v1/payment_receipts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getlago.com/api/v1/payment_receipts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.getlago.com/api/v1/payment_receipts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.getlago.com/api/v1/payment_receipts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getlago.com/api/v1/payment_receipts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"payment_receipts": [
{
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"created_at": "2022-04-29T08:59:51Z",
"number": "LAG-1234-001-002",
"file_url": "https://getlago.com/payment_receipt/file",
"xml_url": "https://getlago.com/payment_receipt/xml",
"payment": {
"lago_id": "4cf085a7-c196-4f07-a543-97c50ec6e8b2",
"lago_customer_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"external_customer_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"invoice_ids": [
"486b147a-02a1-4ccf-8603-f3541fc25e7a"
],
"invoice_numbers": [
"HOO-202D-005-001"
],
"lago_payable_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"payable_type": "Invoice",
"amount_cents": 1099,
"amount_currency": "USD",
"status": "Completed",
"payment_status": "succeeded",
"type": "manual",
"reference": "ref1",
"payment_provider_code": "stripe_prod",
"payment_provider_type": "stripe",
"external_payment_id": "pi_5eb0285741bc6ba",
"provider_payment_id": "pi_5eb0285741bc6ba",
"provider_customer_id": "cus_5eb0285bcf941bc6ba",
"next_action": {
"type": "redirect_to_url",
"redirect_to_url": {
"url": "https://hooks.stripe.com/3d_secure_2/hosted?merchant=acct_AAA&payment_intent=pi_BBB&payment_intent_client_secret=pi_BBB&publishable_key=pk_test_CCC",
"return_url": "https://app.example.com"
}
},
"created_at": "2025-01-21T00:10:29Z",
"payment_method": {
"lago_id": "4cf085a7-c196-4f07-a543-97c50ec6e8b2",
"is_default": true,
"payment_provider_code": "stripe_prod",
"payment_provider_name": "Stripe",
"payment_provider_type": "stripe",
"provider_method_id": "pm_1N8ZQX2eZvKYlo2CkL9Y8XYZ",
"created_at": "2025-01-21T00:10:29Z"
}
}
}
],
"meta": {
"current_page": 2,
"total_pages": 4,
"total_count": 70,
"next_page": 3,
"prev_page": 1
}
}{
"status": 401,
"error": "Unauthorized"
}{
"status": 422,
"error": "Unprocessable entity",
"code": "validation_errors",
"error_details": {}
}Payment receipts
List all payment receipts
This endpoint is used to list all existing payment receipts.
GET
/
payment_receipts
List all payment receipts
curl --request GET \
--url https://api.getlago.com/api/v1/payment_receipts \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.getlago.com/api/v1/payment_receipts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.getlago.com/api/v1/payment_receipts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getlago.com/api/v1/payment_receipts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.getlago.com/api/v1/payment_receipts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.getlago.com/api/v1/payment_receipts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getlago.com/api/v1/payment_receipts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"payment_receipts": [
{
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"created_at": "2022-04-29T08:59:51Z",
"number": "LAG-1234-001-002",
"file_url": "https://getlago.com/payment_receipt/file",
"xml_url": "https://getlago.com/payment_receipt/xml",
"payment": {
"lago_id": "4cf085a7-c196-4f07-a543-97c50ec6e8b2",
"lago_customer_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"external_customer_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"invoice_ids": [
"486b147a-02a1-4ccf-8603-f3541fc25e7a"
],
"invoice_numbers": [
"HOO-202D-005-001"
],
"lago_payable_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"payable_type": "Invoice",
"amount_cents": 1099,
"amount_currency": "USD",
"status": "Completed",
"payment_status": "succeeded",
"type": "manual",
"reference": "ref1",
"payment_provider_code": "stripe_prod",
"payment_provider_type": "stripe",
"external_payment_id": "pi_5eb0285741bc6ba",
"provider_payment_id": "pi_5eb0285741bc6ba",
"provider_customer_id": "cus_5eb0285bcf941bc6ba",
"next_action": {
"type": "redirect_to_url",
"redirect_to_url": {
"url": "https://hooks.stripe.com/3d_secure_2/hosted?merchant=acct_AAA&payment_intent=pi_BBB&payment_intent_client_secret=pi_BBB&publishable_key=pk_test_CCC",
"return_url": "https://app.example.com"
}
},
"created_at": "2025-01-21T00:10:29Z",
"payment_method": {
"lago_id": "4cf085a7-c196-4f07-a543-97c50ec6e8b2",
"is_default": true,
"payment_provider_code": "stripe_prod",
"payment_provider_name": "Stripe",
"payment_provider_type": "stripe",
"provider_method_id": "pm_1N8ZQX2eZvKYlo2CkL9Y8XYZ",
"created_at": "2025-01-21T00:10:29Z"
}
}
}
],
"meta": {
"current_page": 2,
"total_pages": 4,
"total_count": 70,
"next_page": 3,
"prev_page": 1
}
}{
"status": 401,
"error": "Unauthorized"
}{
"status": 422,
"error": "Unprocessable entity",
"code": "validation_errors",
"error_details": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Page number.
Example:
1
Number of records per page.
Example:
20
Filter payment receipts by invoice. It returns the receipts of the payments made on this invoice, including the payments made through a payment request that covers it.
Example:
"1a901a90-1a90-1a90-1a90-1a901a901a90"