--- title: "Criar link de pagamento" method: POST path: "/paymentlinks." --- # Criar link de pagamento `POST /paymentlinks.` ## Request - Base URL: `https://api.pagar.me/core/v5` - URL: `https://api.pagar.me/core/v5/paymentlinks.` - Auth: HTTP basic ## Request body - object - `is_building` boolean: Define se o link de pagamento será criado com o status building ou ativo, em caso de envio do campo true tal permite que você ative um link em determinado momento posteriormente, para realizar uma ação promocional, por exemplo; - `name` string: Nome que será exibido na dashboard e ao buscar o link de pagamento através da API. Máximo de 64 caracteres. - `type` string, required: Define o tipo do link de pagamento a ser criado, podendo ser "order", para criação de pedidos, ou "subscription", para recorrências. - `expires_at` string, date: Define a data de expiração do link de pagamento. Formato ISO 8601. Caso não seja enviado o link não terá expiração por tempo. Não deve ser enviado caso o campo expires_in seja enviado. - `expires_in` integer: Define o tempo de expiração do link de pagamento em minutos após o mesmo estar ativo. Tempo em minutos. Caso não seja enviado, o link não terá expiração por tempo. Não deve ser enviado caso o campo expires_at seja enviado. - `max_sessions` integer: Define o máximo de pedidos que o link de pagamento pode gerar, sejam eles pagos ou não. Caso não seja enviado, não haverá limite de pedidos criados. - `max_paid_sessions` integer: Define o máximo de pedidos pagos que o link de pagamento pode gerar. Caso não seja enviado, não haverá limite de pagamentos. - `payment_settings` object, required: Configurações de pagamento do link. - `accepted_payment_methods` string[]: Define os métodos de pagamento aceitos. Valores permitidos: "credit_card", "boleto" e "pix". - `statement_descriptor` string: Define o identificador que irá aparecer na fatura do comprador. Limite de 13 caracteres. - `credit_card_settings` object: Define as configurações de pagamento quando cartão de crédito for selecionado. Obrigatório quando enviado "credit_card" em "accepted_payment_methods". - `operation_type` string: Indica se a transação deve ser capturada ("auth_and_capture") ou apenas autorizada ("auth_only"). - `delay_to_capture` integer: Tempo pré-definido para a captura do pagamento após autorização. Valor em xxx. - `installments` object[]: Configurações de parcelamento do link. Não deverá ser enviado caso o campo "installments_setup" seja definido. - `number` integer, required: Número de parcelas - `total` integer, required: Valor total que será cobrado caso essa opção de parcelamento seja selecionada, em centavos. - `installments_setup` object: Configurações de parcelamento do link. Não deverá ser enviado caso o campo "installments" seja definido. - `max_installments` integer: Número máximo de parcelas permitido. - `amount` integer: Valor total que será cobrado pelo link, em centavos. - `interest_type` string: Tipo de cálculo utilizado para a inclusão de acréscimo de juros no parcelamento, se aplicável. - `interest_rate` integer: Valor percentual que será utilizado para o acréscimo de juros no parcelamento. - `customer_fee` boolean: Define se as taxas deverão ser automaticamente repassadas no parcelamento do link. Para clientes PSP, caso esse campo seja "true", os campos "interest_type" e "interest_rate" não devem ser enviados. - `free_installments` integer: Número de parcelas que não terão acréscimo de juros. - `brand` string: Define a bandeira para recuperar as taxas do lojista. Caso o campo "customer_fee" seja "true", e os campos "interest_type" e "interest_rate" não forem informados. Apenas para clientes PSP. - `boleto_settings` object: Define as configurações de pagamento quando boleto for selecionado. Obrigatório quando enviado "boleto" em "accepted_payment_methods". - `due_at` string, date: Define a data de expiração do boleto gerado. Formato ISO 8601. Não deverá ser enviado caso o campo "due_in" seja definido. - `due_in` integer: Define quantidade de tempo para expiração do boleto a partir do momento que o mesmo é gerado. Valor em dias. Não deverá ser enviado caso o campo "due_in" seja definido. - `discount` integer: Valor de desconto a ser aplicado ao boleto, em centavos. Não deve ser enviado caso o campo "discount_percentage" seja definido. - `discount_percentage` number, double: Valor de desconto a ser aplicado ao boleto, em porcentagem. Não deve ser enviado caso o campo "discount" seja definido. - `instructions` string: Instruções do boleto. Máximo 255 caracteres. - `pix_settings` object: Define as configurações de pagamento quando pix for selecionado. Obrigatório quando enviado "pix" em "accepted_payment_methods". - `expires_in` integer: Define quantidade de tempo para expiração do pix a partir do momento que o mesmo é gerado. Valor em segundos. Não deverá ser enviado caso o campo "expires_at" seja definido. - `expires_at` string, date: Define a data de expiração do pix gerado. Formato ISO 8601. Não deverá ser enviado caso o campo "expires_in" seja definido. - `discount` integer: Valor de desconto a ser aplicado ao pix, em centavos. Não deve ser enviado caso o campo "discount_percentage" seja definido. - `discount_percentage` number, double: Valor de desconto a ser aplicado ao pix, em porcentagem. Não deve ser enviado caso o campo "discount" seja definido. - `additiona_information` object: Objeto chave/valor utilizado para adicionar informações sobre o pagamento. Esses dados serão visíveis para o consumidor na hora do pagamento. - `Name` string: Nome utilizado para adicionar informações sobre o pagamento. - `Value` string: Valor utilizado para adicionar informações sobre o pagamento. - `customer_settings` object: Define os dados do cliente, se aplicável. - `customer_id` string: Código do cliente. - `customer` object: Dados do cliente. Não deverá ser enviado caso o campo "customer_id" seja definido. - `name` string, required: Nome do cliente. Max: 64 caracteres. - `type` string: Tipo de cliente. Valores possíveis: individual (pessoa física) ou company (pessoa jurídica). Obrigatório, caso o document seja enviado. - `email` string: E-mail do cliente. Max: 64 caracteres. - `code` string: Código de referência do cliente no sistema da loja. Max: 52 caracteres. - `document` string: CPF, CNPJ ou PASSAPORTE do cliente. Max: 16 caracteres para CPF e CNPJ e Max: 50 caracteres para PASSAPORTE. - `document_type` string: Tipo de documento. Valores possíveis: "CPF", "CNPJ" ou "PASSPORT". - `gender` string: Sexo do cliente . Valores possíveis: male ou female. - `address` object: Endereço do cliente. - `country` string: País (Código do país no formato ISO 3166-1 alpha-2)(2 digitos) - `state` string: Estado (Código do estado no formato ISO 3166-2). - `city` string: Cidade. - `zip_code` string: Código Postal (CEP) (Apenas numérico). - `line_1` string: Dados principais do endereço. Neste campo deve ser informado Número, Rua, Bairro, nesta ordem e separados por vírgula. - `line_2` string: Dados complementares do endereço. Neste campo pode ser informado complemento, referências. - `phones` object: Telefone residencial do cliente. - `home_phone` object: Telefone residencial do cliente. - `country_code` string: Código do País (Apenas numérico). - `area_code` string: Código da área (Apenas numérico). - `number` string: Número do telefone (Apenas numérico). - `mobile_phone` object: Telefone celular do cliente. - `country_code` string: Código do País (Apenas numérico). - `area_code` string: Código da área (Apenas numérico). - `number` string: Número do telefone (Apenas numérico). - `birthdate` string, date: Data de nascimento do cliente. - `metadata` string: Objeto chave/valor utilizado para armazenar informações adicionais sobre o cliente. - `cart_settings` object, required: Define os dados do carrinho que será pago pelo link de pagamento. - `shipping_cost` integer: Valor de entrega, em centavos - `items` object[]: Define os itens que estão inclusos no carrinho que será pago pelo link. - `name` string, required: Nome do item. - `description` string: Descrição do item. Máximo de xxx caracteres - `amount` integer, required: Valor unitário do item, em centavos. - `shipping_cost` integer: Valor de entrega do item, em centavos. - `default_quantity` integer, required: Quantidade de itens. - `recurrences` object[]: Define as configurações da recorrência que será gerada a partir do pagamento do link. - `plan_id` string: Id do plano com as configurações da assinatura que será gerada. - `plan` object: Dados do plano da assinatura que será gerada. Não deverá ser enviado caso o campo "plan_id" seja definido. - `start_in` integer: Data de início da assinatura, em dias. Não deverá ser enviado caso o campo "start_at" seja definido. - `start_at` string, date: Data de início da assinatura. Não deverá ser enviado caso o campo "start_in" seja definido. - `setup` object: Objeto que permite configurar uma taxa de adesão cobrada antes da criação da assinatura. - `amount` integer, required: Valor da taxa de adesão - `description` string, required: Descrição da taxa de adesão. Ex.: Matrícula - `payment_method` 'credit_card', required: meio de pagamento utilizado - `layout_settings` object: Dados de layout. - `image_url` string: Logo que será utilizado no checkout. - `primary_color` string: Cor primária que será aplicada no checkout, em hexadecimal. - `secondary_color` string: Cor secundária que será aplicada no checkout. ## Response `200` 200 ## Other responses - `400`: 400 ## Changes - **2026-11-03** `ef323290c0ff`: 1 info - endpoint added [Operation history](https://skmtc.dev/pagar/apis/pagarme-api/changes/paymentlinks./post.md) --- [API](https://skmtc.dev/pagar/apis/pagarme-api.md) - [All operations](https://skmtc.dev/pagar/apis/pagarme-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pagar/apis/pagarme-api/revisions/ef323290c0ff?raw)