List Outbound Webhooks

curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound', 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://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "attemptCount": 0,
      "createdAt": "2026-05-21T12:00:00Z",
      "deadLetter": false,
      "deliveredAt": "2026-05-21T12:00:00Z",
      "entityId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
      "entityType": "DICT_ENTRY",
      "errorMessage": "timeout calling target URL",
      "failedAt": "2026-05-21T12:00:00Z",
      "failureReason": "max_retries_exceeded",
      "flowType": "DICT",
      "id": "019cf6ef-e418-7ced-80c0-7b9816faa798",
      "lastAttemptAt": "2026-05-21T12:00:00Z",
      "maxRetries": 3,
      "movedBy": "system",
      "nextRetryAt": "2026-05-21T12:00:00Z",
      "payload": {},
      "requestId": "560d59b9-3c74-46f8-be67-fee895b8e89e",
      "status": "PENDING",
      "targetUrl": "https://client.example.com/webhooks",
      "updatedAt": "2026-05-21T12:00:00Z"
    }
  ],
  "limit": 20,
  "page": 1,
  "totalItems": 42
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

GET

webhooks

outbound

List Outbound Webhooks

curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound', 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://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://plugin-pix-indirect.api.lerian.net/v1/webhooks/outbound")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "attemptCount": 0,
      "createdAt": "2026-05-21T12:00:00Z",
      "deadLetter": false,
      "deliveredAt": "2026-05-21T12:00:00Z",
      "entityId": "019cf6ef-e418-7ced-80c0-7b9816faa798",
      "entityType": "DICT_ENTRY",
      "errorMessage": "timeout calling target URL",
      "failedAt": "2026-05-21T12:00:00Z",
      "failureReason": "max_retries_exceeded",
      "flowType": "DICT",
      "id": "019cf6ef-e418-7ced-80c0-7b9816faa798",
      "lastAttemptAt": "2026-05-21T12:00:00Z",
      "maxRetries": 3,
      "movedBy": "system",
      "nextRetryAt": "2026-05-21T12:00:00Z",
      "payload": {},
      "requestId": "560d59b9-3c74-46f8-be67-fee895b8e89e",
      "status": "PENDING",
      "targetUrl": "https://client.example.com/webhooks",
      "updatedAt": "2026-05-21T12:00:00Z"
    }
  ],
  "limit": 20,
  "page": 1,
  "totalItems": 42
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "title": "<string>",
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

flow_type

enum<string>

Required. Outbound flow type. Uppercased server-side.

Available options:

DICT,

PAYMENT,

COLLECTION,

PIX,

TRANSFER,

REFUND,

RECURRING

entity_type

string

Filter by internal entity type. Examples: CLAIM, REFUND, INFRACTION_REPORT under flow_type=DICT; CASHIN, CASHOUT under flow_type=TRANSFER or REFUND.

entity_id

string

Filter by entity id in UUID format

status

enum<string>

Filter by status. DEAD_LETTER is a virtual, API-only value that surfaces dead-lettered webhooks.

Available options:

PENDING,

PROCESSING,

SENT,

FAILED,

DEAD_LETTER

request_id

string

Filter by originating request id

created_after

string

Filter rows with created_at >= this RFC3339 timestamp

created_before

string

Filter rows with created_at <= this RFC3339 timestamp

limit

integer

default:10

Maximum number of items per page.

Required range: 1 <= x <= 100

page

integer

default:1

Page number for pagination.

Required range: x >= 1

Response

items

object[]

Show child attributes

limit

integer

Example:

20

page

integer

Example:

1

totalItems

integer

Example:

42

⌘I

Pix — Lerian SPI (native messaging)

Pix — JD (interface, direct)

Pix — BTG (interface, indirect)

TED — Lerian SPB (native messaging)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (native messaging)

Lerian SLC (native messaging)

Lerian STA (native messaging)

Lerian SISBAJUD (native messaging)

Lerian Consignado (native messaging)

List Outbound Webhooks

Authorizations

Query Parameters

Response