Rename or archive a saved recipient (free)

Renames a saved Venmo or PayPal recipient, archives it, or both. Provide at least one of display_name or archived.

Archiving hides an entry from the default list while keeping its history, which is the reversible way to retire a recipient. Prefer it over DELETE.

Requires a Bearer token from /auth or /get-card.

post/payment-recipients

Request

  • Base URL: https://laso.finance
  • URL: https://laso.finance/payment-recipients
  • Auth: API key in header Authorization

Headers

Idempotency-Keystring

Optional client-generated unique key (a UUID works) that makes this write safe to retry. A retry with the same key within 24 hours returns the recorded response of the original request, marked with an Idempotency-Replayed: true header, instead of performing the write again. Reusing a key with a different body or route is rejected with 422 (code: idempotency_key_reused); a retry that arrives while the original is still running gets 409 (code: idempotency_key_in_progress), so wait a moment and retry with the same key. Keys are scoped to the authenticated account.

Request body

platform'venmo' | 'paypal' required

Payment platform the recipient is saved under.

recipient_idstring required

The entry's recipient_id from GET /payment-recipients (an opaque id, not the phone number or email).

display_namestring

Must be a string. A wrong type returns a terminal 400 with code invalid_display_name.

archivedboolean

Must be a boolean. A wrong type returns a terminal 400 with code invalid_archived.

Response

The updated recipient.

user_idstring
platformstring
recipient_idstring
display_namestring
archivedboolean

Changes

No recorded changes to this operation across all 3 revisions of this API.