API Reference
  1. Autra Platform API
  2. Links de Pagamentos

Create payment link

post
https://api.autra.io/v1/acquiring/links

Cria um link de pagamento público que pode ser compartilhado com pagadores.

O link gerado tem um slug único (ex.: lnk_a1b2c3d4) e fica disponível em https://www.autra.io/{slug}.

Métodos de pagamento: é possível habilitar cartão de crédito/débito, Pix e/ou Boleto/BoléPix no mesmo link.

Valor aberto: omita o campo amount para o pagador definir o valor no checkout.

Repasse de taxa: quando passFee é true, o valor cobrado do pagador é ajustado automaticamente (gross-up) para o estabelecimento receber o valor líquido desejado.

Split de pagamento: é possível dividir o valor recebido entre vários estabelecimentos do mesmo tenant usando splitType + splits. Importante: o split é liquidado apenas em pagamentos com CARTÃO. Links com split não aceitam pagamento via Pix ou boleto — o checkout responde 422 SPLIT_REQUIRES_CARD nesses métodos.

Notificação: quando notifyEmail é true, o e-mail informado em actor recebe uma notificação a cada pagamento confirmado.

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

CPF ou CNPJ do estabelecimento dono do link (somente dígitos). Precisa ser um estabelecimento cadastrado no tenant

string
required

Título público do link, exibido na página de checkout

number
required

Valor do pagamento em BRL. Deve ser maior que zero

string
required

Código da moeda. Use BRL para Real brasileiro

boolean
required

Habilita pagamento com cartão de crédito. Pelo menos um método (cardEnabled, pixEnabled ou boletoPixEnabled) deve ser true

boolean
required

Habilita pagamento via Pix (QR Code). Pelo menos um método deve ser true

boolean
required

Habilita pagamento por Boleto/BoléPix (Autra). Quando ligado, o checkout emite um BoléPix: um boleto com QR Code Pix acoplado — o pagador pode liquidar pelo código de barras ou pelo Pix. A conta Autra do tenant e sua chave Pix ativa são resolvidas automaticamente (sem chave Pix ativa → boleto simples, sem QR). Liquidação pelo QR retorna status PAID_PIX. Pelo menos um método deve ser true.

string

Descrição opcional exibida no checkout

installmentsAllowed
array of integers
Defaults to 1

Parcelamentos permitidos no checkout (só se aplica quando cardEnabled é true). [1] = à vista. [1, 2, 3, 6, 12] = até 12x. Padrão: [1]

installmentsAllowed
integer | null

Número máximo de pagamentos aceitos. Ao atingir, o link muda automaticamente para EXHAUSTED. null = ilimitado

date-time | null

Data/hora de expiração do link (RFC 3339 UTC). Após esse momento, o link muda para EXPIRED e deixa de aceitar pagamentos. null = sem expiração

string | null
enum

Tipo de split para distribuir o valor recebido entre estabelecimentos.

  • PERCENTUAL: cada value em splits é um percentual do total (ex.: 70 = 70%)
  • ABSOLUTE: cada value é um valor fixo em BRL (ex.: 105.00)
  • null ou omitido: sem split (o estabelecimento recebe 100%)

Quando informado, o campo splits é obrigatório e deve incluir o estabelecimento dono do link.

Split é liquidado apenas no pagamento com CARTÃO — links com split não aceitam Pix nem boleto (o checkout responde 422 SPLIT_REQUIRES_CARD).

Allowed:
splits
array of objects

Lista de destinatários do split. Cada merchantId deve ser o CPF/CNPJ de um estabelecimento cadastrado no tenant. Obrigatório quando splitType é informado

splits
boolean
Defaults to false

Quando true, a taxa da transação é repassada ao pagador (gross-up).

O valor cobrado do pagador é ajustado automaticamente para o estabelecimento receber o valor líquido desejado. A simulação de taxas é retornada no campo feeSimulation da resposta.

boolean
Defaults to false

Quando true, envia um e-mail de notificação ao estabelecimento a cada pagamento confirmado no link

string

E-mail do usuário que está criando o link. Usado como destinatário das notificações de pagamento (quando notifyEmail = true) e para auditoria

string | null

Identificador livre definido pelo estabelecimento para associar o link ao sistema interno dele (ex.: número do pedido, ID do contrato). Aceita qualquer string de até 255 caracteres. Não é único — vários links podem compartilhar o mesmo valor. Retornado em todas as consultas do link.

fine
object | null

Multa aplicada no boleto/BoléPix após o vencimento (opcional).

interest
object | null

Juros (mora) aplicados no boleto/BoléPix após o vencimento (opcional).

payerData
object | null

Pré-preenchimento dos dados do pagador no checkout (opcional).

string | null

Opcional. Quando informada, o checkout redireciona o pagador para essa URL após a confirmação do pagamento (Pix ou cartão — boleto apenas emitido não redireciona). Precisa ser uma URL https:// válida, com até 2048 caracteres.

Responses

403

Token inválido ou IP não autorizado

Updated 4 months ago

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

Updated 4 months ago

Did this page help you?