v1

latestOpenAPI 3.1.02026-07-26477322.4 KB

Criar link de pagamento

post/paymentlinks (COPY)

Request body

is_buildingboolean

Define se o link de pagamento será criado com o status building ou ativo, em caso de envio do campo true tal permite que você ative um link em determinado momento posteriormente, para realizar uma ação promocional, por exemplo;

namestring

Nome que será exibido na dashboard e ao buscar o link de pagamento através da API. Máximo de 64 caracteres.

order_codestring

Permite ao lojista informar um identificador de sua plataforma para correlação

typestring required

Define o tipo do link de pagamento a ser criado, podendo ser "order", para criação de pedidos, ou "subscription", para recorrências.

expires_atstring date

Define a data de expiração do link de pagamento. Formato ISO 8601. Caso não seja enviado o link não terá expiração por tempo. Não deve ser enviado caso o campo expires_in seja enviado.

expires_ininteger

Define o tempo de expiração do link de pagamento em minutos após o mesmo estar ativo. Tempo em minutos. Caso não seja enviado, o link não terá expiração por tempo. Não deve ser enviado caso o campo expires_at seja enviado.

max_sessionsinteger

Define o máximo de pedidos que o link de pagamento pode gerar, sejam eles pagos ou não. Caso não seja enviado, não haverá limite de pedidos criados.

max_paid_sessionsinteger

Define o máximo de pedidos pagos que o link de pagamento pode gerar. Caso não seja enviado, não haverá limite de pagamentos.

Response

200