Criar um link de pagamento.

Cria um link de pagamento e devolve a URL de checkout no campo `url` — é para lá que você manda o comprador. O estabelecimento vem da API key, nunca do corpo. Confira `payment_methods` na resposta: é o que o link realmente oferece, e pode vir menor que o pedido. Exige a permissão payment_links:create.

Cria um link de pagamento e devolve a URL de checkout no campo url — é para lá que você manda o comprador. O estabelecimento vem da API key, nunca do corpo. Confira payment_methods na resposta: é o que o link realmente oferece, e pode vir menor que o pedido. Exige a permissão payment_links:create.

Autorização

ApiKeyAuth

AutorizaçãoBearer <token>

Em: header

Parâmetros de cabeçalho

Idempotency-Key?string

Tamanho1 <= length <= 255

Corpo da requisição

application/json

Definições TypeScript

Use o tipo request body em TypeScript.

name*string

Como o link aparece para você no painel e nas listagens (2 a 140 caracteres). Não é o que o comprador lê quando o link tem extrato ou reserva.

Tamanho2 <= length <= 140

amount_cents*integer

Preço do link na menor unidade de currency (R$ 49,90 -> 4990). É sempre este o valor cobrado.

Intervalo1 <= value

payment_methods?array<>

Meios que o link oferece: CREDIT_CARD, PIX e/ou BOLETO. Omita para oferecer todos os disponíveis. Confira payment_methods na RESPOSTA: é o que o link realmente oferece, e pode vir menor que o pedido.

Items1 <= items

max_installments?integer

Até quantas parcelas oferecer (1 a 24). Omitido, o link é à vista. O valor é rebaixado na criação, nunca recusado — cada parcela precisa ter ao menos R$ 5,00, então um link de R$ 10,00 pedindo 12x é gravado como 2x. Leia max_installments na resposta para saber o teto que valeu.

Intervalo1 <= value <= 24

discounts?

Desconto por meio de pagamento: {"pix": {"bps": 500}} para 5% no PIX, ou {"amount_cents": 1000} para R$ 10 fixos. Mande EXATAMENTE UM dos dois por meio. Só pix e credit_card, e no cartão vale só à vista. O desconto sai do seu faturamento: a cobrança nasce já no valor descontado.

capture_method?string

automatic cobra na hora; manual autoriza agora e você captura depois. Padrão automatic.

Value in

"automatic"
"manual"

expires_at?|

Data-hora ISO 8601 (UTC) em que o link para de aceitar pagamento, ou null para não expirar.

Formatodate-time

customer_name?string

Nome do comprador, pré-preenchido no checkout.

Tamanho1 <= length <= 255

customer_email?string

E-mail do comprador, pré-preenchido no checkout.

Formatoemail

Tamanholength <= 255

customer_document?string

Documento do comprador, pré-preenchido: CPF ou CNPJ num link doméstico, com ou sem máscara; documento nacional ou passaporte num link marcado como estrangeiro. Num link doméstico, letra é recusada.

reservation?

Reserva de hospedagem vendida por este link — o mesmo objeto de POST /charges. Exige a conta habilitada para hotelaria. No checkout, a reserva assume o topo da página, no lugar do nome do link.

foreign_customer?boolean

Abre o checkout no formato de fora (documento do país, telefone com DDI, endereço sem CEP) em vez de pedir CPF a quem não tem. É só o estado INICIAL: o comprador pode trocar o país na própria página.

customer_country?string

País do comprador (ISO 3166-1 alfa-2) para já deixar selecionado. Qualquer país diferente de BR já implica foreign_customer: true; mandar os dois em desacordo é recusado.

Tamanho2 <= length <= 2

currency?string

Moeda que o comprador vê. Padrão BRL; as demais precisam estar liberadas para a sua conta. A COBRANÇA sai sempre em BRL, com a cotação congelada na venda. Link em moeda estrangeira é só cartão e só à vista — recusado na criação, não na hora de pagar.

Value in

"BRL"
"USD"
"EUR"
"GBP"
"CHF"
"CAD"
"MXN"
"ARS"
"CLP"
"COP"
"PEN"

display?

O que o COMPRADOR vê no checkout: o extrato do pedido, a capa do que está sendo vendido e avisos secundários. Opcional campo a campo — sem ele a página fica como sempre foi. NADA aqui move dinheiro: quem cobra é amount_cents, e isto só descreve. A única trava é de coerência e vale na criação: havendo line_items, a soma das linhas tem que bater com amount_cents, senão a criação é recusada com 422. O documento é guardado e devolvido exatamente como você mandou — então não coloque aqui nada que o comprador não deva ler. Teto de 32 KB.

Corpo da resposta

`application/json`

curl -X POST "https://example.com/payment-links" \  -H "Idempotency-Key: order_123_attempt_1" \  -H "Content-Type: application/json" \  -d '{    "name": "Assinatura Pro",    "amount_cents": 4990,    "payment_methods": [      "CREDIT_CARD",      "PIX"    ]  }'

{  "object": "payment_link",  "id": "string",  "name": "string",  "status": "ACTIVE",  "amount_cents": 0,  "currency": "string",  "max_installments": 0,  "installment_options": [    {      "installments": 0,      "per_installment_cents": 0,      "total_cents": 0,      "has_interest": true    }  ],  "method_prices": [    {      "method": "credit_card",      "amount_cents": 0,      "discount_amount_cents": 0,      "discount_percent_bps": 0    }  ],  "capture_method": "automatic",  "payment_methods": [    "credit_card"  ],  "expires_at": "2019-08-24T14:15:22Z",  "merchant": {    "name": "string"  },  "created_at": "2019-08-24T14:15:22Z",  "url": "http://example.com",  "request_id": "string",  "reservation": {    "check_in": "2019-08-24",    "check_out": "2019-08-24",    "nights": 0,    "code": "string"  },  "customer_defaults": {    "foreign": true,    "country": "string"  },  "display": {    "price_is_final": true,    "line_items": [      {        "kind": "item",        "description": "string",        "amount_cents": 0,        "quantity": 1,        "unit_amount_cents": 0,        "image_url": "string"      }    ],    "cover": {      "image_url": "string",      "logo_url": "string",      "title": "string",      "subtitle": "string",      "caption": "string"    },    "disclosures": [      {        "title": "string",        "summary": "string",        "body": "string"      }    ]  },  "charge_id": "string"}

Criar um link de pagamento.

Autorização

Parâmetros de cabeçalho

Corpo da requisição

Corpo da resposta

201application/json

401application/json

403application/json

409application/json

422application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`