Cadastrar cartão para recorrência

post

https://api-hml.alliancepay.app/acquiring/payment-links/public/{public_token}/card-setups

Adere ao cartão sem cobrança imediata, nos fluxos de início futuro e primeira ocorrência Pix. Exige payment_method_id, CVV cifrado, browser, recurring_consent=true e consent_terms_version. Utilize Idempotency-Key. Trate next_action 3DS e acompanhe até COMPLETED; esse estado confirma adesão, não pagamento. Não existe GET card-setups/by-idempotency-key: preserve setup_id, consulte card_setup.id no link ou repita o POST com a mesma chave e o mesmo payload para recuperar a tentativa.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

public_token

string

required

length between 1 and 128

^[A-Za-z0-9_-]+$

Último segmento de checkout_url. Identifica o link; não substitui o token OAuth do parceiro.

Body Params

Adesão de cartão para recorrência, sem cobrança imediata. Exige consentimento verdadeiro e versão dos termos. Requisitos cadastrais vêm de checkout_requirements.

payment_method_id

uuid

required

payment_method

string

enum

Defaults to CREDIT

Allowed:

card

object

required

installments

integer

1 to 1

Defaults to 1

payer

object

required

browser

object

required

billing_address

object

Endereço brasileiro. Consulte required_fields em checkout_requirements; country deve ser BR, state duas letras e zip_code oito dígitos após normalização.

phone

object

Celular brasileiro: country_code=55, DDD de dois dígitos, número de nove dígitos começando por 9, após normalização.

recurring_consent

boolean

enum

required

Allowed:

consent_terms_version

string

required

length between 1 and 100

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.

Idempotency-Key

string

required

length between 1 and 255

Chave estável da operação. Reutilizar a mesma chave ao consultar/repetir após timeout ou resposta pendente.

Responses

201Tentativa criada ou recuperada; confira o status do recurso.

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 do link/tentativa ou reutilização incompatível de chave de idempotência.

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 ou resultado do provedor incerto. Recupere o resultado pela mesma chave antes de repetir uma escrita.

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