Read one payment
curl --request GET \
--url https://api.getbreezyapp.com/v1/payments/{payment_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.getbreezyapp.com/v1/payments/{payment_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.getbreezyapp.com/v1/payments/{payment_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": "11111111-1111-4111-8111-000000000701",
"number": "P-1001",
"account": {
"id": "11111111-1111-4111-8111-000000000101",
"name": "Example Household"
},
"status": "PAID",
"method": "CARD",
"amount_cents": 80000,
"currency": "USD",
"occurred_at": "2026-09-02T18:00:00Z",
"created_at": "2026-09-02T18:00:00Z",
"updated_at": "2026-09-02T18:00:00Z",
"collected_by": {
"id": "11111111-1111-4111-8111-000000000401",
"name": "Alex Example"
},
"invoice_allocations": [
{
"invoice_id": "11111111-1111-4111-8111-000000000601",
"applied_cents": 50000
},
{
"invoice_id": "11111111-1111-4111-8111-000000000602",
"applied_cents": 30000
}
]
},
"meta": {
"request_id": "example-request",
"generated_at": "2026-09-08T19:00:00Z",
"timezone": "America/Los_Angeles"
}
}{
"error": {
"code": "INVALID_REQUEST",
"message": "end_date must be later than start_date",
"request_id": "example-request",
"details": []
}
}{
"error": {
"code": "UNAUTHENTICATED",
"message": "A valid API key is required",
"request_id": "example-request",
"details": []
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"request_id": "example-request",
"details": []
}
}{
"error": {
"code": "METHOD_NOT_ALLOWED",
"message": "This resource supports GET",
"request_id": "example-request",
"details": []
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Request limit exceeded",
"request_id": "example-request",
"details": []
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "Unable to complete request",
"request_id": "example-request",
"details": []
}
}Payments
Read one payment
Read only within the company associated with the validated key.
GET
/
payments
/
{payment_id}
Read one payment
curl --request GET \
--url https://api.getbreezyapp.com/v1/payments/{payment_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.getbreezyapp.com/v1/payments/{payment_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.getbreezyapp.com/v1/payments/{payment_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": "11111111-1111-4111-8111-000000000701",
"number": "P-1001",
"account": {
"id": "11111111-1111-4111-8111-000000000101",
"name": "Example Household"
},
"status": "PAID",
"method": "CARD",
"amount_cents": 80000,
"currency": "USD",
"occurred_at": "2026-09-02T18:00:00Z",
"created_at": "2026-09-02T18:00:00Z",
"updated_at": "2026-09-02T18:00:00Z",
"collected_by": {
"id": "11111111-1111-4111-8111-000000000401",
"name": "Alex Example"
},
"invoice_allocations": [
{
"invoice_id": "11111111-1111-4111-8111-000000000601",
"applied_cents": 50000
},
{
"invoice_id": "11111111-1111-4111-8111-000000000602",
"applied_cents": 30000
}
]
},
"meta": {
"request_id": "example-request",
"generated_at": "2026-09-08T19:00:00Z",
"timezone": "America/Los_Angeles"
}
}{
"error": {
"code": "INVALID_REQUEST",
"message": "end_date must be later than start_date",
"request_id": "example-request",
"details": []
}
}{
"error": {
"code": "UNAUTHENTICATED",
"message": "A valid API key is required",
"request_id": "example-request",
"details": []
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"request_id": "example-request",
"details": []
}
}{
"error": {
"code": "METHOD_NOT_ALLOWED",
"message": "This resource supports GET",
"request_id": "example-request",
"details": []
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Request limit exceeded",
"request_id": "example-request",
"details": []
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "Unable to complete request",
"request_id": "example-request",
"details": []
}
}Authorizations
Existing Breezy API key. Grants all published reads in its associated company. No app permission scopes.
Path Parameters
Response
Successful read. Clients ignore unrecognized response fields.
One payment counted once, even if applied to multiple invoices. Occurrence date supports backdating and is not bank settlement.
Show child attributes
Show child attributes
Generation time and company timezone. generated_at is not a snapshot or synchronization token.
Show child attributes
Show child attributes