Atualizar link de pagamento

Atualizar link de pagamento

put

Atualiza os dados de um link de pagamento específico

Autorizações

ApiKeyAuth

Parâmetros de rota

uuidstring · uuidObrigatório

UUID do link de pagamento

Parâmetros de cabeçalho

X-Token-ApistringObrigatório

Token de autenticação para acesso à API

Content-Typestring · enumOpcional

Tipo de conteúdo da requisição

Valores possíveis:

x-ip-origin-requeststringOpcional

IP de origem da requisição

x-idempotency-keystringOpcional

Chave de idempotência

Corpo

application/json

typestring · enumObrigatórioExample: ORDERValores possíveis:

scheduledDatestring · dateOpcional

idSellerClientinteger · int32Opcional

uuidSellerClientstring · uuidOpcional

enableAnchoringbooleanOpcional

enableBankSlipbooleanOpcional

enableCreditCardbooleanOpcional

enablePixbooleanOpcional

Respostas

200

Link de pagamento atualizado com sucesso

application/json

400

Erro de validação

application/json

401

Token inativo ou inexistente

application/json

403

Acesso negado

application/json

404

Link de pagamento não encontrado

application/json

429

Muitas requisições

application/json

500

Erro interno do servidor

application/json

put

HTTPcURLJavaScriptPython

PUT /v2/payment-links/{uuid} HTTP/1.1
Host: api.barte.com.br
X-Token-Api: text
Content-Type: application/json
Accept: */*
Content-Length: 452

{
  "type": "ORDER",
  "scheduledDate": "2025-09-26",
  "idSellerClient": 1,
  "uuidSellerClient": "123e4567-e89b-12d3-a456-426614174000",
  "paymentOrder": {
    "title": "Link de Pagamento teste",
    "description": "text",
    "value": 1,
    "installments": 1,
    "timer": true
  },
  "paymentSubscription": {
    "idPlan": "123e4567-e89b-12d3-a456-426614174000",
    "type": "MONTHLY",
    "valuePerMonth": 1
  },
  "paymentMethods": [
    "PIX"
  ],
  "enableAnchoring": true,
  "enableBankSlip": true,
  "enableCreditCard": true,
  "enablePix": true
}

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "type": "ORDER",
  "createdAt": "2025-09-26T17:06:27.666Z",
  "updatedAt": "2025-09-26T17:06:27.666Z",
  "url": "https://example.com",
  "scheduledDate": "2025-09-26",
  "paymentOrder": {
    "title": "text",
    "description": "text",
    "value": 1,
    "installments": 1,
    "timer": true
  },
  "paymentSubscription": {
    "idPlan": "123e4567-e89b-12d3-a456-426614174000",
    "type": "MONTHLY",
    "value": 1,
    "valuePerMonth": 1
  },
  "enableAnchoring": true,
  "enableBankSlip": true,
  "enableCreditCard": true,
  "enablePix": true,
  "processed": 1
}