Skip to main content
GET
Consultar pagamento

Authorizations

Authorization
string
header
required

API key criada em Integrações → Keys. Exemplo mk_live_....

Headers

X-Master-Operation
string<uuid>

UUID do negócio selecionado. Sem este header, utiliza a operação principal.

Path Parameters

id
string<uuid>
required

UUID da operação Master

Response

Operação encontrada

id
string<uuid>
required
kind
enum<string>
required
Available options:
deposit,
transfer
amountCents
integer
required
status
enum<string>
required
Available options:
draft,
unknown,
pending,
paid,
completed,
failed,
expired,
cancelled
createdAt
string<date-time>
required
operationId
string<uuid>
required

Identificador do negócio

feeCents
integer | null
required

Tarifa da conta registrada na criação

Required range: x >= 0
updatedAt
string<date-time>
required
settledAt
string<date-time> | null
required
paymentMethod
enum<string> | null
required
Available options:
pix,
card,
null
expiresAt
string<date-time> | null
required

Prazo do provedor, null quando não informado

copyPaste
string

Código Pix copia e cola quando fornecido pelo provedor

qrCodeBase64
string

Data URL PNG com QR Code quando fornecida pelo provedor

endToEnd
string
notice
string
providerFeeCents
integer

Tarifa confirmada pelo processamento quando informada

Required range: x >= 0
netAmountCents
integer

Valor líquido confirmado pelo processamento quando informado

Required range: x >= 0
debitAmountCents
integer

Débito bruto do novo saque, com a tarifa da conta incluída

Required range: x >= 1000
expectedNetAmountCents
integer

Líquido previsto do saque ou cartão: valor bruto menos tarifa da conta

Required range: x >= 1
paidAt
string<date-time>
checkoutUrl
string<uri>

Checkout hospedado, somente cartão

releaseAt
string<date-time>

Liberação informada pela liquidante

cardSettlementStatus
enum<string>
Available options:
held,
available
card
object | null