Reborn
Docs

Listar links de pagamento

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

Retorna lista paginada de links do seller. Filtre por `status` (ACTIVE, INACTIVE, EXPIRED, DRAFT).

Headers

X-Api-Keystringrequired

API Key do seller (header)

Query Parameters

pageintegeroptional
sizeintegeroptional
statusstringoptional

Responses

200Lista de links
contentarrayrequired

Itens da página atual

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

paymentMethodsarrayrequired

Métodos de pagamento aceitos

Example: ["CREDIT_CARD","PIX"]

maxInstallmentsinteger · int32optional

Número máximo de parcelas

Example: 12

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

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

pageinteger · int32required

Número da página (zero-based)

Example: 0

sizeinteger · int32required

Tamanho da página

Example: 20

totalElementsinteger · int64required

Total de itens em todas as páginas

Example: 42

totalPagesinteger · int32required

Total de páginas

Example: 3

401API Key ausente ou inválida
contentarrayrequired

Itens da página atual

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

paymentMethodsarrayrequired

Métodos de pagamento aceitos

Example: ["CREDIT_CARD","PIX"]

maxInstallmentsinteger · int32optional

Número máximo de parcelas

Example: 12

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

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

pageinteger · int32required

Número da página (zero-based)

Example: 0

sizeinteger · int32required

Tamanho da página

Example: 20

totalElementsinteger · int64required

Total de itens em todas as páginas

Example: 42

totalPagesinteger · int32required

Total de páginas

Example: 3

curl -X GET 'https://sandbox-api.rebornpay.io/v1/payment-links' \  -H 'X-Api-Key: $API_KEY'
200Response example
{
  "content": [
    {
      "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,
      "paymentMethods": [
        "CREDIT_CARD",
        "PIX"
      ],
      "maxInstallments": 12,
      "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,
      "createdAt": "2025-01-15T10:30:00Z",
      "updatedAt": "2025-06-01T14:00:00Z"
    }
  ],
  "page": 0,
  "size": 20,
  "totalElements": 42,
  "totalPages": 3
}