Skip to navigation
APIPay Ops endpointsPaypoints

Update a paypoint

Beta
View as MarkdownOpen in Claude
Applies a partial update to a paypoint. Send only the fields you want to change.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

paypointReferencestringRequired
The paypoint reference.

Request

This endpoint expects an object.
paypointTypestringOptional

The paypoint type, for example merchant.

doingBusinessAsstringOptional

The name the paypoint does business as (DBA).

descriptionstringOptional

A free-text description of the paypoint.

websitestringOptional
The paypoint's website URL.
customerServicePhonestringOptional
The customer service phone number.
customerServiceEmailstringOptional
The customer service email address.
timezonestringOptional
The paypoint's time zone.
externalIdstringOptional
Your own identifier for the paypoint.
customDatamap from strings to anyOptional

Arbitrary key-value data you attach to the paypoint.

Response

Paypoint updated.
successboolean
Whether the request succeeded.
messagestring or null

A human-readable result message.

traceIdstring or null
The trace identifier for the request, useful for support.
dataobject or null
The updated paypoint.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error