Sign in
User

Rename or complete a contact

Renames a contact and fills in details it is still missing (address, relationship, BIC, bank address). Values already stored are kept as they are, and whatever the payout providers keep about the recipient is updated on their side too. Use this instead of deleting and re-creating a contact to add a field — a re-created contact is a new row, and the provider beneficiary registered for the original stays behind on it.

patch/api/v1/user/contacts/{contact_id}

Path parameters

contact_idstring uuid required

Headers

x-api-keystring nullable

Request body

namestring nullable
relationship'employee' | 'contractor' | 'vendor' | 'subsidiary' | 'merchant' | 'customer' | 'landlord' | 'family' | 'other' | 'self'

How a payout contact relates to the user.

The vocabulary mirrors Swipelux's recipient relationships so the common values project onto their API unchanged, but this is our own domain type: SELF marks a first-party payout to the user's own account at another bank and has no Swipelux counterpart. Providers own that projection — see SwipeluxRecipients._recipient_relationship — so nothing here depends on a provider, and no provider enum has to carry a value it cannot accept.

bicstring nullable

BIC for an IBAN contact saved without one — Align requires it on IBAN beneficiaries. Ignored when the contact already has a BIC.

Response

Successful Response

{"stackTrail":"paths:/api/v1/user/contacts/{contact_id}:patch:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

Changed in 1 of the 4 revisions of this API.153

  • 7ed1b58c5607153See the full diff
    • ▲

      removed app__schemas__routers__user__contact__ContactRelationship from the relationship request property anyOf list

      request-property-any-of-removed

    • ●

      removed the request property chainId

      request-property-removed

    • ●

      removed the request property currency

      request-property-removed

    • ●

      removed the request property priorityMethod

      request-property-removed

    • ●

      removed the request property userId

      request-property-removed

    • ●

      removed the request property walletAddress

      request-property-removed

    • ○

      added the new optional request property bankAddress

      new-optional-request-property

    • ○

      added the new optional request property bic

      new-optional-request-property

    • ○

      added ContactRelationship to the relationship request property anyOf list

      request-property-any-of-added

    This revision also has 47 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog