Skip to main content
PATCH
Update Payer Name
Corrects a payer name and resubmits it for review. This is how you answer a changes_requested decision. Every field is optional; anything you omit keeps its current value. PUT /payer-names/{payerNameId} is accepted as an alias and behaves identically.

Example Request

Example Response

What an update does

Any edit returns the payer name to pending_review and clears decisionNote — including an edit that only touches metadata. There is no way to change a field without going back through review, so batch your corrections into one call.
Only a name in pending_review or changes_requested can be edited. Anything else answers 409: Changing display_name to a name you already have in review or approved answers 409 too.

Sandbox

As with Create Payer Name, a sandbox update is approved and activated immediately and comes back as active.

Authorizations

X-API-Key
string
header
required

Your Rolla API key

Path Parameters

payerNameId
string<uuid>
required

The payer name id.

Body

application/json

Fields to change on a payer name still in review. Every field is optional; omitted fields keep their current value. Any edit returns the name to pending_review and clears decisionNote.

entity_type
enum<string>

Whether the payer is a company or a person.

Available options:
individual,
business
Example:

"business"

display_name
string

The name the beneficiary sees. Must be unique among your payer names that are in review or approved, compared case-insensitively.

Required string length: 1 - 255
Example:

"Acme Trading Ltd"

first_name
string | null

Individuals only. Send the name already split rather than letting us guess where to split it.

Maximum string length: 120
last_name
string | null

Individuals only.

Maximum string length: 120
registration_number
string | null

Company registration number, or a government ID number for an individual.

Maximum string length: 120
Example:

"RC1234567"

registration_date
string | null

YYYY-MM-DD.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2019-04-02"

country
string

The payer's country. ISO 3166-1 alpha-2, or a country name we can resolve to one. Anything that does not resolve to two letters is rejected with a 400.

Required string length: 1 - 100
Example:

"NG"

address_line
string
Required string length: 1 - 500
Example:

"14 Marina Road"

city
string
Required string length: 1 - 120
Example:

"Lagos"

state_province
string
Required string length: 1 - 120
Example:

"Lagos"

postal_code
string | null
Maximum string length: 32
Example:

"101001"

metadata
object

Flat key/value data of your own, echoed back on responses and webhooks. Keys are at most 64 characters; values may be strings (max 500 characters), numbers or booleans. JSON requests only — a multipart request cannot carry it.

Example:

Response

Payer name updated and resubmitted for review. In sandbox the message is Payer name updated and the name comes back as active.

status
integer

HTTP status code, repeated in the body

Example:

200

message
string
Example:

"Payer name updated and resubmitted for review"

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.