List payment methods

Returns a paginated list of payment methods for the tenant. Maps to ApiFinancialController.listPaymentMethods() → FinancialService.listPaymentMethods(). Soft-deleted methods are excluded by default. Each item carries the payment method record (including client_name) plus HATEOAS links.

RBAC · financial

Query parameters

pagestringOptional

limitstringOptional

sortstringOptional

Sort field. One of created_at, updated_at, type, is_default (defaults to created_at).

orderstringOptional

searchstringOptional

Matches client name or card last4.

created_fromstringOptional

created_tostringOptional

updated_fromstringOptional

updated_tostringOptional

is_activestringOptional

client_idstring <uuid>Optional

typestringOptional

is_defaultstringOptional

exclude_deletedstringOptional

Exclude soft-deleted payment methods. Defaults to true.

Response body

Success response 200 · schema FinancialInvoiceApiPaginated

dataarray of objectRequired

itemsobject

paginationobjectRequired

pageintegerRequired

limitintegerRequired

totalintegerRequired

totalPagesintegerRequired

hasNextbooleanRequired

hasPrevbooleanRequired

metaobject

Response codes

200

Paginated payment method list returned.

400

Invalid query parameters.

401

API key missing/invalid.

403

financial:read permission denied.

500

Unexpected list failure.

GET /api/v1/financial/payment-methods

cURL

curl -X GET "https://algapsa.com/api/v1/financial/payment-methods?page=string&limit=string&sort=string&order=asc&search=string&created_from=string" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/financial/payment-methods?page=string&limit=string&sort=string&order=asc&search=string&created_from=string", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/v1/financial/payment-methods?page=string&limit=string&sort=string&order=asc&search=string&created_from=string");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": [
    {}
  ],
  "pagination": {
    "page": 1,
    "limit": 1,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrev": false
  },
  "meta": {}
}