Listar imputações de pagamentos
RegistosGET /payment-allocations
Each allocation carries the target invoice's number and current status (invoice_status), read in one batched lookup per response, so clients can filter allocations by invoice state without paging the invoice list.
Parâmetros
limitMaximum resources to return (default 20, maximum 100).
afterOpaque cursor returned by the previous page.
payment_idOptional payment ID; when set, only the allocations of that payment are returned.
invoice_idOptional invoice ID; when set, only the allocations applied to that invoice are returned.
Devolve
200 Payment allocations in the authenticated utility tenant
Mostrar atributos
dataMostrar atributos filhos
idtenant_idpayment_idinvoice_idinvoice_numberThe invoice's display number
invoice_statusThe invoice's current status, read when the response is written; omitted when the invoice cannot be read
amount_centscurrencyaccount_idaccount_numberaccount_holder_namecustomer_idcustomer_namecreated_atreversed_at
has_morenext_cursor
Permissões payments:read · Funções: admin, analyst, billing_clerk, customer_service, finance, owner, viewer
curl -X GET "$BUSINESS_API/payment-allocations" \
-H "Authorization: Bearer sk_test_..."
# Sem comando CLI equivalente; use cURL ou HTTP directo.
const res = await fetch("$BUSINESS_API/payment-allocations", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/payment-allocations",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/payment-allocations", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"data": [
{
"id": "pay_2F9MkvJqchhA2HP0mRBY6Lry6lf",
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"payment_id": "pay_2eUBfC8BJA6JLIoHrQwtN0GL1mW",
"invoice_id": "inv_2jnourvAGxXMMd5IyFbwc1LqUX1",
"invoice_number": "INV-2026-000142",
"invoice_status": "invoice status",
"amount_cents": 125000,
"currency": "MZN",
"account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
"account_number": "ACC-2026-000142",
"account_holder_name": "Ana Matsinhe",
"customer_id": "cus_2UuXtOGTHWKlvkoF5so5Joi3Hck",
"customer_name": "Ana Matsinhe",
"created_at": "2026-11-19T09:30:00Z",
"reversed_at": "2026-11-19T09:30:00Z"
}
],
"has_more": true,
"next_cursor": "next cursor"
}