Criar Link

POST

/v1/links

Última modificação:2025-09-16 15:44:56

Requisição

Parâmetros Bodyapplication/json

Exemplo

{
  "amount": 100,
  "name": "Nome Produto",
  "description": "Descricao produto",
  "redirect_link": "https://www.example.com.br/",
  "metadata": "teste",
  "credit": true,
  "credit_tax": {
    "start_installment_at": 3,
    "installment_fee": 3.5
  },
  "pix": true,
  "boleto": true,
  "boleto_due_days": 4,
  "expire_in": 15
}

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://prod.your-api-server.com/v1/links' \
--header 'Content-Type: application/json' \
--data-raw '{
  "amount": 100,
  "name": "Nome Produto",
  "description": "Descricao produto",
  "redirect_link": "https://www.example.com.br/",
  "metadata": "teste",
  "credit": true,
  "credit_tax": {
    "start_installment_at": 3,
    "installment_fee": 3.5
  },
  "pix": true,
  "boleto": true,
  "boleto_due_days": 4,
  "expire_in": 15
}'

Respostas

🟢200Success

application/json

Body

Exemplo

{
    "id": 38,
    "ref_id": "PKH90ILS3H",
    "url": "http://dashboard.gateway1.local/link/PKH90ILS3H",
    "amount": 1000,
    "type": "payment",
    "name": "Gloves",
    "description": "Sed veritatis vero est sed eum et exercitationem aut.",
    "redirect": "https://www.example.com.br/",
    "status": "active",
    "expire_date": "2025-09-18",
    "enable_pix": true,
    "enable_boleto": true,
    "enable_card": true,
    "credit_tax": {
        "start_installment_at": 3,
        "installment_fee": 3.5
    },
    "created_at": "2025-09-16T15:43:23.000000Z",
    "updated_at": "2025-09-16T15:43:23.000000Z",
    "metadata": ""
}

🟠400Bad Request

Modificado em 2025-09-16 15:44:56

Página anterior

Retornar Parcelas de uma transação

Próxima página

Atualizar Link