List Refund Requests

Use this endpoint to list refund requests with filters and pagination. Returns empty array [] if no requests match the criteria.

GET /v1/dict/refund-requests

List Refund Requests

cURL

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

200

{
  "items": [
    {
      "accountId": "550e8400-e29b-41d4-a716-446655440000",
      "bacenRefundRequestId": "3d48532f-a1b2-4422-81c3-b7dc852e262b",
      "contestedParticipant": "12345678",
      "createdAt": "2024-01-15T10:30:00Z",
      "id": "550e8400-e29b-41d4-a716-44665544r001",
      "refundAmount": "100.50",
      "refundReason": "FRAUD",
      "requestingParticipant": "30306294",
      "status": "OPEN",
      "transactionId": "E12345678202411241430ABCDEFGHIJK",
      "updatedAt": "2024-01-15T10:30:00Z",
      "analysisDetails": "Analysis confirms fraud. Refund approved.",
      "analysisResult": "TOTALLY_ACCEPTED",
      "bacenFundsRecoveryId": "91d65e98-97c0-4b0f-b577-73625da1f9fc",
      "effectiveRefundedAmount": "100.00",
      "infractionReportId": "550e8400-e29b-41d4-a716-44665544f001",
      "monitorAccount": true,
      "refundAccount": {
        "accountNumber": "123456",
        "accountType": "CACC",
        "branch": "0001",
        "document": "12345678909",
        "participant": "99999011"
      },
      "refundDetails": "Customer reports unauthorized transaction",
      "refundRejectionReason": "NO_BALANCE",
      "refundTransactionId": "E98765432202411241500REFUNDTRANS"
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 85
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de consulta

limit · integer<int64> · predeterminado: 10

Maximum number of items per page (default: 10, range: 1-100)

page · integer<int64> · predeterminado: 1

Page number for pagination (default: 1, minimum: 1)

sort_order · string · predeterminado: asc

Sort direction for results: asc or desc

transaction_id · string

Filter by original Pix transaction ID (32 characters)

status · string[]

Filter by refund status (comma-separated for OR match): OPEN, CLOSED, CANCELLED

requesting_participant · string

Filter by requesting participant ISPB (8 uppercase alphanumeric characters)

contested_participant · string

Filter by contested participant ISPB (8 uppercase alphanumeric characters)

infraction_id · string<uuid>

Filter by related infraction report ID (UUID)

analysis_result · string

Filter by refund analysis result: TOTALLY_ACCEPTED, PARTIALLY_ACCEPTED, REJECTED

refund_transaction_id · string

Filter by refund transaction ID (32 characters)

modified_after · string

Filter by refunds modified after this timestamp (RFC3339 format: 2024-01-15T10:30:00Z)

modified_before · string

Filter by refunds modified before this timestamp (RFC3339 format: 2024-01-15T10:30:00Z)

Respuesta

200

application/json

OK

items · object[] · requerido

Refund requests on the current page

Show child attributes

limit · integer<int64> · requerido

Number of items per page

Ejemplo:

10

page · integer<int64> · requerido

Current page number

Ejemplo:

1

total · integer<int64> · requerido

Total number of refund requests matching the filters

Ejemplo:

85