Skip to main content

Updating Payee Information

How to update payee details, including PII updates via separate endpoint.

Written by Ryan O
Updated today

Overview

After creating a payee, you may need to update their details -- for example, changing an email address, correcting a name, or updating their country information. Anton provides a straightforward update mechanism via both the merchant portal and API.

Updating via the Merchant Portal

Navigate to Payees, find the payee you want to update, and click into their profile. Edit the fields you need to change and click Save. Changes take effect immediately for future payouts.

Updating via the API

Send a PATCH request to /v1/payees/{payee_id} with only the fields you want to change. You do not need to include unchanged fields.

curl https://api.antonpayments.dev/v1/payees/pye_abc123 \
  -X PATCH \
  -H "Authorization: Bearer ak_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]"
  }'

What You Can Update

The following fields can be updated on an existing payee:

  • email -- The payee's contact email address

  • first_name and last_name -- For individual payees

  • company_name -- For business payees

  • country -- The payee's country code

  • metadata -- Custom key-value pairs for your internal tracking

PII Updates

Anton tokenizes all personally identifiable information (PII) through a secure vault. When you update PII fields such as names, addresses, or identity documents, the update flows through a separate secure processing path to maintain compliance with data protection requirements.

Key points about PII updates:

  • PII changes are processed through Anton's tokenization layer and never stored in plaintext.

  • Updates to sensitive identity fields may trigger re-screening for compliance (sanctions checks, name matching).

  • Historical PII values are retained in the audit trail for compliance purposes, even after updates.

Updating Payment Instruments

Payment instruments (bank accounts, wallets, cards) are managed separately from the payee record. To change a payee's payment details, add a new instrument and optionally deactivate the old one. See Adding Payment Instruments for details.

Important Considerations

  • In-flight payouts -- Updating a payee does not affect payouts that are already in progress. Changes apply only to new payouts created after the update.

  • Compliance re-screening -- Changes to names or country may trigger fresh sanctions and compliance screening on the next payout.

  • Audit trail -- All payee updates are logged with a full audit trail including who made the change and when.

  • Idempotency -- Include an Idempotency-Key header on update requests to prevent accidental duplicate updates during retries.

Did this answer your question?