Retrieve Immediate Charge by id

📘

The possible states of a Pix Charge are:

StateDescription
ATIVAThe Pix Charge was generated e is ready to be liquidated
CONCLUIDAThe Pix Charge was liquidated. A liquidated Charge can't be altered nor cancelled.
REMOVIDA_PELO_USUARIO_RECEBEDORThe Pix Charge were cancelled by the receiver user
REMOVIDA_PELO_PSPThe Pix Charge was cancelled by the PSP

Response Parameters

ParameterTypeDescription
calendarioObjectExpiry Info of the Pix Charge
criacaoStringPix Charge Creation Timestamp
expiracaoStringPix Charge Time(in seconds) Until Expiry
txidStringPix Charge Unique Code
revisaoIntegerAmount of Time the Pix Charge Was Modified
devedorObjectPayer Info
cpf or cnpjStringPayer CPF or CNPJ
nomeStringPayer Name
locObjectLocation Object
idIntegerLocation Unique ID
locationSringLocation
tipoCobStringLocation Charge Type
locationStringLocation
statusStringPix Charge Current State
valorFloatPix Charge Amount
pixCopiaEColaStringPix Charge Pix Copia e Cola
chaveStringReceiver Pix Key
solicitacaoPagadorStringText to be Delivered to the Payer
infoAdicionaisArrayAdditional Info
nomeStringField Name
valorStringField data

Request Parameters

Language
Credentials
OAuth2
Response
Click Try It! to start a request and see the response here!