PayZuPayZu Docs

Glossary

Transaction status (status)

StatusDescription
PENDINGTransaction created, awaiting payment or processing
COMPLETEDTransaction completed successfully
CANCELEDTransaction canceled (error or manual request)
REFUNDEDAmount refunded to the payer
EXPIREDPayment deadline expired, transaction was not completed

Transaction types (type)

ValueWhat it is
DEPOSITMoney in (Pix in, refund received)
WITHDRAWMoney out (Pix, TED, QR, data, internal)

Pix key types (pixType)

TypeDescriptionFormat
cpf11 numeric digits, no formatting12345678901
cnpj14 numeric digits, no formatting12345678901234
phoneInternational format with country code (55)5511987654321
emailValid email addressusuario@dominio.com.br
evpUUID generated by the Central Bank123e4567-e89b-12d3-a456-426655440000

Infractions (MED)

Fields of the infraction object

FieldTypeDescription
idstringUnique identifier of the infraction
protocolstringProtocol of the infraction record
typeInfractionTypeInfraction type
statusInfractionStatusCurrent status
reportedByReportedTypeOrigin of the report
reportDetailsstringReport details
analysisResultAnalysisResultAnalysis result (null while pending)
analysisDetailsstring | nullAnalysis details
transactionEndToEndIdstringEndToEnd ID of the related Pix transaction
transactionIdstringTransaction ID in the PayZu system
creationDatestringWhen the record was created
lastModificationDatestringLast update
dueDatestring | nullDeadline for analysis

InfractionType

ValueDescription
REFUND_REQUESTRequest to refund amounts from a Pix transaction
FRAUDTransaction related to fraudulent activity
REFUND_CANCELLEDCancellation of a previously registered refund request

ReportedType

ValueDescription
DEBITED_PARTICIPANTThe party who sent the funds (payer) registered the infraction
CREDITED_PARTICIPANTThe party who received the funds (receiver) registered the infraction

AnalysisResult

ValueDescription
AGREEDInfraction is valid, refund will be processed
DISAGREEDInfraction is not valid, no refund

HTTP codes

CodeWhat it means
200Success
201Resource created
400Invalid payload
401Missing, invalid, or revoked token
403Valid token but no permission
404Resource not found
409Conflict (idempotência, resource in invalid state)
422Semantic validation failed
429Rate limit reached
5xxPayZu server error (retry with backoff)

Common fields

FieldTypeDescription
idstringUnique identifier of the transaction at PayZu
clientReferencestringExternal identifier you provide, returned on every callback
amountnumberValue in reais (BRL), never cents
callbackUrlstringURL to receive webhooks on status changes
endToEndIdstringPix EndToEnd ID (Bacen). Format E + 32 chars
requestIdstringUnique ID of the PayZu call. Appears on every error, send to support

On this page