Skip to main content
POST
Create Charge

Authorizations

Authorization
string
header
required

Chave de API gerada no dashboard da PurinCash (ps_live_ ou ps_test_).

Body

application/json
valueCents
integer
required

Valor da cobrança em centavos (inteiro maior ou igual a 80, ou seja, R$ 0,80).

Required range: x >= 80
description
string

Descrição da cobrança (máx. 200 caracteres). Padrão "Pagamento PIX".

Maximum string length: 200
callbackUrl
string<uri>

URL HTTPS pública (máx. 500 caracteres) que recebe um POST com o evento charge.paid quando o pagamento é confirmado, assinado com HMAC-SHA256 no header X-Webhook-Signature.

Maximum string length: 500
customer
object

Dados do cliente (opcional).

metadata
string

String JSON livre (máx. 2048 caracteres), devolvida nas consultas e no webhook.

Maximum string length: 2048
supplier
object

Vínculo opcional com produto de fornecedor (split). O valor é dividido entre a loja e o fornecedor conforme o split configurado.

Response

Cobrança criada com sucesso.

paymentId
string

Identificador único da cobrança (prefixo psc_).

status
enum<string>

Status da cobrança. Sempre "pending" na criação.

Available options:
pending,
paid,
expired,
refunded
amountCents
integer

Valor da cobrança em centavos.

currency
string

Moeda da cobrança (sempre BRL).

environment
enum<string>

Ambiente da chave de API utilizada.

Available options:
live,
sandbox
pix
object

Dados do PIX gerado.

expiresAt
string<date-time>

Expiração da cobrança (30 minutos após a criação).