Skip to main content
GET
Get Split Charge

Authorizations

Authorization
string
header
required

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

Path Parameters

paymentId
string
required

Identificador da cobrança com split (ex. psplit_a1b2c3d4...).

Response

Detalhes da cobrança com split.

paymentId
string

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

status
enum<string>

Status atual da cobrança.

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

Valor bruto da cobrança em centavos.

gatewayFeeCents
integer

Taxa do gateway em centavos (0 enquanto a cobrança não for paga). A taxa sai inteira da fatia do dono da chave de API.

netAmountCents
integer

Valor líquido em centavos (bruto menos a taxa do gateway; 0 enquanto a cobrança não for paga).

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 da cobrança, incluindo a fatia do dono (isOwner true). Emails mascarados (LGPD).

paidAt
string<date-time> | null

Data de confirmação do pagamento (null enquanto pendente).

expiresAt
string<date-time>

Data de expiração da cobrança.

createdAt
string<date-time>

Data de criação da cobrança.