Deactivate a payment link
curl --request POST \
--url https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}/deactivateimport requests
url = "https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}/deactivate"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}/deactivate', 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}/deactivate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$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}/deactivate"
req, _ := http.NewRequest("POST", url, nil)
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.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}/deactivate")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}/deactivate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"id": "5c1e8d2a-7b4f-4e3a-9d6c-2a1b0f9e8d7c",
"name": "Plano anual",
"status": "DEACTIVATED",
"products": [
{
"product": "8c7d6e5f-4a3b-4c2d-9e1f-0a9b8c7d6e5f",
"quantity": 1
}
],
"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-28T09:15:00.000Z"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "PAYMENT_LINK_NOT_FOUND",
"origin": "BILLING",
"message": "Payment link not found"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "PAYMENT_LINK_CONCURRENT_UPDATE",
"origin": "BILLING",
"message": "Payment link was changed concurrently, try again"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "PAYMENT_LINK_EXPIRED",
"origin": "BILLING",
"message": "Payment link is expired"
}Deactivate a payment link
Deactivates an active payment link: its checkout page stops accepting payers.
POST
/
realms
/
{realmId}
/
organizations
/
{organizationId}
/
payment-links
/
{paymentLinkId}
/
deactivate
Deactivate a payment link
curl --request POST \
--url https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}/deactivateimport requests
url = "https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}/deactivate"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}/deactivate', 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}/deactivate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$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}/deactivate"
req, _ := http.NewRequest("POST", url, nil)
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.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}/deactivate")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.billing.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}/deactivate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"id": "5c1e8d2a-7b4f-4e3a-9d6c-2a1b0f9e8d7c",
"name": "Plano anual",
"status": "DEACTIVATED",
"products": [
{
"product": "8c7d6e5f-4a3b-4c2d-9e1f-0a9b8c7d6e5f",
"quantity": 1
}
],
"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-28T09:15:00.000Z"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "PAYMENT_LINK_NOT_FOUND",
"origin": "BILLING",
"message": "Payment link not found"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "PAYMENT_LINK_CONCURRENT_UPDATE",
"origin": "BILLING",
"message": "Payment link was changed concurrently, try again"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "PAYMENT_LINK_EXPIRED",
"origin": "BILLING",
"message": "Payment link is expired"
}Send no body and no
Content-Type (or the body {}). Checkouts already made are not affected, and the link can be activated again. Deactivating a link that is already DEACTIVATED changes nothing and answers it as it is; an EXPIRED link can’t be deactivated.
Any member of the organization, or an admin of the realm, can deactivate one; updatedBy is set to the ID of the authenticated caller. Answers the link.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.
ID of the payment link. The checkout page of the link is addressed by it.
Example:
"5c1e8d2a-7b4f-4e3a-9d6c-2a1b0f9e8d7c"
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:
"DEACTIVATED"
What the link sells.
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-28T09:15:00.000Z"