List payment-method-on-file requests

get

https://api.benjipays.com/v2/payment-method-requests

Returns paginated customer payment-method-on-file requests for the organization associated with the authenticated API key. Excludes generic (no-customer) portal-link submissions. Filter by customer, gateway, and status. Requires organizations:payment-method-requests:read.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

customerId

string

length between 1 and 200

Filter to a single accounting customer ID.

gatewayId

string

length between 1 and 100

Filter to a gateway store identifier (or default-currency hash).

status

string

enum

Filter by request status (pending or completed).

Allowed:

limit

integer

1 to 1000

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-request list

400Bad Request — invalid query or portal/accounting configuration

401Unauthorized — invalid or missing authentication, or API access is not active for this organization (disabled or missing).

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

404Organization not found

429Too Many Requests