RebornDocs

Criar link de pagamento

posthttps://sandbox-api.rebornpay.io/v1/payment-linksAuth obrigatória

Cria um novo link de pagamento para o seller autenticado. O link gerado pode ser compartilhado com compradores.

Headers

X-Api-Keystringrequired

API Key do seller (header)

Body

application/json
namestringrequired

Nome do link exibido para o comprador

descriptionstringoptional

Descrição detalhada do produto ou serviço

amountInCentsnumber · int64required

Valor em centavos. Ignorado quando chargeType=CUSTOMER_CHOICE

currencystringoptional

Moeda ISO-4217. BRL usa o checkout Brasil. Outras moedas aceitas pelo seller cobram só cartão internacional.

paymentMethodsarrayrequired

Métodos de pagamento aceitos. CARD é alias de CREDIT_CARD.

Nenhum item adicionado.

maxInstallmentsnumber · int32optional

Número máximo de parcelas no cartão (1–21). 1 ou nulo = sem parcelamento

installmentMonthlyInterestPercentnumberoptional

Juros ao mês (%) repassados ao comprador nas parcelas acima de interestFreeInstallments. 0 ou nulo = sem juros

interestFreeInstallmentsnumber · int32optional

Parcelas até este número saem sem juros (inclusive). 1 = somente à vista sem juros

requireCustomerDocumentbooleanoptional

Exige CPF/CNPJ do comprador antes do pagamento

successUrlstringoptional

URL de redirecionamento após pagamento aprovado

cancelUrlstringoptional

URL de redirecionamento após cancelamento

maxUsesnumber · int32optional

Máximo de usos do link. Nulo = ilimitado

expiresAtstringoptional

Data/hora de expiração do link (ISO 8601 UTC)

checkoutConfigstringoptional

Nova configuração de checkout (JSON livre)

chargeTypeenumoptional

Tipo de cobrança: FIXED (valor fixo) ou CUSTOMER_CHOICE (comprador define o valor)

quantitynumber · int32optional

Quantidade de unidades do produto

minAmountInCentsnumber · int64optional

Valor mínimo em centavos (usado quando chargeType=CUSTOMER_CHOICE)

checkoutSessionTtlMinutesnumber · int32optional

TTL customizado (em minutos) da sessão de checkout gerada a partir deste link. Nulo = usa o default global

checkoutSessionNeverExpiresbooleanoptional

Quando true, sessões de checkout deste link nunca expiram (ignora checkoutSessionTtlMinutes)

Responses

201Link criado com sucesso
idstringrequired

UUID do link de pagamento

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

sellerIdstringrequired

UUID do seller proprietário

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

namestringrequired

Nome do link exibido no checkout

Example: Curso Online de Marketing

descriptionstringoptional

Descrição do produto ou serviço

Example: Acesso vitalício ao curso de marketing digital

amountInCentsinteger · int64required

Valor em centavos

Example: 9990

currencystringrequired

Moeda ISO-4217

Example: BRL

paymentMethodsarrayrequired

Métodos de pagamento aceitos

Example: ["CREDIT_CARD","PIX"]

maxInstallmentsinteger · int32optional

Número máximo de parcelas

Example: 12

installmentMonthlyInterestPercentnumberoptional

Juros ao mês (%) repassados ao comprador. Nulo = sem juros

Example: 2.99

interestFreeInstallmentsinteger · int32optional

Parcelas sem juros (inclusive). Nulo quando não há juros

Example: 3

requireCustomerDocumentbooleanrequired

Exige documento do comprador antes do pagamento

Example: false

successUrlstringoptional

URL de redirecionamento após aprovação

Example: https://seusite.com.br/obrigado

cancelUrlstringoptional

URL de redirecionamento após cancelamento

Example: https://seusite.com.br/cancelado

publicUrlstringrequired

URL pública do checkout

Example: https://pay.rebornpay.com/a1b2c3/3fa85f64

statusstring · enumrequired

Status atual do link

Example: ACTIVE

DRAFTACTIVEINACTIVEEXPIREDDRAFTACTIVEINACTIVEEXPIRED
maxUsesinteger · int32optional

