Skip to main content
DELETE
Archive Payer Name
Retires a payer name you no longer want to pay under. Payouts reference the payer name they were sent with, so this archives rather than deletes. The record stays readable, keeps appearing in List Payer Names when you filter on archived, and historical payouts continue to show the name they went out under.

Example Request

Example Response

What archiving does

  • The name stops being usable on new payouts. Passing its id to Withdraw Funds is rejected with a 400.
  • If it was your default, you no longer have one, and payouts that omit payerNameId revert to your own business name.
  • Its registration with our payout partners is withdrawn in the background. The call succeeds immediately either way.
  • The name is freed for reuse: you can submit the same display_name again as a new payer name.
Archiving is not reversible and cannot be undone through the API. To pay under that name again, submit it as a new payer name and let it go through review.
Archiving a name that is already archived is a no-op and still answers 200.

Authorizations

X-API-Key
string
header
required

Your Rolla API key

Path Parameters

payerNameId
string<uuid>
required

The payer name id.

Response

Payer name archived

status
integer

HTTP status code, repeated in the body

Example:

200

message
string
Example:

"Payer name archived"

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.