Editar link de pagamento

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

iduuidrequired

Id do link de pagamento

Body Params

titlestringrequired

Título do link

descriptionstringrequired

Descrição do link de pagamento

activedbooleanoptional

Ativa ou desativa o link (default: false)

limitintegeroptional

Limite de pagamentos — 0 = ilimitado

postbackUrlstringoptional

URL para receber notificações de pagamento

imageUrlstringoptional

URL da imagem exibida na página do link

expireAtdateoptional

Data de expiração no formato YYYY-MM-DD

redirect_urlstringoptional

URL de redirecionamento após pagamento aprovado

phonebooleanoptional

Solicita telefone do cliente

address_deliverybooleanoptional

Solicita endereço de entrega

address_invoicebooleanoptional

Solicita endereço de cobrança

confirm_emailbooleanoptional

Solicita confirmação de e-mail

birthdatebooleanoptional

Solicita data de nascimento

sexbooleanoptional

Solicita gênero do cliente

productsobjectoptional

Lista de produtos (externCode, name, price, min, max)

paymentConfigobjectoptional

Configuração de métodos (pix, credit, boleto, installments, boletoExpireDay, interest_rate_installment)

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

Response

Choose an example:

application/json

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