Contacts (Receivable)

Update a Receivable Contact

Changed on

Update the client and PayID name of a Receivable Contact.

Supply the desired <code>client_id</code> of a client registered via the <a href="https://docs.zeptopayments.com/v20260901/reference/post_clients">Clients API</a>, and a <code>payid_name</code> that matches the client's legal name or one of its business names. Zepto assigns the Contact's float account and PayID to new client and updates the name payers see in PayID and Confirmation of Payee (CoP) resolutions.

A Contact's client can only be reassigned once. Only the PayID name can be updated multiple times if required.

The update is processed asynchronously. The new names appear shortly after the request is accepted.

<aside class="notice"> The Receivable Contact you are updating must be active. </aside>
patch/contacts/{contact_id}/receivable

Request

  • Base URL
    https://api.sandbox.zeptopayments.com
  • URL
    https://api.sandbox.zeptopayments.com/contacts/{contact_id}/receivable
  • Auth
    OAuth 2
    Authorization code: /oauth/authorize
    Token URL: /oauth/token

Path parameters

contact_idstring UUID required

Receivable Contact ID (ReceivableContact.data.id)

Request body

payid_namestring required

The name shown to payers in PayID and Confirmation of Payee resolutions. Must match the supplied client's legal name or one of its business names.

client_idstring uuid required

Client to assign the Contact's PayID and float account to. The client must have active RTP service.

Example request

{
  "payid_name": "Dolphin Pools",
  "client_id": "01955dea-b445-7841-a145-77b4b2c00089"
}

Response

Accepted

Changes

    • breaking

      added the new required request property

    • breaking

      the request property's minLength was increased from 0 to 1

    • warning

      the request property's maxLength was set to 140

    • info

      added the media type application/json for the response with the status