List refunds

curl --request GET \
  --url https://api.example.com/dict-hub/v1/dict/refunds \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/dict-hub/v1/dict/refunds"

	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))

}

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

fetch('https://api.example.com/dict-hub/v1/dict/refunds', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "hasMore": false,
  "items": [
    {
      "contestedParticipant": "87654321",
      "creationTime": "2026-01-01T12:00:00Z",
      "id": "018f8c1d-1234-7abc-9def-000000000001",
      "lastModified": "2026-01-01T12:30:00Z",
      "monitorAccount": false,
      "refundAmount": "1000.00",
      "refundReason": "OPERATIONAL_FLAW",
      "requestingParticipant": "12345678",
      "status": "OPEN",
      "transactionId": "E12345678202601011200abcdef01234",
      "alreadySettledAmount": "<string>",
      "analysisDetails": "<string>",
      "analysisResult": "TOTALLY_ACCEPTED",
      "bacenRefundId": "3d48532f-1a2b-4422-81c3-b7dc852e262b",
      "correlationId": "9f3a8b7e2c1d4e5a8b6f1a2b3c4d5e6f",
      "effectiveRefundedAmount": "<string>",
      "fundsRecoveryId": "<string>",
      "infractionReportId": "<string>",
      "refundAccount": {
        "accountNumber": "123456",
        "accountType": "CACC",
        "branch": "0001",
        "participant": "99999011",
        "taxIdNumber": "12345678909"
      },
      "refundDetails": "refund due to operational failure",
      "refundRejectionReason": "NO_BALANCE",
      "refundTransactionId": "<string>",
      "settleReason": "<string>",
      "settleType": "REFUND",
      "surplusAmount": "<string>"
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 1
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0001",
  "title": "Bad Request",
  "status": 400,
  "detail": "Your request is missing one or more required header params.",
  "code": "PIX-0001"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0011",
  "title": "Not Found",
  "status": 404,
  "detail": "No entity was found for the given ID. Please make sure to use the correct ID.",
  "code": "PIX-0011"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0000",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "internal error",
  "code": "PIX-0000"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0141",
  "title": "Bad Gateway",
  "status": 502,
  "detail": "internal error",
  "code": "PIX-0141"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

GET

dict

refunds

List refunds

curl --request GET \
  --url https://api.example.com/dict-hub/v1/dict/refunds \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/dict-hub/v1/dict/refunds"

	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))

}

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

fetch('https://api.example.com/dict-hub/v1/dict/refunds', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "hasMore": false,
  "items": [
    {
      "contestedParticipant": "87654321",
      "creationTime": "2026-01-01T12:00:00Z",
      "id": "018f8c1d-1234-7abc-9def-000000000001",
      "lastModified": "2026-01-01T12:30:00Z",
      "monitorAccount": false,
      "refundAmount": "1000.00",
      "refundReason": "OPERATIONAL_FLAW",
      "requestingParticipant": "12345678",
      "status": "OPEN",
      "transactionId": "E12345678202601011200abcdef01234",
      "alreadySettledAmount": "<string>",
      "analysisDetails": "<string>",
      "analysisResult": "TOTALLY_ACCEPTED",
      "bacenRefundId": "3d48532f-1a2b-4422-81c3-b7dc852e262b",
      "correlationId": "9f3a8b7e2c1d4e5a8b6f1a2b3c4d5e6f",
      "effectiveRefundedAmount": "<string>",
      "fundsRecoveryId": "<string>",
      "infractionReportId": "<string>",
      "refundAccount": {
        "accountNumber": "123456",
        "accountType": "CACC",
        "branch": "0001",
        "participant": "99999011",
        "taxIdNumber": "12345678909"
      },
      "refundDetails": "refund due to operational failure",
      "refundRejectionReason": "NO_BALANCE",
      "refundTransactionId": "<string>",
      "settleReason": "<string>",
      "settleType": "REFUND",
      "surplusAmount": "<string>"
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 1
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0001",
  "title": "Bad Request",
  "status": 400,
  "detail": "Your request is missing one or more required header params.",
  "code": "PIX-0001"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0011",
  "title": "Not Found",
  "status": 404,
  "detail": "No entity was found for the given ID. Please make sure to use the correct ID.",
  "code": "PIX-0011"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0000",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "internal error",
  "code": "PIX-0000"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0141",
  "title": "Bad Gateway",
  "status": 502,
  "detail": "internal error",
  "code": "PIX-0141"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Query Parameters

status

string

Filter by lifecycle status (case-insensitive)

Example:

"OPEN"

refund_reason

string

Filter by refund reason (case-insensitive)

Example:

"FRAUD"

transaction_id

string

Filter by the contested transaction end-to-end ID (32 chars)

Example:

"E12345678202601011200abcdef01234"

infraction_report_id

string

Filter by the linked infraction report UUID

Example:

"c3d4e5f6-a7b8-4901-abcd-34567890abcd"

requesting_participant

string

Filter by the requesting participant ISPB (8 characters, uppercase alphanumeric)

Required string length: 8

Pattern: ^[A-Z0-9]{8}$

Example:

"12345678"

contested_participant

string

Filter by the contested participant ISPB (8 characters, uppercase alphanumeric)

Required string length: 8

Pattern: ^[A-Z0-9]{8}$

Example:

"87654321"

page

string

Page number (default: 1, minimum: 1)

Example:

"1"

limit

string

Maximum number of items per page (default: 10, max: 100)

Example:

"10"

sort_order

string

Sort direction by last_modified (default: desc, case-insensitive)

Example:

"desc"

Response

hasMore

boolean

required

Example:

false

items

object[] | null

required

Show child attributes

limit

integer<int64>

required

Example:

10

page

integer<int64>

required

Example:

1

total

integer<int64>

required

Example:

1

DICT and Pix keys

Collections and BR Codes

Payments and refunds

Error handling

List refunds

Authorizations

Query Parameters

Response