Get a Pix transfer by ID

curl --request GET \
  --url https://api.example.com/spi/v1/transfers/{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/transfers/{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/transfers/{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/transfers/{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:30:00Z",
  "endToEndId": "E12345678202605061030abcdef12345",
  "id": "019606a2-4c5d-7e8f-90a1-345678901bcd",
  "status": "COMPLETED",
  "type": "OUTBOUND",
  "updatedAt": "2026-05-06T10:30:05Z",
  "accountId": "019606a0-1a2b-7c3d-8e4f-567890123abc",
  "aliasId": "<string>",
  "alreadyRefundedAmount": "60.00",
  "currency": "BRL",
  "deletedAt": "2023-11-07T05:31:56Z",
  "description": "Pagamento de aluguel",
  "destination": {
    "account": {
      "branch": "0001",
      "number": "0007654321",
      "participant": "87654321",
      "type": "CACC"
    },
    "key": "+5511999998888",
    "owner": {
      "document": "12345678901",
      "name": "João da Silva",
      "tradeName": "Empresa Exemplo LTDA",
      "type": "NATURAL_PERSON"
    }
  },
  "feeCharge": {
    "applied": true,
    "calculationType": "LEDGER",
    "fees": [
      {
        "amount": "1.50",
        "feeLabel": "LEDGER_FEE",
        "calculationType": "LEDGER",
        "calculationValue": "<string>",
        "creditAccount": "@fees-pix"
      }
    ],
    "netAmount": "100.00",
    "totalAmount": "1.50"
  },
  "initiatedAt": "2026-05-06T10:30:00Z",
  "initiationType": "DICT",
  "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": {},
  "paymentType": "PIX",
  "purpose": "IACT",
  "remainingRefundableAmount": "40.00",
  "source": {
    "account": {
      "branch": "0001",
      "number": "0007654321",
      "participant": "87654321",
      "type": "CACC"
    },
    "key": "+5511999998888",
    "owner": {
      "document": "12345678901",
      "name": "João da Silva",
      "tradeName": "Empresa Exemplo LTDA",
      "type": "NATURAL_PERSON"
    }
  },
  "urgency": "HIGH"
}

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

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

{
  "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": "<string>",
  "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

transfers

{id}

Get a Pix transfer by ID

curl --request GET \
  --url https://api.example.com/spi/v1/transfers/{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/transfers/{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/transfers/{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/transfers/{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:30:00Z",
  "endToEndId": "E12345678202605061030abcdef12345",
  "id": "019606a2-4c5d-7e8f-90a1-345678901bcd",
  "status": "COMPLETED",
  "type": "OUTBOUND",
  "updatedAt": "2026-05-06T10:30:05Z",
  "accountId": "019606a0-1a2b-7c3d-8e4f-567890123abc",
  "aliasId": "<string>",
  "alreadyRefundedAmount": "60.00",
  "currency": "BRL",
  "deletedAt": "2023-11-07T05:31:56Z",
  "description": "Pagamento de aluguel",
  "destination": {
    "account": {
      "branch": "0001",
      "number": "0007654321",
      "participant": "87654321",
      "type": "CACC"
    },
    "key": "+5511999998888",
    "owner": {
      "document": "12345678901",
      "name": "João da Silva",
      "tradeName": "Empresa Exemplo LTDA",
      "type": "NATURAL_PERSON"
    }
  },
  "feeCharge": {
    "applied": true,
    "calculationType": "LEDGER",
    "fees": [
      {
        "amount": "1.50",
        "feeLabel": "LEDGER_FEE",
        "calculationType": "LEDGER",
        "calculationValue": "<string>",
        "creditAccount": "@fees-pix"
      }
    ],
    "netAmount": "100.00",
    "totalAmount": "1.50"
  },
  "initiatedAt": "2026-05-06T10:30:00Z",
  "initiationType": "DICT",
  "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": {},
  "paymentType": "PIX",
  "purpose": "IACT",
  "remainingRefundableAmount": "40.00",
  "source": {
    "account": {
      "branch": "0001",
      "number": "0007654321",
      "participant": "87654321",
      "type": "CACC"
    },
    "key": "+5511999998888",
    "owner": {
      "document": "12345678901",
      "name": "João da Silva",
      "tradeName": "Empresa Exemplo LTDA",
      "type": "NATURAL_PERSON"
    }
  },
  "urgency": "HIGH"
}

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

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

{
  "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": "<string>",
  "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

Transfer UUID

Ejemplo:

"0196070b-1234-7890-abcd-ef0123456789"

Respuesta

amount

string

requerido

Ejemplo:

"100.00"

createdAt

string<date-time>

requerido

Ejemplo:

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

endToEndId

string

requerido

Ejemplo:

"E12345678202605061030abcdef12345"

string

requerido

Ejemplo:

"019606a2-4c5d-7e8f-90a1-345678901bcd"

status

string

requerido

Ejemplo:

"COMPLETED"

type

string

requerido

Ejemplo:

"OUTBOUND"

updatedAt

string<date-time>

requerido

Ejemplo:

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

accountId

string

Ejemplo:

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

aliasId

string

alreadyRefundedAmount

string

Cross-mechanism settled and reserved refund amount. Returned only for INBOUND transfers.

Ejemplo:

"60.00"

currency

string

Ejemplo:

"BRL"

deletedAt

string<date-time>

description

string

Ejemplo:

"Pagamento de aluguel"

destination

object

Show child attributes

feeCharge

object

Fee the ledger reported on the transfer. Absent when the ledger's fee answer was not recorded for this transfer (an error logged at the time, or a transfer created before fees were read back); {"applied": false} when the ledger reported that no fee was charged; the full object when it charged one.

Show child attributes

initiatedAt

string<date-time>

Ejemplo:

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

initiationType

string

Ejemplo:

"DICT"

ledger

object

Show child attributes

metadata

object

Show child attributes

paymentType

string

Ejemplo:

"PIX"

purpose

string

Ejemplo:

"IACT"

remainingRefundableAmount

string

Amount minus alreadyRefundedAmount. Returned only for INBOUND transfers and can be negative.

Ejemplo:

"40.00"

source

object

Show child attributes

urgency

string

Ejemplo:

"HIGH"

DICT y claves Pix

Cobros y códigos BR

Pagos y devoluciones

API de Pix Automático

Manejo de errores

Get a Pix transfer by ID

Autorizaciones

Encabezados

Parámetros de ruta

Respuesta