Skip to navigation

List payment methods

View as Markdown

Retrieves a paginated list of all payment methods for a specific payee.

Success Responses

Status CodeDescription
200OK - The list of payment methods was successfully retrieved

Error Responses

Status CodeError CodeDescription
400VALIDATION_ERRORThe provided query parameters failed validation
401AUTHENTICATION_ERRORAuthentication credentials are invalid or missing
403AUTHORIZATION_ERRORYou do not have permission to perform this action
404NOT_FOUNDThe specified payee was not found

Authentication

x-api-keystring

RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.

OR
AuthorizationBearer

Short-lived session JWT from the Session Tokens API. Send as Authorization: Bearer <token>. Accepted on payment-method endpoints for a specific payee or payer; mint tokens with an API key.

Path parameters

payee_idstringRequiredformat: "uuid"

Query parameters

cursorstring or nullOptional

Cursor for pagination. Use the next_cursor from the previous response to get the next page.

limitinteger or nullOptional10-500Defaults to 50
Number of items to return per page. Minimum is 10. Maximum is 500.
orderenum or nullOptionalDefaults to desc

Sort order by created_at: ‘asc’ for oldest first, ‘desc’ for newest first (default: ‘desc’)

Allowed values:

Response

List of payment methods retrieved successfully
datalist of objects
has_moreboolean
total_countinteger or nullOptional>=0Defaults to 0
next_cursorstring or nullOptional
previous_cursorstring or nullOptional