Skip to navigation

Update payer

View as Markdown
Updates an existing payer's information. Only the provided fields will be updated.

Authentication

x-api-keystring

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

Path parameters

payer_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.
country_codeenumOptional
Allowed values:
country_sub_divisionstring or nullOptional<=35 characters
State, province, or country subdivision
citystring or nullOptional<=35 characters
City or town name
address_linestring or nullOptional<=500 characters
Street address, building number, postal code, etc.
postal_codestring or nullOptional<=16 characters
Zip or postal code
namestring or nullOptional1-255 characters

Name may contain only letters A-Z and a-z, characters in U+00C0-U+017F (accented Latin letters such as é, ñ, ü, ł, plus × and ÷), digits, spaces, hyphens (-), underscores (_), and straight apostrophes (’). Other punctuation, such as & , . / ( ), en or em dashes, and curly apostrophes (’), is not allowed.

emailstring or nullOptionalformat: "email"<=255 characters

Must be a valid email address. Special-use domains are rejected: .arpa, .invalid, .local, .localhost, .onion, and .test.

Response

Payer updated successfully
dataobject
warningstring or nullOptional