Bunne Docs
Links de Pagamento

Consultar um link de pagamento.

Devolve o mesmo objeto `payment_link` da criação, atualizado: o `status` de agora, os meios que o link oferece neste momento e o `receipt` depois de pago. Serve para você montar a sua própria tela sobre um link que criou. Este endpoint NÃO leva API key: o código do link é a credencial, e a resposta só traz o que a página de checkout já mostra a qualquer comprador. Nunca coloque dado privado num link que você vai compartilhar. Tem limite por IP. Para saber que um link foi pago, assine o webhook `charge.paid` em vez de ficar consultando aqui.

GET
/payment-links/{code}

Devolve o mesmo objeto payment_link da criação, atualizado: o status de agora, os meios que o link oferece neste momento e o receipt depois de pago. Serve para você montar a sua própria tela sobre um link que criou.

Este endpoint NÃO leva API key: o código do link é a credencial, e a resposta só traz o que a página de checkout já mostra a qualquer comprador. Nunca coloque dado privado num link que você vai compartilhar.

Tem limite por IP. Para saber que um link foi pago, assine o webhook charge.paid em vez de ficar consultando aqui.

Parâmetros de caminho

code*string
Match^pl_[A-Za-z0-9]+$

Corpo da resposta

application/json

application/json

curl -X GET "https://example.com/payment-links/pl_4b59973ecad94eeca6f86a7942d8d334"
{  "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. POST

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.

Simular as opções de parcelamento de uma venda. GET

Retorna todas as opções de parcelamento que o estabelecimento oferece para um preço à vista, com o valor de cada parcela e o total que o comprador pagaria. Feito para quem tem checkout PRÓPRIO: renderize a lista, deixe o comprador escolher o número de parcelas e mande só esse número para POST /v1/charges — o valor cobrado é sempre derivado no servidor, a partir da tabela de taxas do estabelecimento, nunca aceito do cliente. Quando o estabelecimento repassa o juros do parcelado ao comprador, o `amount_cents` daqui é o preço À VISTA e as opções acima de `interest_free_installments` custam mais que ele. Exige a permissão charges:create e uma key com escopo de seller. Cada parcela precisa ter pelo menos R$ 5,00, então o próprio valor limita o plano: abaixo de R$ 10,00 só há à vista, R$ 10,00 permite até 2x, e assim por diante.