Skip to main content
POST
Decode PIX Code

Authorizations

Authorization
string
header
required

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

Body

application/json
brCode
string
required

O copia e cola completo, como veio do recebedor.

Response

Código lido.

valid
boolean

Sempre true nesta resposta.

isDynamic
boolean

true quando o código aponta para uma cobrança no banco em vez de carregar os dados. Nesse caso é a leitura que resolve valor e destino.

amount
number | null

Valor do código em BRL. null quando o código não traz valor e a leitura também não resolveu.

amountLocked
boolean

O código fixa o valor. Quando false, é você quem informa amount no pagamento.

dynamicResolved
boolean

Em código dinâmico, indica se o valor veio de fonte autoritativa. false com amount null significa "não deu para ler agora", diferente de "não tem valor".

dynamicError
string

Motivo da leitura não ter resolvido, quando houver.

fee
number

Taxa que será SOMADA ao valor do código. O débito do pagamento é amount + fee.

pixKey
string

Chave de destino, quando o código a carrega.

merchantName
string

Nome no código.

merchantCity
string

Cidade no código.

receiverName
string

Nome de quem recebe, confirmado na leitura.

receiverDocument
string

Documento de quem recebe, MASCARADO (ex. 12../0001-**). Serve para a pessoa conferir o destino na tela, não para cadastro.

payerName
string

Pagador indicado na cobrança

payerDocument
string

Documento do pagador indicado

txid
string

Identificador da cobrança

description
string

Descrição no código

createdAt
string

Criação da cobrança

expiresAt
string

Vencimento da cobrança

chargeStatus
string

Situação da cobrança no banco