Criar Link de Pagamento

Criar link de pagamento

post

Cria um novo link de pagamento

Authorizations

ApiKeyAuth

X-Token-ApistringRequired

Header parameters

X-Token-ApistringRequired

Token de autenticação para acesso à API

Content-Typestring · enumOptional

Tipo de conteúdo da requisição

Possible values:

x-ip-origin-requeststringOptional

IP de origem da requisição

x-idempotency-keystringOptional

Chave de idempotência

Body

application/json

typestring · enumRequiredExample: ORDERPossible values:

scheduledDatestring · dateOptional

Data de vencimento do pedido (opcional)

Example: 2025-10-23

uuidSellerClientstring · uuidOptional

UUID do comprador - se o link for específico para alguém (opcional)

Example: 123e4567-e89b-12d3-a456-426614174000

Responses

200

Link de pagamento criado com sucesso

application/json

400

Erro de validação

application/json

401

Token inativo ou inexistente

application/json

403

Acesso negado

application/json

429

Muitas requisições

application/json

500

Erro interno do servidor

application/json

post

/v2/payment-links

HTTPcURLJavaScriptPython

POST /v2/payment-links HTTP/1.1
Host: api.barte.com.br
X-Token-Api: text
Content-Type: application/json
Accept: */*
Content-Length: 603

{
  "type": "ORDER",
  "scheduledDate": "2025-10-23",
  "uuidSellerClient": "123e4567-e89b-12d3-a456-426614174000",
  "paymentOrder": {
    "title": "Link de Pagamento teste",
    "description": "text",
    "value": 1,
    "installments": 1,
    "timer": true,
    "expirationDate": "2025-10-23T18:00:00",
    "customInstallmentsValues": [
      {
        "paymentMethod": "PIX",
        "installments": 1
      },
      {
        "paymentMethod": "CREDIT_CARD_EARLY_BUYER",
        "installments": 10
      },
      {
        "paymentMethod": "BANK_SLIP",
        "installments": 1
      }
    ]
  },
  "paymentSubscription": {
    "idPlan": "123e4567-e89b-12d3-a456-426614174000",
    "type": "MONTHLY",
    "valuePerMonth": 1
  },
  "paymentMethods": [
    "PIX",
    "CREDIT_CARD_EARLY_BUYER",
    "BANK_SLIP"
  ]
}

{
  "id": 9448,
  "uuid": "a1b33060-6fc3-4057-bcd2-19a253c7b90e",
  "type": "ORDER",
  "url": "https://sandbox-checkout.barte.com/payment-link/a1b33060-6fc3-4057-bcd2-19a253c7b90e",
  "scheduledDate": "2025-10-23",
  "paymentOrder": {
    "title": "Link de Pagamento teste",
    "description": "text",
    "value": 1,
    "installments": 1,
    "customInstallmentsValues": [
      {
        "paymentMethod": "PIX",
        "installments": 1
      },
      {
        "paymentMethod": "CREDIT_CARD_EARLY_BUYER",
        "installments": 10
      },
      {
        "paymentMethod": "BANK_SLIP",
        "installments": 1
      }
    ],
    "expirationDate": "2025-10-23T18:00:00",
    "timer": true
  },
  "paymentSubscription": {
    "idPlan": "123e4567-e89b-12d3-a456-426614174000",
    "type": "MONTHLY",
    "value": 1,
    "valuePerMonth": 1
  },
  "processed": 0,
  "enableAnchoring": false,
  "allowedPaymentMethods": {
    "pixMethod": {},
    "bankSlipMethod": {},
    "creditCardMethod": {
      "type": "EARLY_BUYER"
    }
  },
  "paymentMethods": [
    "PIX",
    "BANK_SLIP",
    "CREDIT_CARD_EARLY_BUYER"
  ],
  "enableBankSlip": true,
  "enableCreditCard": true,
  "enablePixPayment": true,
  "subSellerResponse": [],
  "idSeller": 2890
}