Skip to main content
GET
Get transaction by ID

Authorizations

Authorization
string
header
required

Access token obtained from POST /auth (client_id + client_secret). Valid for 300 seconds.

Headers

X-Sub-Account
string

Reference of the sub-account the operation runs against. When omitted, the operation happens on the main account; the reserved value principal also resolves to the main account and is equivalent to omitting the header. Accepted on every endpoint except POST /auth and the /sub-accounts endpoints themselves, which always operate on the main account.

Possible errors: 404 SUB_ACCOUNT_NOT_FOUND, 403 SUB_ACCOUNT_FORBIDDEN, 403 SUB_ACCOUNT_SUSPENDED.

Requires the credential to have sub-account access enabled (Settings → Integration → API Credentials). It starts turned off and is not replaced by any permission, not even FULL_ACCESS: without it the response is 403 SUB_ACCOUNT_FORBIDDEN.

Pattern: ^[a-z0-9][a-z0-9_-]{1,31}$
Example:

"loja-centro"

Path Parameters

id
string
required

Transaction ID (UUID), your external_reference, or the Idempotency-Key used on creation. Resolved in that order. A withdrawal still processing (no transaction yet) is also resolved by any of these.

Response

Transaction details

id
string<uuid>
required

Transaction ID

status
enum<string>
required

Transaction status

Available options:
pending,
completed,
failed,
cancelled
type
enum<string>
required

Transaction type. internal_transfer is a movement between accounts under the same ownership — an internal transfer or a split leg — and does not travel over PIX.

Available options:
payment,
fee,
refund,
chargeback,
withdrawal,
adjustment,
referral_commission,
internal_transfer
paymentMethod
enum<string>
required

Payment method used

Available options:
pix,
credit_card,
boleto
amount
number
required

Amount in BRL

Example:

150.75

currency
string
required

Currency code

Example:

"BRL"

createdAt
string<date-time>
required

Creation date

description
string

Transaction description

externalReference
string

Your external reference ID

Example:

"pedido-12345"

customerId
string<uuid>

Client ID

projectId
string<uuid>

Project ID

metadata
object

Custom metadata (key-value pairs)

Example:
pixCopyPaste
string

PIX copy-and-paste code (only for pending PIX transactions)

Example:

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

expiresAt
string<date-time>

Expiration date (only for pending transactions)

paidAt
string<date-time>

Date the transaction was paid

e2eId
string

PIX network end-to-end ID (present once the PSP has confirmed)

Example:

"E18189547202603160145ZYFfVx3jP8D"

counterpartName
string

Counterpart name as returned by the PSP (payer on cash-in, recipient on withdrawal)

Example:

"Maria Silva"

counterpartDocument
string

Counterpart CPF/CNPJ, unmasked

Example:

"12345678900"

updatedAt
string<date-time>

Last update date