Links de pagamento
Criar link de pagamento (em breve)
AuthorizationBearer <token>
Chave de API da sua empresa. Por enquanto a SwitchPay gera a chave e entrega à sua empresa; em breve será possível criar pelo painel.
In: header
Header Parameters
Idempotency-Keystring
Chave de idempotência. Obrigatória nesta rota (cria ou movimenta dinheiro). Use o id do pedido do seu lado.
Length
length <= 255amountCentsinteger
Range
100 <= valuename?string
Length
length <= 128product?string
Length
length <= 128methodsarray<PaymentMethod>
Items
1 <= itemsmaxInstallments?integer
Default
1Range
1 <= value <= 12discountPercent?number
Desconto só Pix/boleto
Multiple Of
0.01Range
0 <= value <= 100oneTimePayment?boolean
Default
falsereferenceId?string
Length
length <= 128dueDate?string
Quando o link deixa de valer. Padrão: hoje + 3 dias
Format
date-timesplitRules?array<SplitRule>
Items
items <= 20Response Body
curl -X POST "https://api.sandbox.switchpay.app.br/v2/payment-links" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "amountCents": 19900, "name": "Assinatura mensal", "methods": [ "PIX", "CREDIT_CARD" ], "maxInstallments": 3, "oneTimePayment": true, "referenceId": "pedido-9001", "dueDate": "2026-10-09T23:59:59.000Z" }'{
"id": "pl_9c1e2d3f-4a5b-4c6d-8e7f-0a1b2c3d4e5f",
"url": "https://pay.switchpay.app.br/l/O6yG0w_aj7KnHu5Qe8swH",
"status": "ACTIVE",
"amountCents": 19900,
"methods": [
"PIX",
"CREDIT_CARD"
],
"referenceId": "pedido-9001",
"dueDate": "2026-10-09T23:59:59.000Z",
"createdAt": "2026-10-06T13:30:00.000Z"
}{
"code": "VALIDATION_ERROR",
"message": "Há campos inválidos na requisição.",
"details": [
{
"field": "methods",
"message": "informe pelo menos uma forma de pagamento"
},
{
"field": "amountCents",
"message": "mínimo 100"
}
]
}{
"code": "UNAUTHORIZED",
"message": "Chave de API ausente, inválida ou de outro ambiente."
}{
"code": "FORBIDDEN",
"message": "Sua chave não tem permissão para esta operação."
}{
"code": "RATE_LIMITED",
"message": "Limite de chamadas atingido. Aguarde e tente de novo."
}{
"code": "SERVICE_UNAVAILABLE",
"message": "Serviço de autorização indisponível. Tente novamente em instantes."
}