Criar link com produto
curl --request POST \
--url https://api-sandbox.beinfi.com/payment-links \
--header 'Content-Type: application/json' \
--data '
{
"product": {
"key": "<string>",
"name": "<string>",
"description": "<string>",
"currency": "<string>",
"basePrice": "<string>",
"meters": [
{
"name": "<string>",
"displayName": "<string>",
"aggregation": "sum",
"valueProperty": "<string>"
}
],
"prices": [
{
"meter": "<string>",
"unitAmount": "<string>",
"tiers": [
{
"unitAmount": "<string>",
"upTo": "<string>",
"flatAmount": "<string>",
"size": "<string>"
}
],
"currency": "<string>"
}
]
},
"successUrl": "<string>",
"cancelUrl": "<string>"
}
'import requests
url = "https://api-sandbox.beinfi.com/payment-links"
payload = {
"product": {
"key": "<string>",
"name": "<string>",
"description": "<string>",
"currency": "<string>",
"basePrice": "<string>",
"meters": [
{
"name": "<string>",
"displayName": "<string>",
"aggregation": "sum",
"valueProperty": "<string>"
}
],
"prices": [
{
"meter": "<string>",
"unitAmount": "<string>",
"tiers": [
{
"unitAmount": "<string>",
"upTo": "<string>",
"flatAmount": "<string>",
"size": "<string>"
}
],
"currency": "<string>"
}
]
},
"successUrl": "<string>",
"cancelUrl": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
product: {
key: '<string>',
name: '<string>',
description: '<string>',
currency: '<string>',
basePrice: '<string>',
meters: [
{
name: '<string>',
displayName: '<string>',
aggregation: 'sum',
valueProperty: '<string>'
}
],
prices: [
{
meter: '<string>',
unitAmount: '<string>',
tiers: [
{
unitAmount: '<string>',
upTo: '<string>',
flatAmount: '<string>',
size: '<string>'
}
],
currency: '<string>'
}
]
},
successUrl: '<string>',
cancelUrl: '<string>'
})
};
fetch('https://api-sandbox.beinfi.com/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/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([
'product' => [
'key' => '<string>',
'name' => '<string>',
'description' => '<string>',
'currency' => '<string>',
'basePrice' => '<string>',
'meters' => [
[
'name' => '<string>',
'displayName' => '<string>',
'aggregation' => 'sum',
'valueProperty' => '<string>'
]
],
'prices' => [
[
'meter' => '<string>',
'unitAmount' => '<string>',
'tiers' => [
[
'unitAmount' => '<string>',
'upTo' => '<string>',
'flatAmount' => '<string>',
'size' => '<string>'
]
],
'currency' => '<string>'
]
]
],
'successUrl' => '<string>',
'cancelUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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/payment-links"
payload := strings.NewReader("{\n \"product\": {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"currency\": \"<string>\",\n \"basePrice\": \"<string>\",\n \"meters\": [\n {\n \"name\": \"<string>\",\n \"displayName\": \"<string>\",\n \"aggregation\": \"sum\",\n \"valueProperty\": \"<string>\"\n }\n ],\n \"prices\": [\n {\n \"meter\": \"<string>\",\n \"unitAmount\": \"<string>\",\n \"tiers\": [\n {\n \"unitAmount\": \"<string>\",\n \"upTo\": \"<string>\",\n \"flatAmount\": \"<string>\",\n \"size\": \"<string>\"\n }\n ],\n \"currency\": \"<string>\"\n }\n ]\n },\n \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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/payment-links")
.header("Content-Type", "application/json")
.body("{\n \"product\": {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"currency\": \"<string>\",\n \"basePrice\": \"<string>\",\n \"meters\": [\n {\n \"name\": \"<string>\",\n \"displayName\": \"<string>\",\n \"aggregation\": \"sum\",\n \"valueProperty\": \"<string>\"\n }\n ],\n \"prices\": [\n {\n \"meter\": \"<string>\",\n \"unitAmount\": \"<string>\",\n \"tiers\": [\n {\n \"unitAmount\": \"<string>\",\n \"upTo\": \"<string>\",\n \"flatAmount\": \"<string>\",\n \"size\": \"<string>\"\n }\n ],\n \"currency\": \"<string>\"\n }\n ]\n },\n \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.beinfi.com/payment-links")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"product\": {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"currency\": \"<string>\",\n \"basePrice\": \"<string>\",\n \"meters\": [\n {\n \"name\": \"<string>\",\n \"displayName\": \"<string>\",\n \"aggregation\": \"sum\",\n \"valueProperty\": \"<string>\"\n }\n ],\n \"prices\": [\n {\n \"meter\": \"<string>\",\n \"unitAmount\": \"<string>\",\n \"tiers\": [\n {\n \"unitAmount\": \"<string>\",\n \"upTo\": \"<string>\",\n \"flatAmount\": \"<string>\",\n \"size\": \"<string>\"\n }\n ],\n \"currency\": \"<string>\"\n }\n ]\n },\n \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"productId": "prod_1d4YogBuw00jAySh5mbUpk",
"token": "<string>",
"active": true,
"appearance": {
"accentColor": "#DC2626",
"backgroundColor": "#111827",
"font": "system"
},
"createdAt": "2023-11-07T05:31:56Z",
"url": "<string>",
"productVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revokedAt": "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>",
"errors": [
{
"field": "<string>",
"value": "<string>",
"constraint": "<string>",
"description": "<string>"
}
]
}Catálogo
Criar link com produto
Do zero a uma URL pagável numa chamada só. O produto é identificado pela key: uma chave nova cria o produto, uma conhecida reaproveita, e um preço diferente do atual publica uma nova versão. Links já compartilhados continuam vendendo o preço que anunciavam.
Cada chamada cria um link novo, então dá para ter uma URL por campanha. A resposta traz a url para mandar ao pagador; não precisa informar o slug da conta.
POST
/
payment-links
Criar link com produto
curl --request POST \
--url https://api-sandbox.beinfi.com/payment-links \
--header 'Content-Type: application/json' \
--data '
{
"product": {
"key": "<string>",
"name": "<string>",
"description": "<string>",
"currency": "<string>",
"basePrice": "<string>",
"meters": [
{
"name": "<string>",
"displayName": "<string>",
"aggregation": "sum",
"valueProperty": "<string>"
}
],
"prices": [
{
"meter": "<string>",
"unitAmount": "<string>",
"tiers": [
{
"unitAmount": "<string>",
"upTo": "<string>",
"flatAmount": "<string>",
"size": "<string>"
}
],
"currency": "<string>"
}
]
},
"successUrl": "<string>",
"cancelUrl": "<string>"
}
'import requests
url = "https://api-sandbox.beinfi.com/payment-links"
payload = {
"product": {
"key": "<string>",
"name": "<string>",
"description": "<string>",
"currency": "<string>",
"basePrice": "<string>",
"meters": [
{
"name": "<string>",
"displayName": "<string>",
"aggregation": "sum",
"valueProperty": "<string>"
}
],
"prices": [
{
"meter": "<string>",
"unitAmount": "<string>",
"tiers": [
{
"unitAmount": "<string>",
"upTo": "<string>",
"flatAmount": "<string>",
"size": "<string>"
}
],
"currency": "<string>"
}
]
},
"successUrl": "<string>",
"cancelUrl": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
product: {
key: '<string>',
name: '<string>',
description: '<string>',
currency: '<string>',
basePrice: '<string>',
meters: [
{
name: '<string>',
displayName: '<string>',
aggregation: 'sum',
valueProperty: '<string>'
}
],
prices: [
{
meter: '<string>',
unitAmount: '<string>',
tiers: [
{
unitAmount: '<string>',
upTo: '<string>',
flatAmount: '<string>',
size: '<string>'
}
],
currency: '<string>'
}
]
},
successUrl: '<string>',
cancelUrl: '<string>'
})
};
fetch('https://api-sandbox.beinfi.com/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/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([
'product' => [
'key' => '<string>',
'name' => '<string>',
'description' => '<string>',
'currency' => '<string>',
'basePrice' => '<string>',
'meters' => [
[
'name' => '<string>',
'displayName' => '<string>',
'aggregation' => 'sum',
'valueProperty' => '<string>'
]
],
'prices' => [
[
'meter' => '<string>',
'unitAmount' => '<string>',
'tiers' => [
[
'unitAmount' => '<string>',
'upTo' => '<string>',
'flatAmount' => '<string>',
'size' => '<string>'
]
],
'currency' => '<string>'
]
]
],
'successUrl' => '<string>',
'cancelUrl' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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/payment-links"
payload := strings.NewReader("{\n \"product\": {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"currency\": \"<string>\",\n \"basePrice\": \"<string>\",\n \"meters\": [\n {\n \"name\": \"<string>\",\n \"displayName\": \"<string>\",\n \"aggregation\": \"sum\",\n \"valueProperty\": \"<string>\"\n }\n ],\n \"prices\": [\n {\n \"meter\": \"<string>\",\n \"unitAmount\": \"<string>\",\n \"tiers\": [\n {\n \"unitAmount\": \"<string>\",\n \"upTo\": \"<string>\",\n \"flatAmount\": \"<string>\",\n \"size\": \"<string>\"\n }\n ],\n \"currency\": \"<string>\"\n }\n ]\n },\n \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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/payment-links")
.header("Content-Type", "application/json")
.body("{\n \"product\": {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"currency\": \"<string>\",\n \"basePrice\": \"<string>\",\n \"meters\": [\n {\n \"name\": \"<string>\",\n \"displayName\": \"<string>\",\n \"aggregation\": \"sum\",\n \"valueProperty\": \"<string>\"\n }\n ],\n \"prices\": [\n {\n \"meter\": \"<string>\",\n \"unitAmount\": \"<string>\",\n \"tiers\": [\n {\n \"unitAmount\": \"<string>\",\n \"upTo\": \"<string>\",\n \"flatAmount\": \"<string>\",\n \"size\": \"<string>\"\n }\n ],\n \"currency\": \"<string>\"\n }\n ]\n },\n \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.beinfi.com/payment-links")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"product\": {\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"currency\": \"<string>\",\n \"basePrice\": \"<string>\",\n \"meters\": [\n {\n \"name\": \"<string>\",\n \"displayName\": \"<string>\",\n \"aggregation\": \"sum\",\n \"valueProperty\": \"<string>\"\n }\n ],\n \"prices\": [\n {\n \"meter\": \"<string>\",\n \"unitAmount\": \"<string>\",\n \"tiers\": [\n {\n \"unitAmount\": \"<string>\",\n \"upTo\": \"<string>\",\n \"flatAmount\": \"<string>\",\n \"size\": \"<string>\"\n }\n ],\n \"currency\": \"<string>\"\n }\n ]\n },\n \"successUrl\": \"<string>\",\n \"cancelUrl\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"productId": "prod_1d4YogBuw00jAySh5mbUpk",
"token": "<string>",
"active": true,
"appearance": {
"accentColor": "#DC2626",
"backgroundColor": "#111827",
"font": "system"
},
"createdAt": "2023-11-07T05:31:56Z",
"url": "<string>",
"productVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revokedAt": "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>",
"errors": [
{
"field": "<string>",
"value": "<string>",
"constraint": "<string>",
"description": "<string>"
}
]
}Corpo
application/json
O produto, definido na própria chamada e identificado pela key.
Show child attributes
Show child attributes
Para onde o pagador vai depois de pagar, com ?status=success&invoice=… anexado. URL absoluta http(s).
Maximum string length:
2048Oferecido ao pagador como "voltar para a loja" enquanto o checkout está aberto. URL absoluta http(s).
Maximum string length:
2048Resposta
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.
Pattern:
^prod_[0-9A-Za-z]{22}$Exemplo:
"prod_1d4YogBuw00jAySh5mbUpk"
Token público do link, parte da url.
false depois de revogado.
Show child attributes
Show child attributes
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.
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.