Close a Refund Request

curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/refund-requests/{refund_id}/close \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "effectiveRefundedAmount": "50.25",
  "refundAnalysisResult": "TOTALLY_ACCEPTED",
  "refundAnalysisDetails": "Analysis confirms fraud. Refund approved.",
  "refundRejectionReason": "NO_BALANCE",
  "refundTransactionId": "E98765432202411241500REFUNDTRANS"
}
'

package main

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

func main() {

	url := "https://plugin-pix-indirect.api.lerian.net/v1/dict/refund-requests/{refund_id}/close"

	payload := strings.NewReader("{\n  \"effectiveRefundedAmount\": \"50.25\",\n  \"refundAnalysisResult\": \"TOTALLY_ACCEPTED\",\n  \"refundAnalysisDetails\": \"Analysis confirms fraud. Refund approved.\",\n  \"refundRejectionReason\": \"NO_BALANCE\",\n  \"refundTransactionId\": \"E98765432202411241500REFUNDTRANS\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    effectiveRefundedAmount: '50.25',
    refundAnalysisResult: 'TOTALLY_ACCEPTED',
    refundAnalysisDetails: 'Analysis confirms fraud. Refund approved.',
    refundRejectionReason: 'NO_BALANCE',
    refundTransactionId: 'E98765432202411241500REFUNDTRANS'
  })
};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/dict/refund-requests/{refund_id}/close', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/dict/refund-requests/{refund_id}/close"

payload = {
    "effectiveRefundedAmount": "50.25",
    "refundAnalysisResult": "TOTALLY_ACCEPTED",
    "refundAnalysisDetails": "Analysis confirms fraud. Refund approved.",
    "refundRejectionReason": "NO_BALANCE",
    "refundTransactionId": "E98765432202411241500REFUNDTRANS"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "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"
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

POST

dict

refund-requests

{refund_id}

Close a Refund Request

curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/refund-requests/{refund_id}/close \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "effectiveRefundedAmount": "50.25",
  "refundAnalysisResult": "TOTALLY_ACCEPTED",
  "refundAnalysisDetails": "Analysis confirms fraud. Refund approved.",
  "refundRejectionReason": "NO_BALANCE",
  "refundTransactionId": "E98765432202411241500REFUNDTRANS"
}
'

package main

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

func main() {

	url := "https://plugin-pix-indirect.api.lerian.net/v1/dict/refund-requests/{refund_id}/close"

	payload := strings.NewReader("{\n  \"effectiveRefundedAmount\": \"50.25\",\n  \"refundAnalysisResult\": \"TOTALLY_ACCEPTED\",\n  \"refundAnalysisDetails\": \"Analysis confirms fraud. Refund approved.\",\n  \"refundRejectionReason\": \"NO_BALANCE\",\n  \"refundTransactionId\": \"E98765432202411241500REFUNDTRANS\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    effectiveRefundedAmount: '50.25',
    refundAnalysisResult: 'TOTALLY_ACCEPTED',
    refundAnalysisDetails: 'Analysis confirms fraud. Refund approved.',
    refundRejectionReason: 'NO_BALANCE',
    refundTransactionId: 'E98765432202411241500REFUNDTRANS'
  })
};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/dict/refund-requests/{refund_id}/close', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/dict/refund-requests/{refund_id}/close"

