Skip to main content
GET
List Payer Names
Returns the payer names registered by your account, newest first, along with whether a submission from this account must carry a supporting document.
Named Payouts are off until Rolla enables them for your account. Every endpoint in this group answers 403 with code: PAYER_NAMES_DISABLED until then. See the Named Payouts guide.

Example Request

Example Response

Filtering by status

The status filter takes review statuses. The status returned on each record is the customer-facing status, which additionally reports how far registration has got. The two vocabularies overlap but are not the same list: So to find the names you can pay under today, filter on approved and keep the ones returned as active. The Named Payouts guide explains each status.

requirements.documentsRequired

Whether your account must attach at least one supporting document to a submission. When it is true, a Create Payer Name call with no file is rejected with a 400. Read it before you build your submission form rather than discovering it from a failed POST.
downloadUrl on each document is a signed link that expires 1 hour after the response was generated. For a fresh link, call Get Document URL.

Authorizations

X-API-Key
string
header
required

Your Rolla API key

Query Parameters

status
enum<string>

Filter by review status. These are review statuses, not the customer-facing status returned on each record — filter on approved to find names that have cleared review, then keep the ones returned as active.

Available options:
pending_review,
changes_requested,
approved,
rejected,
archived
entityType
enum<string>

Filter by payer type.

Available options:
individual,
business
page
integer
default:1

Page number (default: 1)

Required range: x >= 1
pageSize
integer
default:20

Results per page (default: 20, max: 200)

Required range: 1 <= x <= 200

Response

Payer names retrieved

status
integer

HTTP status code, repeated in the body

Example:

200

message
string
Example:

"Payer names retrieved"

success
boolean
Example:

true

data
object