Skip to main content
POST
Create Payment

Authorizations

Authorization
string
header
required

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

Body

application/json

Envie productId ou valueCents — um dos dois é obrigatório.

productId
string

ID (ObjectId) de um produto ativo. O valor do pagamento vem do preço do produto. Obrigatório se valueCents não for enviado. Produtos em moeda diferente de BRL são convertidos automaticamente para BRL na cobrança.

valueCents
integer

Valor em centavos (inteiro maior ou igual a 80, ou seja, R$ 0,80). Obrigatório se productId não for enviado.

Required range: x >= 80
paymentMethod
enum<string>
default:pix

Método de pagamento. "pix" (padrão) gera um BR Code PIX; "ltc" gera um endereço Litecoin com o valor convertido pela cotação atual. LTC não está disponível no modo sandbox.

Available options:
pix,
ltc
description
string

Descrição do pagamento (máx. 200 caracteres). Usada como nome do pagamento quando não há productId. Padrão "Pagamento".

Maximum string length: 200
callbackUrl
string<uri>

URL HTTPS pública (máx. 500 caracteres) que recebe um POST com o evento payment.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, e o conteúdo é entregue automaticamente após o pagamento.

Response

Pagamento criado com sucesso. A resposta PIX traz o objeto pix (BR Code); a resposta LTC traz o objeto ltc (endereço e valor em Litecoin).

Resposta quando paymentMethod é "pix" (padrão).

paymentId
string

Identificador único do pagamento (prefixo psa_).

status
enum<string>

Status do pagamento. Sempre "pending" na criação.

Available options:
pending,
paid,
expired,
refunded
type
enum<string>

Tipo do pagamento ("one_time" para pagamentos avulsos).

Available options:
one_time,
subscription
paymentMethod
enum<string>

Método de pagamento utilizado.

Available options:
pix
amountCents
integer

Valor cobrado em centavos (BRL).

currency
string

Moeda do produto (padrão BRL). A cobrança PIX é sempre em BRL.

productName
string

Nome do produto vinculado ou a descrição enviada.

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 do pagamento (30 minutos após a criação).