Create pre-authorization

Cria uma pré-autorização (reserva de limite) sem capturar o valor. Para capturar
depois, use POST /v1/acquiring/payments/{paymentID}/capture; para desfazer, use
POST /v1/acquiring/payments/{paymentID}/void.

Diferenças versus POST /v1/acquiring/payments

  • Não aceita paymentSplit — split só faz sentido após capture.
  • Não aceita payer* / paymentLinkSlug — snapshot fica sem esses metadados.
  • Cria snapshot com transaction_type = PRE_AUTHORIZATION.

Autenticação

  • Bearer JWT (Autra) no header Authorization (APIGW).
  • Transactional Token (transactionalToken) no body — token vindo de POST /v1/acquiring/payments/initialize, encaminhado no header Authorization para a Dock.

Fonte do cartão

Envie card OU tokenData (com slugToken do initialize ou slugStoredCard de tokenize-card). Nunca os dois juntos.

3-D Secure

Envie threeDsData (xid/cavv/cavvResultCode/…) quando quiser autorizar pré-com autenticação 3DS já concluída.

Status HTTP

Retorna o status HTTP da Dock (respDock.StatusCode) — não é sempre 200. Se a Dock devolver 422 com errors[], esta rota devolve 422 com a mesma envelope, e o snapshot fica com status = ERROR.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Token transacional (Bearer eyJ...) retornado por POST /v1/acquiring/payments/initialize.

string
required

CNPJ (14 dígitos) ou CPF (11 dígitos) do merchant no tenant. Sem máscara.

double
required

Valor em reais (com decimais).

string
required

Sempre BRL no mercado brasileiro.

string
enum
required

Tipo do cartão. Débito é raro nesta rota.

Allowed:
integer
≥ 1

Parcelas. Ausente ou 0 cai em 1 no request pra Dock.

string

Chave de idempotência do lojista (mesmo comportamento de POST /v1/acquiring/payments).

card
object

Dados do cartão em claro. Use card ou tokenData, nunca os dois.

tokenData
object

Alternativa a card. Use slugToken (retornado pelo initialize) ou slugStoredCard (retornado pelo tokenize-card).

threeDsData
object

3D Secure authentication data. Fill with the data returned by the POST /v1/acquiring/payments/3ds/challenge-result endpoint (challenge flow) or POST /v1/acquiring/payments/3ds/authenticate (frictionless flow).

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json