Get a Pix refund by ID

curl --request GET \
  --url https://api.example.com/spi/v1/refunds/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'

package main

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

func main() {

	url := "https://api.example.com/spi/v1/refunds/{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))

}

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

fetch('https://api.example.com/spi/v1/refunds/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/spi/v1/refunds/{id}"

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

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

print(response.text)

{
  "amount": "100.00",
  "createdAt": "2026-05-06T10:45:00Z",
  "id": "019606b1-3b4c-7d8e-9f01-234567890dee",
  "originalEndToEndId": "E12345678202605061030abcdef12345",
  "reasonCode": "MD06",
  "status": "COMPLETED",
  "type": "OUTBOUND",
  "updatedAt": "2026-05-06T10:45:30Z",
  "accountId": "019606a0-1a2b-7c3d-8e4f-567890123abc",
  "deletedAt": "2023-11-07T05:31:56Z",
  "description": "Estorno solicitado pelo pagador",
  "ledger": {
    "destinationOperationId": "019606a5-7f80-7182-3c4d-56789012cdf1",
    "revert": {
      "destinationOperationId": "019606a5-7f80-7182-3c4d-56789012cdf1",
      "sourceOperationId": "019606a5-7f80-7182-3c4d-56789012cdf0",
      "transactionId": "019606a5-7f80-7182-3c4d-56789012cdef"
    },
    "sourceOperationId": "019606a5-7f80-7182-3c4d-56789012cdf0",
    "transactionId": "019606a5-7f80-7182-3c4d-56789012cdef"
  },
  "metadata": {},
  "returnEndToEndId": "D12345678202605061045fedcba54321"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0403",
  "title": "Bad Request",
  "status": 400,
  "detail": "Missing or malformed required fields for refund.",
  "code": "PIX-0403"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0420",
  "title": "Not Found",
  "status": 404,
  "detail": "Refund ID does not exist for this organization.",
  "code": "PIX-0420"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0000",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "The server could not complete the request. Please try again later.",
  "code": "PIX-0000"
}

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

refunds

{id}

Get a Pix refund by ID

curl --request GET \
  --url https://api.example.com/spi/v1/refunds/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'

package main

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

func main() {

	url := "https://api.example.com/spi/v1/refunds/{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))

}

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

fetch('https://api.example.com/spi/v1/refunds/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/spi/v1/refunds/{id}"

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

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

print(response.text)

{
  "amount": "100.00",
  "createdAt": "2026-05-06T10:45:00Z",
  "id": "019606b1-3b4c-7d8e-9f01-234567890dee",
  "originalEndToEndId": "E12345678202605061030abcdef12345",
  "reasonCode": "MD06",
  "status": "COMPLETED",
  "type": "OUTBOUND",
  "updatedAt": "2026-05-06T10:45:30Z",
  "accountId": "019606a0-1a2b-7c3d-8e4f-567890123abc",
  "deletedAt": "2023-11-07T05:31:56Z",
  "description": "Estorno solicitado pelo pagador",
  "ledger": {
    "destinationOperationId": "019606a5-7f80-7182-3c4d-56789012cdf1",
    "revert": {
      "destinationOperationId": "019606a5-7f80-7182-3c4d-56789012cdf1",
      "sourceOperationId": "019606a5-7f80-7182-3c4d-56789012cdf0",
      "transactionId": "019606a5-7f80-7182-3c4d-56789012cdef"
    },
    "sourceOperationId": "019606a5-7f80-7182-3c4d-56789012cdf0",
    "transactionId": "019606a5-7f80-7182-3c4d-56789012cdef"
  },
  "metadata": {},
  "returnEndToEndId": "D12345678202605061045fedcba54321"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0403",
  "title": "Bad Request",
  "status": 400,
  "detail": "Missing or malformed required fields for refund.",
  "code": "PIX-0403"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0420",
  "title": "Not Found",
  "status": 404,
  "detail": "Refund ID does not exist for this organization.",
  "code": "PIX-0420"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0000",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "The server could not complete the request. Please try again later.",
  "code": "PIX-0000"
}

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

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id

string

requerido

Account UUID

Ejemplo:

"019606a1-3b4c-7d8e-9f01-234567890abc"

Parámetros de ruta

string

requerido

Refund UUID

Ejemplo:

"0196080a-1234-7890-abcd-ef0123456789"

Respuesta

amount

string

requerido

Ejemplo:

"100.00"

createdAt

string<date-time>

requerido

Ejemplo:

"2026-05-06T10:45:00Z"

string

requerido

Ejemplo:

"019606b1-3b4c-7d8e-9f01-234567890dee"

originalEndToEndId

string

requerido

Ejemplo:

"E12345678202605061030abcdef12345"

reasonCode

string

requerido

Ejemplo:

"MD06"

status

string

requerido

Ejemplo:

"COMPLETED"

type

string

requerido

Ejemplo:

"OUTBOUND"

updatedAt

string<date-time>

requerido

Ejemplo:

"2026-05-06T10:45:30Z"

accountId

string

Ejemplo:

"019606a0-1a2b-7c3d-8e4f-567890123abc"

deletedAt

string<date-time>

description

string

Ejemplo:

"Estorno solicitado pelo pagador"

ledger

object

Show child attributes

metadata

object

Show child attributes

returnEndToEndId

string

Ejemplo:

"D12345678202605061045fedcba54321"

DICT y claves Pix

Cobros y códigos BR

Pagos y devoluciones

Manejo de errores

Get a Pix refund by ID

Autorizaciones

Encabezados

Parámetros de ruta

Respuesta