Skip to main content
POST
Create Split Charge

Authorizations

Authorization
string
header
required

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

Body

application/json

amountCents (ou amount) é obrigatório, junto com splits.

splits
object[]
required

Lista somente dos OUTROS beneficiários (1 a 9). Cada recipientEmail deve ser único, de uma conta PurinCash existente e diferente da sua. A soma das percentages deve ser menor que 100.00 e a sua fatia (100 menos a soma) deve ser estritamente maior que a de cada beneficiário — caso contrário a criação é rejeitada com 400.

Required array length: 1 - 9 elements
amountCents
integer

Valor da cobrança em centavos — inteiro entre 80 (R$ 0,80) e 500000 (R$ 5.000,00, teto para cobranças com split). Preferido; também são aceitos amount (decimal em reais) ou valueCents (alias de amountCents).

Required range: 80 <= x <= 500000
amount
number

Valor da cobrança em reais (decimal). Alternativa a amountCents.

description
string

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

Maximum string length: 200
customer
object

Dados do cliente (opcional).

callbackUrl
string<uri>

URL HTTPS pública (máx. 500 caracteres) que recebe um POST assinado com HMAC-SHA256 (header X-Webhook-Signature) quando o pagamento é confirmado. Payload inclui paymentId, status "paid" e splits com emails mascarados.

Maximum string length: 500

Response

Cobrança com split criada com sucesso. A sua fatia aparece na lista splits com isOwner true (no exemplo, o parceiro recebe 3% e você fica com 97%, menos a taxa).

paymentId
string

Identificador único da cobrança com split (prefixo psplit_).

status
enum<string>

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

Available options:
pending,
paid,
expired,
refunded,
cancelled
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.

splits
object[]

Divisão configurada, incluindo a sua fatia (isOwner true). Emails mascarados (LGPD).

expiresAt
string<date-time>

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