Create credit/debit card payment

Cria um pagamento de crédito ou débito, à vista ou parcelado, para um estabelecimento
cadastrado no tenant.

Fonte dos dados de cartão — envie o cartão via exatamente um dos dois:

  • card — PAN completo (fluxo servidor-a-servidor com contexto PCI)
  • tokenData — cartão previamente tokenizado (slugToken do initialize
    ou slugStoredCard de POST /v1/acquiring/tokenize-card)

Idempotência via orderId — se um pagamento com o mesmo orderId já estiver
ACCEPTED ou CAPTURED para este merchant, retorna 409 ORDER_ALREADY_APPROVED
sem criar um novo débito. FAILED permite retry com o mesmo orderId.

3-D Secure — envie threeDsData quando o pagamento vier de um fluxo autenticado
(mobile SDK ou hosted page com 3DS 2.x). Sem threeDsData o pagamento roda em
frictionless/no-3DS.

Payment Split — para split marketplace, cada documentId da lista precisa ser
um merchant já cadastrado no mesmo tenant do pagamento.

Payer info + paymentLinkSlug — usados em pagamentos originados por link
(POST /v1/acquiring/links). Payload enriquecido melhora fraud score em alguns
adquirentes; paymentLinkSlug referencia o link no webhook
acquiring.financial_transaction.

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

Token obtido em POST /v1/acquiring/payments/initialize

string
required

CPF ou CNPJ do merchant (somente dígitos)

string
enum
required

Tipo da transação

Allowed:
number
required

Valor em BRL

string
required

Código da moeda

integer

Número de parcelas. 1 = pagamento à vista

string

Chave de idempotência opcional. Se um pagamento com este orderId já estiver ACCEPTED ou CAPTURED, retorna 409

card
object

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

tokenData
object

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

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).

string

Slug do link de pagamento (lnk_...) retornado por POST /v1/acquiring/links. Preencha para vincular este pagamento ao link — o webhook acquiring.financial_transaction sai com essa referência.

string

Nome completo do pagador. Enriquece o snapshot e melhora fraud score em alguns adquirentes.

string

CPF ou CNPJ do pagador (somente dígitos).

string

Email do pagador. Usado no envio de recibo (quando aplicável).

string

Logradouro do pagador (sem número).

string

Número do endereço do pagador.

string

Complemento do endereço.

string

Bairro.

string

Cidade.

string

UF (2 letras).

string

CEP (somente dígitos).

paymentSplit
object
  • PERCENTUAL: cada value representa uma porcentagem do total (ex: 70 = 70%)
  • ABSOLUTE: cada value representa um valor fixo em BRL (ex: 105.00)
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