List payment methods for an Organization

get

https://api.benjipays.com/v2/payment-methods

Returns paginated saved payment methods (profiles) for the organization associated with the authenticated API key. Filter by accounting customerId (QuickBooks Id, Xero ContactID, etc.) to list methods for one customer — the same pattern as the legacy /api/profiles/list route. Each item includes an internal Benji Pays profile id; there is no accounting-system payment-method identifier to address a single resource by path.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

length ≤ 200

Free-text search across payment method fields (customer name, masked card/account number, etc.).

customerId

string

length ≤ 200

Filter to a single accounting customer ID (QuickBooks Id, Xero ContactID, Business Central id, QBD ListID).

gatewayId

string

length ≤ 200

Filter to a gateway store identifier (gatewayId).

status

string

enum

Filter by payment method status. Matches the merchant-app profiles table filters.

Allowed:

sort

string

length ≤ 50

Field to sort by (uses the same field names returned in the response). Accepted values: customerName, createdDate, lastModifiedDate, lastDeclineDate, declineCount, autoPayPriority, gatewayId, gatewayProcessor. Defaults to customerName (accounting customer display name denormalized on the profile).

order

string

enum

Sort direction. Accepted values: asc (default), desc.

Allowed:

limit

integer

1 to 100

Defaults to 20

offset

integer

0 to 9007199254740991

Defaults to 0

Headers

X-Request-ID

uuid

Optional client-supplied unique ID for one request. The server generates a UUID v4 if omitted and always echoes the value in the response.

X-Correlation-ID

uuid

Optional ID that flows across service boundaries for distributed tracing. The server generates a UUID v4 if omitted and always echoes the value in the response.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Paginated payment method list

401Unauthorized

403Forbidden — missing required OAuth scope (organizations:payment-methods:read) and/or insufficient live mapping permission on the API key owner (e.g. companyAdmin or manageProfiles). Scope and mapping are independent gates; see response detail.

429Too Many Requests