Get a payment link
curl --request GET \
--url https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}import requests
url = "https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}', 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.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "5c1e8d2a-7b4f-4e3a-9d6c-2a1b0f9e8d7c",
"realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
"organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
"name": "Plano anual",
"status": "ACTIVE",
"products": [
{
"product": "8c7d6e5f-4a3b-4c2d-9e1f-0a9b8c7d6e5f",
"quantity": 1,
"name": "Plano anual",
"price": 15000
}
],
"expirationDate": "2026-12-31T00:00:00.000Z",
"type": "ONE_TIME",
"paymentMethod": [
"PIX"
],
"secondaryPaymentMethod": [
"PIX"
],
"description": "Acesso completo por 12 meses.",
"firstPaymentDate": {
"pix": "SAME_DAY",
"bankSlip": "FIVE_DAYS",
"pixAutomatic": "TEN_DAYS"
},
"numberOfInstallments": null,
"createdAt": "2026-10-26T14:30:00.000Z",
"updatedAt": "2026-10-26T14:30:00.000Z",
"createdBy": "60242bfd-228e-43e2-8c18-6dc40746eb69",
"updatedBy": "60242bfd-228e-43e2-8c18-6dc40746eb69"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "PAYMENT_LINK_NOT_FOUND",
"origin": "BILLING",
"message": "Payment link not found"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "BILLING",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "paymentLinkId",
"message": "Invalid UUID",
"code": "PAYMENTLINKID_UUID"
}
]
}Get a payment link
Returns one payment link of your organization, with its products’ current names and prices.
GET
/
realms
/
{realmId}
/
organizations
/
{organizationId}
/
payment-links
/
{paymentLinkId}
Get a payment link
curl --request GET \
--url https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}import requests
url = "https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}', 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.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "5c1e8d2a-7b4f-4e3a-9d6c-2a1b0f9e8d7c",
"realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
"organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
"name": "Plano anual",
"status": "ACTIVE",
"products": [
{
"product": "8c7d6e5f-4a3b-4c2d-9e1f-0a9b8c7d6e5f",
"quantity": 1,
"name": "Plano anual",
"price": 15000
}
],
"expirationDate": "2026-12-31T00:00:00.000Z",
"type": "ONE_TIME",
"paymentMethod": [
"PIX"
],
"secondaryPaymentMethod": [
"PIX"
],
"description": "Acesso completo por 12 meses.",
"firstPaymentDate": {
"pix": "SAME_DAY",
"bankSlip": "FIVE_DAYS",
"pixAutomatic": "TEN_DAYS"
},
"numberOfInstallments": null,
"createdAt": "2026-10-26T14:30:00.000Z",
"updatedAt": "2026-10-26T14:30:00.000Z",
"createdBy": "60242bfd-228e-43e2-8c18-6dc40746eb69",
"updatedBy": "60242bfd-228e-43e2-8c18-6dc40746eb69"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "PAYMENT_LINK_NOT_FOUND",
"origin": "BILLING",
"message": "Payment link not found"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "BILLING",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "paymentLinkId",
"message": "Invalid UUID",
"code": "PAYMENTLINKID_UUID"
}
]
}products carries each product’s current name and price (in centavos) from your organization’s catalog — both absent for a product the catalog no longer has. Any member of the organization, or an admin of the realm, can read it.Path Parameters
ID of your realm.
Format: UUID
ID of your organization: the one that sells through the link.
Format: UUID
ID of the payment link.
Format: UUID
Response
Successful response
A payment link, with its products' current names and prices.
ID of the payment link. The checkout page of the link is addressed by it.
Example:
"5c1e8d2a-7b4f-4e3a-9d6c-2a1b0f9e8d7c"
ID of your realm.
Example:
"f495ff0c-ab54-4f99-8e92-ca8682e4de9b"
ID of your organization.
Example:
"c4bd3f21-dfbd-44e8-8055-68ba15bed410"
Name of the link.
Example:
"Plano anual"
ACTIVE: payers can check out. DEACTIVATED: switched off; it can be activated again. EXPIRED: its expirationDate passed; final.
Available options:
ACTIVE, DEACTIVATED, EXPIRED Example:
"ACTIVE"
What the link sells, with each product's current name and price.
Show child attributes
Show child attributes
Last day the link can be paid (midnight UTC of that day), or null when it never expires.
Example:
"2026-12-31T00:00:00.000Z"
ONE_TIME: each checkout charges once. RECURRENT: monthly, numberOfInstallments times.
Available options:
RECURRENT, ONE_TIME Example:
"ONE_TIME"
The ways the payer can choose from at checkout.
Example: ["PIX","BANK_SLIP"]
Available options:
BANK_SLIP, PIX_INITIATION, PIX, PIX_AUTOMATIC Other ways each invoice can also be paid. Empty when there are none.
Example: ["PIX"]
Available options:
BANK_SLIP, PIX_INITIATION, PIX, PIX_AUTOMATIC What the link sells. Absent when it has none.
Example:
"Acesso completo por 12 meses."
When the first payment of a checkout is due, per payment method.
Show child attributes
Show child attributes
How many monthly payments a checkout of a RECURRENT link creates, or null (1).
Example:
null
When the link was created.
Example:
"2026-10-26T14:30:00.000Z"
When the link was last changed.
Example:
"2026-10-26T14:30:00.000Z"
ID of the user who created the link. Absent on links created before it was recorded.
Example:
"60242bfd-228e-43e2-8c18-6dc40746eb69"
ID of the user who last changed the link. Absent on links never changed since it was recorded.
Example:
"60242bfd-228e-43e2-8c18-6dc40746eb69"