---
title: "Atualizar link de pagamento"
method: PUT
path: "/{companyId}/banking/payment-link/{paymentLinkId}"
tags: ["Link de pagamento"]
---

# Atualizar link de pagamento

`PUT /{companyId}/banking/payment-link/{paymentLinkId}`

API responsável por editar um link de pagamento

## Path parameters

- `paymentLinkId` string, required — Identificador do Link de Pagamento
- `companyId` string, required

## Request body

- EditPaymentLinkRequest
  - `name` string — Nome do link de pagamento
  - `amount` number — Valor
  - `description` string — Descrição do link de pagamento
  - `paymentMethods` string[] — Métodos de pagamento permitidos
  - `notifications` Notifications
    - `deliveryMediums` string[]
    - `email` string — Email do beneficiário
    - `phone` string — Telefone do beneficiário
  - `schedule` Schedule
    - `startAt` string — Data e hora de ativação do link de pagamento
    - `endAt` string — Data e hora de desativação do link de pagamento
  - `payer` Payer — Pagador
    - `name` string, required
    - `email` string, email
    - `personType` 'F' | 'J', required
    - `phoneNumber` string
    - `taxId` string, required
    - `address` Address
      - `type` 'RESIDENCIAL' | 'COMERCIAL' | 'OUTROS' | 'NATURALIDADE'
      - `zipCode` string
      - `country` string
      - `state` string
      - `city` string
      - `street` string
      - `number` string
      - `complement` string
      - `neighborhood` string
    - `deliveryMediums` string[]
  - `details` PaymentLinkDetails
    - `limits` object
      - `maxInstallments` integer — Número máximo de parcelas permitidas para pagamento com cartão

## Response `200`

Link de pagamento editado com sucesso.

- PaymentLinkResponse
  - `paymentLinkId` string — Identificador do Link de Pagamento
  - `name` string — Nome do link de pagamento
  - `amount` number — Valor
  - `notifications` Notifications
    - `deliveryMediums` string[]
    - `email` string — Email do beneficiário
    - `phone` string — Telefone do beneficiário
  - `paymentMethods` string[] — Métodos de pagamento permitidos
  - `status` 'ACTIVE' | 'INACTIVE' | 'EXPIRED' | 'CANCELED' | 'PAID' — Status do link de pagamento
  - `createdAt` string — Data
  - `updatedAt` string — Data
  - `schedule` Schedule
    - `startAt` string — Data e hora de ativação do link de pagamento
    - `endAt` string — Data e hora de desativação do link de pagamento
  - `linkUrl` string — URL do link de pagamento
  - `description` string — Descrição do link de pagamento
  - `payer` Payer — Pagador
    - `name` string, required
    - `email` string, email
    - `personType` 'F' | 'J', required
    - `phoneNumber` string
    - `taxId` string, required
    - `address` Address
      - `type` 'RESIDENCIAL' | 'COMERCIAL' | 'OUTROS' | 'NATURALIDADE'
      - `zipCode` string
      - `country` string
      - `state` string
      - `city` string
      - `street` string
      - `number` string
      - `complement` string
      - `neighborhood` string
    - `deliveryMediums` string[]
  - `payee` object
    - `name` string — Nome do beneficiário
    - `email` string — Email do beneficiário
    - `personType` string
    - `phoneNumber` string — Telefone do beneficiário
    - `taxId` string
  - `type` 'SINGLE' | 'MULTIPLE' — Tipo do link de pagamento
  - `details` PaymentLinkDetails
    - `limits` object
      - `maxInstallments` integer — Número máximo de parcelas permitidas para pagamento com cartão

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `409` — Conflict
- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

[API](https://skmtc.net/btgpactual/apis/folha-de-pagamentos.md) · [All operations](https://skmtc.net/btgpactual/apis/folha-de-pagamentos/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/btgpactual/folha-de-pagamentos/revisions/2a24d3da114c/schema)