Skip to main content
POST
Capturar uma Venda pré-autorizada

Authorizations

X-Client-Id
string
header
required
X-Api-Key
string
header
required

Headers

X-Idempotency-Key
string
required

Chave de idempotência da captura

Required string length: 1 - 255

Path Parameters

id
string<uuid>
required

Identificador da Venda

Body

application/json

Corpo vazio

Response

Captura aceita. A resposta traz a Venda e operation com type: capture e status: pending. Numa repetição idempotente, a operação pode já estar processing

Venda paga com 2 ou 3 cartões

id
string<uuid>
required

Identificador da Venda

merchantId
string<uuid>
required

Identificador do merchant da Venda

amount
integer
required

Valor total da Venda em centavos

Required range: x >= 200
currency
enum<string>
required
Available options:
BRL
capture
boolean
required

Indica o modo de captura informado na criação. false exige captura explícita; true captura automaticamente

status
enum<string>
required

Status da Venda

Available options:
pending,
paid,
failed,
cancelled
payments
object[]
required
Required array length: 2 - 3 elements
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
pendingReview
object

Sinal de que a Venda precisa de revisão. A Venda permanece pending e você deve interromper o polling automático

activeOperation
object

Operação pending ou processing em andamento na Venda (a mais recente). Omitido quando não há operação ativa. Nas respostas 202, a operação aceita vem em operation

orderId
string | null

Identificador do pedido no seu sistema

sessionId
string<uuid> | null

Session de origem informada na criação

metadata
object

Metadados informados na criação. Omitido quando não enviados

splitRules
object[]

Regras de split informadas na criação. Omitido quando não enviadas

operation
object

Operação assíncrona aceita por esta chamada. Na criação, vem com type: authorize e pode ser omitida numa repetição idempotente