Skip to main content
PATCH
Set Default Payer Name
Chooses the payer name applied to payouts that do not name one. A payout that omits payerNameId goes out under your default, so this is how you apply a name across an existing integration without changing your payout code.

Example Request

isDefault defaults to true, so an empty body sets the default. Send false to clear it, after which payouts that omit payerNameId go out under your own business name again.

Example Response

Rules

  • One default per account. Setting a new one moves the flag off the old one; there is no need to clear it first.
  • It must have cleared review. Anything that is not approved — still in pending_review or changes_requested, or already rejected or archived — is refused with a 400. A default that cannot be used would silently apply to every payout.
  • Archiving clears it. Archiving your default leaves you with none, and payouts revert to your own business name.
A name that has cleared review can be made the default while its registration is still processing. Payouts sent in that window carry the name but wait until it is active before they can go out. If that matters to your flow, wait for the payer_name.active event before setting the default.

Authorizations

X-API-Key
string
header
required

Your Rolla API key

Path Parameters

payerNameId
string<uuid>
required

The payer name id.

Body

application/json
isDefault
boolean
default:true

Defaults to true, so an empty body sets the default. Send false to clear it.

Example:

true

Response

Default payer name updated

status
integer

HTTP status code, repeated in the body

Example:

200

message
string
Example:

"Default payer name updated"

success
boolean
Example:

true

data
object

A payer name: the name a beneficiary sees on a payout you send. Responses are camelCase; request bodies are snake_case.