Skip to main content
GET
Get Payment

Authorizations

Authorization
string
header
required

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

Path Parameters

paymentId
string
required

Identificador do pagamento (ex. psa_a1b2c3d4...).

Response

Detalhes do pagamento.

paymentId
string

Identificador único do pagamento (prefixo psa_).

status
enum<string>

Status atual do pagamento.

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

Tipo do pagamento.

Available options:
one_time,
subscription
paymentMethod
enum<string>

Método de pagamento ("pix" por padrão).

Available options:
pix,
ltc
environment
enum<string>

Ambiente da chave de API utilizada.

Available options:
live,
sandbox
subscriptionId
string

ID da assinatura no gateway. Presente apenas quando type é "subscription".

amountCents
integer

Valor em centavos (BRL).

currency
string

Moeda do produto vinculado (padrão BRL).

productName
string

Nome do produto vinculado (vazio em pagamentos avulsos).

customer
object

Dados do cliente informados na criação.

metadata
string

String JSON livre enviada na criação.

paidAt
string<date-time> | null

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

expiresAt
string<date-time>

Data de expiração do pagamento.

createdAt
string<date-time>

Data de criação do pagamento.