Criar Link de Pagamento

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

Este endpoint é destinada a criação de link's de pagamento padrão da plataforma com checkout de pagamento para o cliente pagar através de Pix ou Cartão de Crédito.

Body Params
int32
required

Valor do pagamento em centavos sem vírgula e ponto. (Max 9999999999).

string
enum
Defaults to BRL

Moeda na qual o link de pagamento será criado. Valores permitidos:
- BRL
- USD

Allowed:
int32
required

Número máximo de parcelas que o comprador pode selecionar. (Max 12x).

int32

Quantidade de parcelas sem juros. (Max 12x).

date
string

Nome do link de pagamento. (Max 255 caracteres).

string

Descrição do link de pagamento.

date
int32

Taxa de juros variável cobradas mês a mês após a data de vencimento. Obrigatório preencher propriedade dueDateLink ao enviar valores nesta propriedade. (Max 99999).

int32

Valor de multa fixa caso a data de vencimento seja superada. Sem vírgula e ponto. Obrigatório preencher propriedade dueDateLink ao enviar valores nesta propriedade. (Max 9999999999).

string

URL para redirecionamento do comprador após a finalização do pagamento (Max 255 caracteres).
Exemplo: https://ultrapayments.com.br

customer
object
required

Informações do cliente que receberá o link de pagamento.

splits
array of objects

Split do Pagamento

splits
metadata
array of objects

O parâmetro metadata permite que os usuários anexem informações adicionais a uma transação. Isso pode incluir qualquer par de chave-valor que forneça contexto ou detalhes adicionais sobre a transação. O metadata não é utilizado pela API para processar a transação, mas pode ser útil para o registro do usuário ou para a integração com outros sistemas.

metadata
string
enum

Determina o tipo do desconto

Allowed:
int32

Desconto, se discountType for PERCENTAGE, o desconto será aplicado como uma porcentagem do valor final da transação, e se o tipo de desconto for AMOUNT, o desconto será aplicado como um valor fixo.

Headers
string
required

Chave de integração única gerado pela Autenticação de Pagamento (PayAuth) para o estabelecimento.

Formato
Bearer <access_token>

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json