Skip to main content
GET
Получить транзакцию по ID

Авторизации

Authorization
string
header
обязательно

Токен доступа, полученный через POST /auth (client_id + client_secret). Действителен в течение 300 секунд.

Заголовки

X-Sub-Account
string

Reference субсчёта, в котором должна выполняться операция. Если заголовок не передан, операция выполняется в основном аккаунте; зарезервированное значение principal также указывает на основной аккаунт и равнозначно отсутствию заголовка. Принимается всеми эндпоинтами, кроме POST /auth и самих эндпоинтов /sub-accounts, которые всегда работают с основным аккаунтом.

Возможные ошибки: 404 SUB_ACCOUNT_NOT_FOUND, 403 SUB_ACCOUNT_FORBIDDEN, 403 SUB_ACCOUNT_SUSPENDED.

Требует, чтобы у учётных данных был включён доступ к субсчетам (Настройки → Интеграция → Учётные данные API). По умолчанию он выключен и не заменяется никаким разрешением, даже FULL_ACCESS: без него ответ — 403 SUB_ACCOUNT_FORBIDDEN.

Pattern: ^[a-z0-9][a-z0-9_-]{1,31}$
Пример:

"loja-centro"

Параметры пути

id
string
обязательно

ID транзакции (UUID), ваш external_reference или Idempotency-Key, использованный при создании. Разрешаются в этом порядке. Вывод средств, ещё находящийся в обработке (без транзакции), также находится по любому из них.

Ответ

Детали транзакции

id
string<uuid>
обязательно

ID транзакции

status
enum<string>
обязательно

Статус транзакции

Доступные опции:
pending,
completed,
failed,
cancelled
type
enum<string>
обязательно

Тип транзакции. internal_transfer — движение между счетами одного владельца: внутренний перевод или часть разделения платежа; по сети PIX он не проходит.

Доступные опции:
payment,
fee,
refund,
chargeback,
withdrawal,
adjustment,
referral_commission,
internal_transfer
paymentMethod
enum<string>
обязательно

Использованный способ оплаты

Доступные опции:
pix,
credit_card,
boleto
amount
number
обязательно

Сумма в BRL

Пример:

150.75

currency
string
обязательно

Код валюты

Пример:

"BRL"

createdAt
string<date-time>
обязательно

Дата создания

description
string

Описание транзакции

externalReference
string

Ваш внешний референс-ID

Пример:

"pedido-12345"

customerId
string<uuid>

ID клиента

projectId
string<uuid>

ID проекта

metadata
object

Персонализированные метаданные (пары ключ–значение)

Пример:
pixCopyPaste
string

Код PIX «копировать и вставить» (только для ожидающих транзакций PIX)

Пример:

"00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890"

expiresAt
string<date-time>

Дата истечения срока действия (только для ожидающих транзакций)

paidAt
string<date-time>

Дата оплаты транзакции

e2eId
string

Сквозной ID сети PIX (появляется после подтверждения PSP)

Пример:

"E18189547202603160145ZYFfVx3jP8D"

counterpartName
string

Имя контрагента по данным PSP (плательщик при поступлении, получатель при выводе)

Пример:

"Мария Силва"

counterpartDocument
string

CPF/CNPJ контрагента, без маски

Пример:

"12345678900"

updatedAt
string<date-time>

Дата обновления