curl --request POST \
--url https://api-sandbox.beinfi.com/products/{productID}/payment-links \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"successUrl": "<string>",
"cancelUrl": "<string>",
"productVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api-sandbox.beinfi.com/products/{productID}/payment-links"
payload = {
"successUrl": "<string>",
"cancelUrl": "<string>",
"productVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
successUrl: '<string>',
cancelUrl: '<string>',
productVersionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api-sandbox.beinfi.com/products/{productID}/payment-links', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.beinfi.com/products/{productID}/payment-links",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'successUrl' => '<string>',
'cancelUrl' => '<string>',
'productVersionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.beinfi.com/products/{productID}/payment-links"
payload := strings.NewReader("{\n \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\",\n \"productVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.beinfi.com/products/{productID}/payment-links")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\",\n \"productVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.beinfi.com/products/{productID}/payment-links")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\",\n \"productVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"token": "<string>",
"url": "<string>",
"productVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"active": true,
"revokedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"successUrl": "<string>",
"cancelUrl": "<string>"
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>"
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>",
"resource": "<string>"
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>",
"errors": [
{
"field": "<string>",
"value": "<string>",
"constraint": "<string>",
"description": "<string>"
}
]
}Criar link de pagamento
Cria um link reutilizável e revogável para este produto. Use a url da resposta; o link não tem pagador, e cliente e fatura (ou assinatura) nascem quando alguém paga.
Exige uma versão publicada. Publicar a versão já cria o primeiro link; use esta rota para links adicionais, para links com successUrl / cancelUrl, ou para vender uma oferta com productVersionId.
curl --request POST \
--url https://api-sandbox.beinfi.com/products/{productID}/payment-links \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"successUrl": "<string>",
"cancelUrl": "<string>",
"productVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api-sandbox.beinfi.com/products/{productID}/payment-links"
payload = {
"successUrl": "<string>",
"cancelUrl": "<string>",
"productVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
successUrl: '<string>',
cancelUrl: '<string>',
productVersionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api-sandbox.beinfi.com/products/{productID}/payment-links', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.beinfi.com/products/{productID}/payment-links",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'successUrl' => '<string>',
'cancelUrl' => '<string>',
'productVersionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.beinfi.com/products/{productID}/payment-links"
payload := strings.NewReader("{\n \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\",\n \"productVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.beinfi.com/products/{productID}/payment-links")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\",\n \"productVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.beinfi.com/products/{productID}/payment-links")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\",\n \"productVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"token": "<string>",
"url": "<string>",
"productVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"active": true,
"revokedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"successUrl": "<string>",
"cancelUrl": "<string>"
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>"
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>",
"resource": "<string>"
}{
"message": "<string>",
"error_code": "internal_error",
"tracer_id": "<string>",
"errors": [
{
"field": "<string>",
"value": "<string>",
"constraint": "<string>",
"description": "<string>"
}
]
}Autorizações
Chave secreta da conta: Authorization: Bearer sk_test_… ou sk_live_…. Use só no servidor.
Parâmetros de caminho
ID do produto.
Corpo
Opcional. Um link não precisa de configuração; envie corpo só para definir para onde o pagador vai depois, ou para vender uma oferta. As URLs precisam ser absolutas http(s).
Para onde o pagador vai depois de pagar, com ?status=success&invoice=… anexado.
2048Oferecido ao pagador como "voltar para a loja" enquanto o checkout está aberto.
2048Vende uma versão publicada específica em vez da padrão. É assim que um preço promocional chega ao comprador: a versão é publicada com default: false e só um link que a indique consegue vendê-la. Omita para vender a versão padrão. Recusado se a versão não for uma versão publicada deste produto.
Resposta
Link criado.
Um link de pagamento reutilizável e revogável, ligado a um produto. Quem tem o link pode abrir o checkout; ele é feito para ser copiado e compartilhado.
Token público do link, parte da url.
O endereço para mandar ao pagador. Use este valor em vez de montar a URL.
A versão do produto que o link vende, fixada na criação. Publicar uma nova versão não altera o preço de um link já emitido. Quando null, o link vende a versão publicada mais recente no momento do pagamento.
false depois de revogado.
Quando o link foi revogado.
Para onde o pagador vai depois de pagar, com ?status=success&invoice=… anexado.
Oferecido ao pagador como "voltar para a loja" enquanto o checkout está aberto; também é o destino com ?status=error quando a cobrança expira no checkout embutido.