Pular para o conteúdo principal
POST
cURL
O campo amount e os demais valores monetários da requisição usam centavos.
Para acompanhar mudanças de status, veja Webhooks e postbacks.

Autorizações

X-API-Key
string
header
obrigatório

Chave de integração obtida no painel SkalePayments

Cabeçalhos

Idempotency-Key
string

Chave única por pedido. Reutilize a mesma chave ao repetir uma tentativa interrompida.

Corpo

application/json
amount
integer
obrigatório

Valor total em centavos, entre R$ 5,00 e R$ 1.000.000,00. A conta ou a rota adquirente podem possuir limites adicionais.

Intervalo obrigatório: 500 <= x <= 100000000
Exemplo:

5000

paymentMethod
enum<string>
obrigatório

Método de pagamento. Atualmente use pix.

Opções disponíveis:
pix
customer
object
obrigatório
items
object[]
obrigatório
Minimum array length: 1
pix
object
shipping
object

Dados opcionais de entrega.

metadata
object

Dados livres devolvidos na resposta e nos webhooks.

postbackUrl
string<uri>

URL HTTPS que recebe mudanças de status da transação.

Resposta

Transação criada com sucesso

success
boolean
obrigatório
id
string
obrigatório

Identificador da transação.

status
enum<string>
obrigatório
Opções disponíveis:
waiting_payment,
paid,
refused,
cancelled,
refunded
statusCode
integer
obrigatório
timestamp
string<date-time>
obrigatório
pix
object | null
metadata
object
postbackUrl
string<uri> | null