Criar link avulso ou recorrente

post

https://api-hml.alliancepay.app/acquiring/payment-links/

Cria um link para acquirer_registration_id. partner_id é opcional no gateway e é preenchido pela autenticação.

ONE_TIME exige amount e não aceita recurrence. RECURRING exige recurrence.installments com pelo menos duas ocorrências e não aceita amount na raiz. As datas devem ser crescentes, com a primeira não anterior à data atual. Recorrência exige CREDIT e aceita PIX apenas na primeira ocorrência, com vencimento hoje. Sem CREDIT, max_installments deve ser 1.

Esta criação não possui garantia de idempotência por Idempotency-Key. Após falha de rede ou timeout, consulte os links pelo external_reference antes de decidir sobre uma nova criação. O external_reference é um filtro de consulta, não uma restrição de unicidade.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

billing_type

string

enum

Defaults to ONE_TIME

Allowed:

acquirer_registration_id

uuid

required

UUID do estabelecimento vinculado ao parceiro autenticado.

partner_id

uuid

Opcional no gateway: preenchido pelo parceiro autenticado quando omitido. Se informado, deve corresponder à credencial.

amount

required

≥ 0.01

Valor decimal; aceita número JSON ou string decimal. Precisão de duas casas decimais. Valor mínimo: 0.01.

name

string

length ≤ 255

description

string

required

length between 1 and 255

external_reference

string

length ≤ 255

Referência do pedido no seu sistema. Não substitui uma chave de idempotência.

payment_methods

array of strings, unique

required

length ≥ 1

max_installments

integer

1 to 99

customer

object

recurrence

object

Headers

X-Request-Id

string

length between 1 and 512

^[ -~]+$

Identificador de rastreio. Se omitido, o gateway gera um identificador. Retornado no cabeçalho X-Request-Id.

Responses

201Criado.

400Parâmetros, corpo ou cabeçalhos inválidos. A resposta pode conter mensagens por campo.

401Token ausente, inválido ou expirado, ou credencial revogada.

403Permissão ou escopo insuficiente, ou requisição bloqueada pelo firewall.

404Recurso inexistente ou fora do escopo, rota não publicada, ou public_token de link que não pertence ao parceiro autenticado.

409Conflito com o estado atual, vínculo, versão ou operação existente.

413Corpo acima do limite aceito pela infraestrutura. O bloqueio de 16 KB do firewall pode retornar 403.

414Query string codificada acima de 4096 caracteres.

429Limite de requisições atingido. Aguarde antes de tentar novamente. O firewall também pode responder 403.

500Falha interna no gateway ou na autorização.

502Falha de comunicação com o serviço ou resposta acima de 4 MB.

503Serviço temporariamente indisponível.

504Tempo limite excedido. Em escritas, consulte o resultado antes de repetir; preserve a chave nas operações idempotentes.