Limite de usos. Nulo = ilimitado

Example: 100

currentUsesinteger · int32required

Número de usos já realizados

Example: 7

expiresAtstringoptional

Data/hora de expiração (ISO 8601 UTC)

Example: 2025-12-31T23:59:59Z

checkoutConfigobjectoptional

Configurações avançadas do checkout

chargeTypestring · enumrequired

Tipo de cobrança

Example: FIXED

FIXEDCUSTOMER_CHOICEFIXEDCUSTOMER_CHOICE
quantityinteger · int32required

Quantidade de unidades

Example: 1

minAmountInCentsinteger · int64optional

Valor mínimo em centavos (chargeType=CUSTOMER_CHOICE)

Example: 500

checkoutSessionTtlMinutesinteger · int32optional

TTL customizado (minutos) da sessão de checkout. Nulo = usa o default global

Example: 60

checkoutSessionNeverExpiresbooleanrequired

Quando true, sessões de checkout deste link nunca expiram

Example: false

createdAtstringrequired

Data de criação (ISO 8601 UTC)

Example: 2025-01-15T10:30:00Z

updatedAtstringrequired

Data da última atualização (ISO 8601 UTC)

Example: 2025-06-01T14:00:00Z

401API Key ausente ou inválida
idstringrequired

UUID do link de pagamento

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

sellerIdstringrequired

UUID do seller proprietário

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

namestringrequired

Nome do link exibido no checkout

Example: Curso Online de Marketing

descriptionstringoptional

Descrição do produto ou serviço

Example: Acesso vitalício ao curso de marketing digital

amountInCentsinteger · int64required

Valor em centavos

Example: 9990

currencystringrequired

Moeda ISO-4217

Example: BRL

paymentMethodsarrayrequired

Métodos de pagamento aceitos

Example: ["CREDIT_CARD","PIX"]

maxInstallmentsinteger · int32optional

Número máximo de parcelas

Example: 12

installmentMonthlyInterestPercentnumberoptional

Juros ao mês (%) repassados ao comprador. Nulo = sem juros

Example: 2.99

interestFreeInstallmentsinteger · int32optional

Parcelas sem juros (inclusive). Nulo quando não há juros

Example: 3

requireCustomerDocumentbooleanrequired

Exige documento do comprador antes do pagamento

Example: false

successUrlstringoptional

URL de redirecionamento após aprovação

Example: https://seusite.com.br/obrigado

cancelUrlstringoptional

URL de redirecionamento após cancelamento

Example: https://seusite.com.br/cancelado

publicUrlstringrequired

URL pública do checkout

Example: https://pay.rebornpay.com/a1b2c3/3fa85f64

statusstring · enumrequired

Status atual do link

Example: ACTIVE

DRAFTACTIVEINACTIVEEXPIREDDRAFTACTIVEINACTIVEEXPIRED
maxUsesinteger · int32optional

Limite de usos. Nulo = ilimitado

Example: 100

currentUsesinteger · int32required

Número de usos já realizados

Example: 7

expiresAtstringoptional

Data/hora de expiração (ISO 8601 UTC)

Example: 2025-12-31T23:59:59Z

checkoutConfigobjectoptional

Configurações avançadas do checkout

chargeTypestring · enumrequired

Tipo de cobrança

Example: FIXED

FIXEDCUSTOMER_CHOICEFIXEDCUSTOMER_CHOICE
quantityinteger · int32required

Quantidade de unidades

Example: 1

minAmountInCentsinteger · int64optional

Valor mínimo em centavos (chargeType=CUSTOMER_CHOICE)

Example: 500

checkoutSessionTtlMinutesinteger · int32optional

TTL customizado (minutos) da sessão de checkout. Nulo = usa o default global

Example: 60

checkoutSessionNeverExpiresbooleanrequired

Quando true, sessões de checkout deste link nunca expiram

Example: false

createdAtstringrequired

Data de criação (ISO 8601 UTC)

Example: 2025-01-15T10:30:00Z

updatedAtstringrequired

Data da última atualização (ISO 8601 UTC)

Example: 2025-06-01T14:00:00Z