payload = {
    "effectiveRefundedAmount": "50.25",
    "refundAnalysisResult": "TOTALLY_ACCEPTED",
    "refundAnalysisDetails": "Analysis confirms fraud. Refund approved.",
    "refundRejectionReason": "NO_BALANCE",
    "refundTransactionId": "E98765432202411241500REFUNDTRANS"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "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"
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Path Parameters

refund_id

string<uuid>

required

Refund Request ID (UUID format)

Body

application/json

effectiveRefundedAmount

string

required

Amount effectively refunded in BRL (format: 0.00 to 9999999999.99). May differ from the requested amount for PARTIALLY_ACCEPTED

Minimum string length: 1

Example:

"50.25"

refundAnalysisResult

enum<string>

required

Analysis result

Available options:

TOTALLY_ACCEPTED,

PARTIALLY_ACCEPTED,

REJECTED

Minimum string length: 1

Example:

"TOTALLY_ACCEPTED"

refundAnalysisDetails

string

Analysis comments. Max 2000 characters. Required if result is REJECTED and rejection reason is INVALID_REQUEST

Maximum string length: 2000

Example:

"Analysis confirms fraud. Refund approved."

refundRejectionReason

enum<string>

Rejection reason. Required if result is REJECTED

Available options:

NO_BALANCE,

ACCOUNT_CLOSURE,

INVALID_REQUEST,

OTHER,

Example:

"NO_BALANCE"

refundTransactionId

string

Transaction ID for executing refund. Required if result is TOTALLY_ACCEPTED or PARTIALLY_ACCEPTED

Example:

"E98765432202411241500REFUNDTRANS"

Response

accountId

string

required

Account ID (UUID)

Example:

"550e8400-e29b-41d4-a716-446655440000"

bacenRefundRequestId

string

required

BACEN/BTG refund request external identifier

Example:

"3d48532f-a1b2-4422-81c3-b7dc852e262b"

contestedParticipant

string

required

ISPB of the contested participant (8 uppercase alphanumeric characters)

Example:

"12345678"

createdAt

string<date-time>

required

Creation timestamp (ISO 8601 UTC)

Example:

"2024-01-15T10:30:00Z"

string

required

Unique identifier of the refund request (UUID)

Example:

"550e8400-e29b-41d4-a716-44665544r001"

refundAmount

string

required

Refund amount in BRL (format: 0.00)

Example:

"100.50"

refundReason

enum<string>

required

Reason for the refund

Available options:

FRAUD,

OPERATIONAL_FLAW,

REFUND_CANCELLED

Example:

"FRAUD"

requestingParticipant

string

required

ISPB of the requesting participant (8 uppercase alphanumeric characters)

Example:

"30306294"

status

enum<string>

required

Current status of the refund request

Available options:

OPEN,

CLOSED,

CANCELLED

Example:

"OPEN"

transactionId

string

required

Pix End-to-End transaction ID (32 characters)

Example:

"E12345678202411241430ABCDEFGHIJK"

updatedAt

string<date-time>

required

Last update timestamp (ISO 8601 UTC)

Example:

"2024-01-15T10:30:00Z"

analysisDetails

string

Analysis comments (max 2000 characters)

Example:

"Analysis confirms fraud. Refund approved."

analysisResult

enum<string>

Analysis result (if closed)

Available options:

TOTALLY_ACCEPTED,

PARTIALLY_ACCEPTED,

REJECTED

Example:

"TOTALLY_ACCEPTED"

bacenFundsRecoveryId

string

BACEN/BTG funds-recovery identifier resolved via the associated infraction report (read-only, JOIN-derived)

Example:

"91d65e98-97c0-4b0f-b577-73625da1f9fc"

effectiveRefundedAmount

string

Amount effectively refunded in BRL

Example:

"100.00"

infractionReportId

string

Related infraction report ID (UUID)

Example:

"550e8400-e29b-41d4-a716-44665544f001"

monitorAccount

boolean

BACEN flag for account monitoring

Example:

true

refundAccount

object

Refund destination account details

Show child attributes

refundDetails

string

Detailed justification (max 2000 characters)

Example:

"Customer reports unauthorized transaction"

refundRejectionReason

enum<string>

Rejection reason (if rejected)

Available options:

NO_BALANCE,

ACCOUNT_CLOSURE,

INVALID_REQUEST,

OTHER

Example:

"NO_BALANCE"

refundTransactionId

string

Refund transaction ID (if accepted, 32 characters)

Example:

"E98765432202411241500REFUNDTRANS"

DICT API

Claims API

MED · Infractions

MED · Fraud markers

MED · Refund requests

MED · Statistics

Transactions API

QR Codes API

Collections API

Funds Recovery API

Reconciliation API

Pix Automático API

Schedules API

Transaction Reports API

Transaction times

Webhooks API

Error handling

Close a Refund Request

Authorizations

Path Parameters

Body

Response