Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-2484155300.5 KB
Payment Recipient

Update

Updates the payment recipient resource

patch/payments/recipients/{id}

Path parameters

idstring uuid required

Payment recipient primary identifier

Request body

taxNumberstring

Account owner tax number. Can be CPF or CNPJ (only numbers)

namestring

Account owner name.

paymentInstitutionIdstring uuid

Primary identifier of the institution associated to the payment recipient.

Example request

{
  "taxNumber": "123456789-00",
  "name": "Conta empresa",
  "paymentInstitutionId": "00000000-0000-0000-0000-000000000000",
  "account": {
    "branch": "0001",
    "number": "123456",
    "type": "CHECKING_ACCOUNT"
  }
}

Response

Update a payment recipient.

type'BANK_ACCOUNT' required

Recipient discriminator. Always BANK_ACCOUNT for this schema.

idstring required

Primary identifier

taxNumberstring required

Account owner tax number. Can be CPF or CNPJ (only numbers).

namestring required

Account owner name.

isDefaultboolean required

Indicates if the recipient is the default one

pixKeystring

Pix key associated with the payment recipient

createdAtstring date-time required

Date when the payment recipient was created

updatedAtstring date-time required

Date when the payment recipient was last updated

Example response

{
  "type": "BANK_ACCOUNT",
  "id": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
  "name": "Conta empresa",
  "taxNumber": "12345678900",
  "paymentInstitution": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Banco J. Safra S.A.",
    "ispb": "03017677",
    "tradeName": "Banco Safra",
    "compe": "074",
    "createdAt": "2020-04-21T15:00:00.000Z",
    "updatedAt": "2020-04-21T15:00:00.000Z"
  },
  "account": {
    "branch": "0001",
    "number": "123456",
    "type": "CHECKING_ACCOUNT"
  },
  "isDefault": false,
  "pixKey": null,
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}