Skip to main content
POST
/
api
/
payment-links
/
public
/
slug
/
{slug}
/
checkout
Criar checkout completo
curl --request POST \
  --url https://upay-sistema-api.onrender.com/api/payment-links/public/slug/{slug}/checkout \
  --header 'Content-Type: application/json' \
  --data '
{
  "product": "<string>",
  "amountCents": 50000000,
  "clientName": "<string>",
  "clientEmail": "jsmith@example.com",
  "clientDocument": "<string>",
  "clientPhone": "<string>",
  "paymentMethod": "PIX",
  "paymentLinkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "installments": 6,
  "dueDate": "2023-11-07T05:31:56Z",
  "metadata": {},
  "trackingParams": {
    "utm_source": "<string>",
    "utm_medium": "<string>",
    "utm_campaign": "<string>",
    "utm_content": "<string>",
    "utm_term": "<string>",
    "src": "<string>",
    "sck": "<string>"
  },
  "postbackUrl": "<string>"
}
'
{
  "message": "<string>",
  "transaction": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "displayId": "<string>",
    "product": "<string>",
    "amountCents": 123,
    "status": "<string>",
    "paymentMethod": "<string>",
    "client": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "trackingParams": {}
  }
}

Path Parameters

​
slug
string
required

Body

application/json
​
product
string
required

Nome ou descrição do produto/serviço

Maximum string length: 255
​
amountCents
integer
required

Valor em centavos. Exemplo: 9900 = R$ 99,00

Required range: 1 <= x <= 100000000
​
clientName
string
required

Nome completo do cliente

Maximum string length: 255
​
clientEmail
string<email>
required

Email do cliente

Maximum string length: 255
​
clientDocument
string
required

CPF ou CNPJ do cliente (apenas números). Mínimo 11 dígitos.

Required string length: 11 - 20
​
clientPhone
string | null

Telefone do cliente. Exemplo: 11999999999

Maximum string length: 20
​
paymentMethod
enum<string>
default:PIX

Método de pagamento

Available options:
PIX,
CARD,
BOLETO
​
paymentLinkId
string<uuid>

ID do link de pagamento associado (opcional)

​
installments
integer

Número de parcelas (apenas cartão de crédito)

Required range: 1 <= x <= 12
​
dueDate
string<date-time>

Data de vencimento (opcional)

​
metadata
object

Dados adicionais personalizados. Exemplo: { "orderId": "4836572", "source": "checkout-parceiro" }

​
trackingParams
object

Parâmetros de rastreamento UTM

​
postbackUrl
string<uri> | null

URL para receber notificação de mudança de status desta transação via HTTP POST. Enviado quando o status muda para COMPLETED ou FAILED. Inclui header X-Webhook-Signature com assinatura HMAC-SHA256 para validação.

Response

Transação criada com sucesso

​
message
string
​
transaction
object