Skip to main content
GET
/
v1
/
refunds
/
reasons
List refund reasons
curl --request GET \
  --url https://plugin-pix-direct.api.lerian.net/v1/refunds/reasons \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://plugin-pix-direct.api.lerian.net/v1/refunds/reasons"

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-direct.api.lerian.net/v1/refunds/reasons', 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-direct.api.lerian.net/v1/refunds/reasons",
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-direct.api.lerian.net/v1/refunds/reasons"

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

}
HttpResponse<String> response = Unirest.get("https://plugin-pix-direct.api.lerian.net/v1/refunds/reasons")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/refunds/reasons")

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
[
  {
    "code": "MD06",
    "description": "Fraud"
  }
]

Authorizations

Authorization
string
header
required

JWT Bearer token authentication. Obtain token from /v1/login/oauth/access_token endpoint using client credentials (clientId and clientSecret).

Include token in Authorization header: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Token expires after 3600 seconds (1 hour).

Response

List of refund reasons retrieved successfully

code
enum<string>
required

Refund reason codes as defined by Brazilian Central Bank (BACEN). Standardized codes used when requesting transaction refunds.

Valid values:

  • FR01 = Fraud (Transaction identified as fraudulent)
  • AC03 = Invalid creditor account (Recipient account is invalid or doesn't exist)
  • AG01 = Transaction forbidden (Transaction type not allowed for this account)
  • MD06 = Refund requested by receiver (Payee requested the refund)
  • BE01 = Inconsistent data (Transaction data contains inconsistencies)
  • AC07 = Closed account (Recipient account has been closed)
Available options:
FR01,
AC03,
AG01,
MD06,
BE01,
AC07
Example:

"MD06"

description
string
required

Human-readable description of the refund reason code.

Example:

"Fraud"