---
title: "Update"
method: PATCH
path: "/payments/recipients/{id}"
tags: ["Payment Recipient"]
---

# Update

`PATCH /payments/recipients/{id}`

Updates the payment recipient resource

## Path parameters

- `id` string, uuid, required

## Request body

- UpdatePaymentRecipient — Request with information to update a payment recipient
  - `taxNumber` string — Account owner tax number. Can be CPF or CNPJ (only numbers)
  - `name` string — Account owner name.
  - `paymentInstitutionId` string, uuid — Primary identifier of the institution associated to the payment recipient.
  - `account` PaymentRecipientAccount — Payment receiver bank account information
    - `branch` string, required — Receiver bank account branch (agency)
    - `number` string, required — Receiver bank account number
    - `type` string, required — Receiver bank account type, could be: 'CHECKING_ACCOUNT', 'SAVINGS_ACCOUNT' or 'GUARANTEED_ACCOUNT'

## Response `200`

Update a payment recipient.

- PaymentRecipient — Bank-account payment recipient. Returned by `/payments/recipients` endpoints and embedded inside payment requests when the request targets a registered recipient.
  - `type` 'BANK_ACCOUNT', required — Recipient discriminator. Always `BANK_ACCOUNT` for this schema.
  - `id` string, required — Primary identifier
  - `taxNumber` string, required — Account owner tax number. Can be CPF or CNPJ (only numbers).
  - `name` string, required — Account owner name.
  - `paymentInstitution` PaymentInstitution, required — Response with information related to a payment institution
    - `id` string, required — Primary identifier
    - `name` string, required — Payment institution name
    - `tradeName` string, required — Payment institution trade name
    - `ispb` string, required — Payment institution ISPB
    - `compe` string — Payment institution COMPE
    - `createdAt` string, date-time, required — Date when the payment institution was created
    - `updatedAt` string, date-time, required — Date when the payment institution was updated
  - `isDefault` boolean, required — Indicates if the recipient is the default one
  - `account` PaymentRecipientAccount, required — Payment receiver bank account information
    - `branch` string, required — Receiver bank account branch (agency)
    - `number` string, required — Receiver bank account number
    - `type` string, required — Receiver bank account type, could be: 'CHECKING_ACCOUNT', 'SAVINGS_ACCOUNT' or 'GUARANTEED_ACCOUNT'
  - `pixKey` string — Pix key associated with the payment recipient
  - `createdAt` string, date-time, required — Date when the payment recipient was created
  - `updatedAt` string, date-time, required — Date when the payment recipient was last updated

---

[API](https://skmtc.dev/pluggy/apis/pluggy-api.md) · [All operations](https://skmtc.dev/pluggy/apis/pluggy-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pluggy/pluggy-api/revisions/75e87ec7f9cd/schema)