Get Payments
curl --request POST \
--url https://demo.usebreezee.xyz/api/v1/breezee/payments \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"filter": "SENT"
}
'import requests
url = "https://demo.usebreezee.xyz/api/v1/breezee/payments"
payload = { "filter": "SENT" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({filter: 'SENT'})
};
fetch('https://demo.usebreezee.xyz/api/v1/breezee/payments', 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://demo.usebreezee.xyz/api/v1/breezee/payments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filter' => 'SENT'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://demo.usebreezee.xyz/api/v1/breezee/payments"
payload := strings.NewReader("{\n \"filter\": \"SENT\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://demo.usebreezee.xyz/api/v1/breezee/payments")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": \"SENT\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://demo.usebreezee.xyz/api/v1/breezee/payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": \"SENT\"\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Infra Reference
List Payments
POST
/
api
/
v1
/
breezee
/
payments
Get Payments
curl --request POST \
--url https://demo.usebreezee.xyz/api/v1/breezee/payments \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"filter": "SENT"
}
'import requests
url = "https://demo.usebreezee.xyz/api/v1/breezee/payments"
payload = { "filter": "SENT" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({filter: 'SENT'})
};
fetch('https://demo.usebreezee.xyz/api/v1/breezee/payments', 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://demo.usebreezee.xyz/api/v1/breezee/payments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filter' => 'SENT'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://demo.usebreezee.xyz/api/v1/breezee/payments"
payload := strings.NewReader("{\n \"filter\": \"SENT\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://demo.usebreezee.xyz/api/v1/breezee/payments")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": \"SENT\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://demo.usebreezee.xyz/api/v1/breezee/payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": \"SENT\"\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}This endpoint retrieves a list of payments made on the instance.
Request Body
string
default:"SENT"
Filter payments by type. Options:
SENT, RECEIVED.Response
The response contains a list of payment objects.200: Success
{
"status": true,
"payments": [
{
"id": "...",
"payment_type": 0,
"status": 0,
"amount_msat": 10000,
"fee_msat": 10,
"timestamp": 1629345600,
"details": {
"type": "bolt11",
"invoice": "..."
}
}
]
}
422: Validation Error
Standard validation error if the request body is invalid.⌘I
