Obtener un reembolso

curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/refunds/{refund_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/refunds/{refund_id}"

headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Account-Id': '<x-account-id>', Authorization: 'Bearer <token>'}
};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/refunds/{refund_id}', 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/refunds/{refund_id}",
  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>",
    "X-Account-Id: <x-account-id>"
  ],
]);

$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/refunds/{refund_id}"

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

	req.Header.Add("X-Account-Id", "<x-account-id>")
	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-indirect.api.lerian.net/v1/refunds/{refund_id}")
  .header("X-Account-Id", "<x-account-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://plugin-pix-indirect.api.lerian.net/v1/refunds/{refund_id}")

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

request = Net::HTTP::Get.new(url)
request["X-Account-Id"] = '<x-account-id>'
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "019c96a0-0c53-7a8d-8e29-67971d96d0e3",
  "originalEndToEndId": "E123456789BR1234567890123456789",
  "returnEndToEndId": "D123456789BR1234567890123456789",
  "amount": "100.00",
  "status": "COMPLETED",
  "type": "CASHOUT",
  "description": "Customer reported unauthorized transaction",
  "accountId": "01989f9e-6508-79f8-9540-835be49fbd0d",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "ledger": {
    "transactionId": "550e8400-e29b-41d4-a716-446655440011",
    "sourceOperationId": "550e8400-e29b-41d4-a716-446655440012",
    "destinationOperationId": "550e8400-e29b-41d4-a716-446655440013",
    "revert": {
      "transactionId": "550e8400-e29b-41d4-a716-446655440014",
      "sourceOperationId": "550e8400-e29b-41d4-a716-446655440015",
      "destinationOperationId": "550e8400-e29b-41d4-a716-446655440016"
    }
  },
  "metadata": {}
}

GET

refunds

{refund_id}

Obtener un reembolso

curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/refunds/{refund_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/refunds/{refund_id}"

headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Account-Id': '<x-account-id>', Authorization: 'Bearer <token>'}
};

fetch('https://plugin-pix-indirect.api.lerian.net/v1/refunds/{refund_id}', 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/refunds/{refund_id}",
  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>",
    "X-Account-Id: <x-account-id>"
  ],
]);

$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/refunds/{refund_id}"

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

	req.Header.Add("X-Account-Id", "<x-account-id>")
	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-indirect.api.lerian.net/v1/refunds/{refund_id}")
  .header("X-Account-Id", "<x-account-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://plugin-pix-indirect.api.lerian.net/v1/refunds/{refund_id}")

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

request = Net::HTTP::Get.new(url)
request["X-Account-Id"] = '<x-account-id>'
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "019c96a0-0c53-7a8d-8e29-67971d96d0e3",
  "originalEndToEndId": "E123456789BR1234567890123456789",
  "returnEndToEndId": "D123456789BR1234567890123456789",
  "amount": "100.00",
  "status": "COMPLETED",
  "type": "CASHOUT",
  "description": "Customer reported unauthorized transaction",
  "accountId": "01989f9e-6508-79f8-9540-835be49fbd0d",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "ledger": {
    "transactionId": "550e8400-e29b-41d4-a716-446655440011",
    "sourceOperationId": "550e8400-e29b-41d4-a716-446655440012",
    "destinationOperationId": "550e8400-e29b-41d4-a716-446655440013",
    "revert": {
      "transactionId": "550e8400-e29b-41d4-a716-446655440014",
      "sourceOperationId": "550e8400-e29b-41d4-a716-446655440015",
      "destinationOperationId": "550e8400-e29b-41d4-a716-446655440016"
    }
  },
  "metadata": {}
}

Autorizaciones

Authorization

string

header

requerido

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

Encabezados

X-Account-Id

string

requerido

Identificador único de la cuenta del Ledger de Midaz (formato UUID).

Parámetros de ruta

refund_id

string

requerido

Identificador único de la solicitud de devolución (formato UUID).

Respuesta

Detalles del reembolso recuperados correctamente.

string

Identificador único de la devolución.

Ejemplo:

"019c96a0-0c53-7a8d-8e29-67971d96d0e3"

originalEndToEndId

string

ID E2E de la transferencia original.

Ejemplo:

"E123456789BR1234567890123456789"

returnEndToEndId

string

ID E2E de la transferencia de retorno.

Ejemplo:

"D123456789BR1234567890123456789"

amount

string

Monto de la devolución.

Ejemplo:

"100.00"

status

enum<string>

Estado de la devolución.

Opciones disponibles:

CREATED,

PENDING,

PROCESSING,

COMPLETED,

FAILED,

CANCELLED

Ejemplo:

"COMPLETED"

type

enum<string>

Tipo de devolución.

Opciones disponibles:

CASHOUT,

CASHIN

Ejemplo:

"CASHOUT"

description

string

Descripción opcional de la devolución.

Ejemplo:

"Customer reported unauthorized transaction"

accountId

string

Identificador de la cuenta asociada con la devolución.

Ejemplo:

"01989f9e-6508-79f8-9540-835be49fbd0d"

createdAt

string<date-time>

Ejemplo:

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

updatedAt

string<date-time>

Ejemplo:

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

ledger

object

Identificadores de transacción y operación del ledger de Midaz.

Show child attributes

metadata

object

Atributos personalizados de clave-valor asociados con esta devolución. Máximo 50 claves, clave de máximo 100 caracteres, valor de máximo 2000 caracteres.

⌘I

Pix — Lerian SPI (mensajería nativa)

Pix — JD (interfaz, directo)

Pix — BTG (interfaz, indirecto)

TED — Lerian SPB (mensajería nativa)

TED — JD (interfaz)

Boletos — BTG (interfaz)

Lerian SILOC (mensajería nativa)

Lerian SLC (mensajería nativa)

Lerian STA (mensajería nativa)

Lerian SISBAJUD (mensajería nativa)

Lerian Consignado (mensajería nativa)

Obtener un reembolso

Autorizaciones

Encabezados

Parámetros de ruta

Respuesta