curl --request GET \
--url https://mapi.zbx.boomfi.xyz/v1/paylinks \
--header 'X-API-KEY: <api-key>'import requests
url = "https://mapi.zbx.boomfi.xyz/v1/paylinks"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://mapi.zbx.boomfi.xyz/v1/paylinks', 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://mapi.zbx.boomfi.xyz/v1/paylinks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$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://mapi.zbx.boomfi.xyz/v1/paylinks"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://mapi.zbx.boomfi.xyz/v1/paylinks")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://mapi.zbx.boomfi.xyz/v1/paylinks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"items": [
{
"after_completion": {
"custom_message": "<string>",
"failure_redirect_url": "https://merchant.example/checkout/failed",
"redirect_url": "https://merchant.example/checkout/success",
"type": "redirect"
},
"created_at": "<string>",
"created_by": "<string>",
"customer_ident_collection": true,
"deleted_at": "<string>",
"enabled": true,
"id": "<string>",
"invoice_id": "<string>",
"metadata": {},
"plan": {
"available_quantity": 123,
"billing_scheme": "FlatFee",
"created_at": "<string>",
"created_by": "<string>",
"currency": "<string>",
"deleted_at": "<string>",
"enabled": true,
"expires_at": "<string>",
"id": "<string>",
"metadata": {},
"name": "<string>",
"org_id": "<string>",
"payment_link": {
"after_completion": {},
"created_at": "<string>",
"created_by": "<string>",
"customer_ident_collection": true,
"deleted_at": "<string>",
"enabled": true,
"id": "<string>",
"invoice_id": "<string>",
"metadata": {},
"plan_id": "<string>",
"properties": {},
"shipping_address_collection": true,
"source": "Lago",
"tax_ident_collection": true,
"updated_at": "<string>",
"updated_by": "<string>"
},
"price": "<string>",
"properties": {},
"recurring_interval": "Unknown",
"recurring_interval_count": 123,
"recurring_usage_type": "Unknown",
"reference": "<string>",
"source": "Lago",
"trial_period": "<string>",
"type": "Unknown",
"updated_at": "<string>"
},
"plan_id": "<string>",
"properties": {},
"shipping_address_collection": true,
"source": "Lago",
"tax_ident_collection": true,
"updated_at": "<string>",
"updated_by": "<string>",
"url": "<string>"
}
],
"last_update": "2021-01-01T00:00:00.000Z",
"next": 10,
"total": 10
},
"error": true
}{
"error": {
"code": 400,
"errors": [
{
"domain": "orders",
"reason": "InsufficientQuantity"
}
],
"message": "Insufficient quantity"
}
}{
"error": {
"code": 400,
"errors": [
{
"domain": "orders",
"reason": "InsufficientQuantity"
}
],
"message": "Insufficient quantity"
}
}List Paylinks
List paylinks with optional reference, search, and status filters
curl --request GET \
--url https://mapi.zbx.boomfi.xyz/v1/paylinks \
--header 'X-API-KEY: <api-key>'import requests
url = "https://mapi.zbx.boomfi.xyz/v1/paylinks"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://mapi.zbx.boomfi.xyz/v1/paylinks', 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://mapi.zbx.boomfi.xyz/v1/paylinks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$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://mapi.zbx.boomfi.xyz/v1/paylinks"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://mapi.zbx.boomfi.xyz/v1/paylinks")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://mapi.zbx.boomfi.xyz/v1/paylinks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"items": [
{
"after_completion": {
"custom_message": "<string>",
"failure_redirect_url": "https://merchant.example/checkout/failed",
"redirect_url": "https://merchant.example/checkout/success",
"type": "redirect"
},
"created_at": "<string>",
"created_by": "<string>",
"customer_ident_collection": true,
"deleted_at": "<string>",
"enabled": true,
"id": "<string>",
"invoice_id": "<string>",
"metadata": {},
"plan": {
"available_quantity": 123,
"billing_scheme": "FlatFee",
"created_at": "<string>",
"created_by": "<string>",
"currency": "<string>",
"deleted_at": "<string>",
"enabled": true,
"expires_at": "<string>",
"id": "<string>",
"metadata": {},
"name": "<string>",
"org_id": "<string>",
"payment_link": {
"after_completion": {},
"created_at": "<string>",
"created_by": "<string>",
"customer_ident_collection": true,
"deleted_at": "<string>",
"enabled": true,
"id": "<string>",
"invoice_id": "<string>",
"metadata": {},
"plan_id": "<string>",
"properties": {},
"shipping_address_collection": true,
"source": "Lago",
"tax_ident_collection": true,
"updated_at": "<string>",
"updated_by": "<string>"
},
"price": "<string>",
"properties": {},
"recurring_interval": "Unknown",
"recurring_interval_count": 123,
"recurring_usage_type": "Unknown",
"reference": "<string>",
"source": "Lago",
"trial_period": "<string>",
"type": "Unknown",
"updated_at": "<string>"
},
"plan_id": "<string>",
"properties": {},
"shipping_address_collection": true,
"source": "Lago",
"tax_ident_collection": true,
"updated_at": "<string>",
"updated_by": "<string>",
"url": "<string>"
}
],
"last_update": "2021-01-01T00:00:00.000Z",
"next": 10,
"total": 10
},
"error": true
}{
"error": {
"code": 400,
"errors": [
{
"domain": "orders",
"reason": "InsufficientQuantity"
}
],
"message": "Insufficient quantity"
}
}{
"error": {
"code": 400,
"errors": [
{
"domain": "orders",
"reason": "InsufficientQuantity"
}
],
"message": "Insufficient quantity"
}
}Authorizations
Query Parameters
Page size. Defaults to 100. Minimum 1, maximum 100.
1 <= x <= 100Page number (1-based). Defaults to 1.
x >= 1Exact match on the merchant-defined reference set when the paylink was created. Unlike search, this matches the whole value and nothing else. Multiple results indicate inconsistent legacy data and should be handled as provisioning drift.
Case-insensitive search over paylink name and related fields.
Inclusive lower bound on created_at (RFC3339). When set, results are sorted by created_at.
Sort direction for the primary list key (created_at when since/until are set, otherwise id). Defaults to desc.
asc, desc Filter by paylink status.
active, inactive Inclusive upper bound on created_at (RFC3339). When set, results are sorted by created_at.