422Dados inválidos
idstringrequired

UUID do link de pagamento

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

sellerIdstringrequired

UUID do seller proprietário

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

namestringrequired

Nome do link exibido no checkout

Example: Curso Online de Marketing

descriptionstringoptional

Descrição do produto ou serviço

Example: Acesso vitalício ao curso de marketing digital

amountInCentsinteger · int64required

Valor em centavos

Example: 9990

currencystringrequired

Moeda ISO-4217

Example: BRL

paymentMethodsarrayrequired

Métodos de pagamento aceitos

Example: ["CREDIT_CARD","PIX"]

maxInstallmentsinteger · int32optional

Número máximo de parcelas

Example: 12

installmentMonthlyInterestPercentnumberoptional

Juros ao mês (%) repassados ao comprador. Nulo = sem juros

Example: 2.99

interestFreeInstallmentsinteger · int32optional

Parcelas sem juros (inclusive). Nulo quando não há juros

Example: 3

requireCustomerDocumentbooleanrequired

Exige documento do comprador antes do pagamento

Example: false

successUrlstringoptional

URL de redirecionamento após aprovação

Example: https://seusite.com.br/obrigado

cancelUrlstringoptional

URL de redirecionamento após cancelamento

Example: https://seusite.com.br/cancelado

publicUrlstringrequired

URL pública do checkout

Example: https://pay.rebornpay.com/a1b2c3/3fa85f64

statusstring · enumrequired

Status atual do link

Example: ACTIVE

DRAFTACTIVEINACTIVEEXPIREDDRAFTACTIVEINACTIVEEXPIRED
maxUsesinteger · int32optional

Limite de usos. Nulo = ilimitado

Example: 100

currentUsesinteger · int32required

Número de usos já realizados

Example: 7

expiresAtstringoptional

Data/hora de expiração (ISO 8601 UTC)

Example: 2025-12-31T23:59:59Z

checkoutConfigobjectoptional

Configurações avançadas do checkout

chargeTypestring · enumrequired

Tipo de cobrança

Example: FIXED

FIXEDCUSTOMER_CHOICEFIXEDCUSTOMER_CHOICE
quantityinteger · int32required

Quantidade de unidades

Example: 1

minAmountInCentsinteger · int64optional

Valor mínimo em centavos (chargeType=CUSTOMER_CHOICE)

Example: 500

checkoutSessionTtlMinutesinteger · int32optional

TTL customizado (minutos) da sessão de checkout. Nulo = usa o default global

Example: 60

checkoutSessionNeverExpiresbooleanrequired

Quando true, sessões de checkout deste link nunca expiram

Example: false

createdAtstringrequired

Data de criação (ISO 8601 UTC)

Example: 2025-01-15T10:30:00Z

updatedAtstringrequired

Data da última atualização (ISO 8601 UTC)

Example: 2025-06-01T14:00:00Z

curl -X POST 'https://sandbox-api.rebornpay.io/v1/payment-links' \  -H 'X-Api-Key: $API_KEY' \  -H 'Content-Type: application/json'
201Response example
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "sellerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Curso Online de Marketing",
  "description": "Acesso vitalício ao curso de marketing digital",
  "amountInCents": 9990,
  "currency": "BRL",
  "paymentMethods": [
    "CREDIT_CARD",
    "PIX"
  ],
  "maxInstallments": 12,
  "installmentMonthlyInterestPercent": 2.99,
  "interestFreeInstallments": 3,
  "requireCustomerDocument": false,
  "successUrl": "https://seusite.com.br/obrigado",
  "cancelUrl": "https://seusite.com.br/cancelado",
  "publicUrl": "https://pay.rebornpay.com/a1b2c3/3fa85f64",
  "status": "ACTIVE",
  "maxUses": 100,
  "currentUses": 7,
  "expiresAt": "2025-12-31T23:59:59Z",
  "checkoutConfig": {},
  "chargeType": "FIXED",
  "quantity": 1,
  "minAmountInCents": 500,
  "checkoutSessionTtlMinutes": 60,
  "checkoutSessionNeverExpires": false,
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-06-01T14:00:00Z"
}