Editar link de pagamento

PUT/edit-payment-link/{id}

Atualizado em 21 de março de 2025 · 2 min de leitura

Atualiza as configurações de um link de pagamento existente.

Atualiza as configurações de um link de pagamento existente. Todos os campos enviados sobrescrevem os valores anteriores.

PUThttps://{apiUrl}/edit-payment-link/{id}

URL base da API

Token de autenticação

Path Params

idstringrequired

UUID do link de pagamento

Body Params

titlestringrequired

Título do link

descriptionstringrequired

Descrição

activedbooleanoptional

Ativar/desativar o link

limitintegeroptional

Limite de transações (0 = ilimitado)

expireAtstringoptional

Data de expiração (yyyy-mm-dd)

curl --request PUT \
  --url "https://{apiUrl}/edit-payment-link/{id}" \
  --header "Content-Type: application/json" 
  --data '{}'

Response

Choose an example:

application/json

Parâmetros

Path

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Sim	UUID do link de pagamento

Headers

Parâmetro	Tipo	Obrigatório	Descrição
`Authorization`	string	Sim	Chave privada no formato `Bearer {token}`

Body

Os mesmos campos do Criar link de pagamento.

Parâmetro	Tipo	Obrigatório	Descrição
`title`	string	Sim	Título do link
`description`	string	Sim	Descrição
`actived`	boolean	Não	Ativar/desativar o link
`limit`	integer	Não	Limite de transações (0 = ilimitado)
`expireAt`	string	Não	Data de expiração (`yyyy-mm-dd`)
`products`	array	Sim	Lista de produtos
`paymentConfig`	object	Sim	Configuração de pagamento

Exemplo de requisição

bash

curl --request PUT \
  --url https://{apiUrl}/edit-payment-link/{id} \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "Produto XYZ - Atualizado",
    "description": "Nova descrição do produto",
    "actived": true,
    "limit": 100,
    "products": [
      {
        "name": "Produto XYZ",
        "price": 12990,
        "min": 1,
        "max": 5
      }
    ],
    "paymentConfig": {
      "pix": true,
      "credit": true,
      "boleto": false,
      "installments": 6
    }
  }'

Responses

Esta página foi útil?