Object & Enums References

Use this reference when building request payloads or interpreting API responses. It brings together shared object shapes and enum values across the 40 documented Open API v3 routes. For required fields, validation, and the fields returned by a particular operation, follow that endpoint’s reference.

Handle JSON correctly

Check numeric enums, decimal-string amounts, timestamps, and optional fields.

Explore shared objects

Find transaction, account, webhook, pagination, and MED object summaries.

Look up enum values

Find the numeric values for payments, accounts, PIX keys, and QR codes.

Check string exceptions

Avoid type mismatches in account documents, webhook events, and fee configuration.

JSON types and field presence

Data	JSON representation	Integration guidance
Enum fields	Number, such as `2`	Use the numeric value from the relevant enum below. Check the string exceptions before sharing a model across endpoints.
Amounts, fees, balances, frozen amounts, limits, and MED amounts	Decimal string, such as `"25.00"`	Preserve decimal precision and use decimal arithmetic for calculations.
Integer timestamps	Number	Explicit onboarding, webhook, and MED lifecycle timestamps use Unix milliseconds. For other integer time fields, preserve the value unless the endpoint specifies the unit.
Optional request fields	Omitted or explicitly supplied	Omitting a field is different from sending `0`, `false`, or `""`. Follow the endpoint’s rules for each field.
Unpopulated generated fields	`0`, `""`, `false`, `null`, or `[]`	A declared field may retain a generated zero value when the response mapper does not populate it.

Enums are serialized as native JSON numbers. The service uses Sonic to serialize generated Go structs, rather than protobuf JSON; do not assume protobuf JSON encoding rules apply.

Unknown JSON members are not currently rejected in strict mode. Send only documented fields and do not depend on this acceptance behavior.

A missing or null object does not prove that the field will always be absent. Likewise, a zero or empty value is not enough to infer a business outcome. Interpret it in the context of the endpoint and the relevant status definition.

Example: transaction data

This excerpt from Get Transfer Details illustrates JSON types. It is part of the response data, not a complete response envelope.

{
  "txn_status": 2,
  "source_type": 2,
  "amount": "25.00",
  "currency": "BRL",
  "debit_fee": "0.00",
  "payer": null,
  "payee": null
}

Here, txn_status: 2 means COMPLETED, and source_type: 2 means API. Amounts remain strings. The outer response code is a separate API result; see Error Catalog.

Shared objects

These summaries describe shared models, not a guarantee that every listed field is populated in every response. Use the linked endpoint for operation-specific behavior.

Object	Shared fields and representation	Related endpoint
`TxnParty`	`name`, `document_id`, numeric `document_type`, `bank_account`, numeric `bank_account_type`, `bank_branch`, `bank_code`, `bank_name`	View endpoint
`TxnDetails`	parties; transaction/settlement/merchant IDs; numeric `txn_status` and `source_type`; decimal-string amount/fees; currency, memo, rejection reason; integer time fields; PIX/TED details; original settlement ID	View endpoint
Statement item	IDs, decimal-string amount, memo, numeric created time/payment/status/type fields, `is_credit`, parties, and parent transaction references	View endpoint
`AccountReferenceV3`	`ispb`, `account_number`	View endpoint
Bank account	identifiers; decimal-string balances; currency; `pix_keys`, `limit_config`, `webhooks`, `fee_configs`	View endpoint
Onboarding account	reference and holder data, status/compliance status, session ID, trading name, notification email, millisecond lifecycle timestamps, and account reference; managed accounts add numeric model and optional linked account	View endpoint
`WebhookInfo`	`webhook_id`, string `event_type`, `callback_url`, numeric `status`, numeric lifecycle times, account/subscription IDs, suspend reason	View endpoint
Pagination	numeric `page`, `page_size`, `total`, `total_pages`; statement cursor has numeric `timestamp`, string `id`, numeric `direction`	View endpoint
MED models	stable IDs, numeric canonical status, display text, decimal-string amounts, millisecond lifecycle/deadline values, original transaction/parties, timeline, infraction and refund projections	View endpoint

Party document IDs may be masked according to merchant configuration. Onboarding account references may be absent before the account is activated; see Get Master Account.

Core enums

Use these numeric values for the corresponding fields. The same number can mean different things in different enums: always interpret it with the field name and endpoint context. All values are visible below so you can search this page with ⌘F or Ctrl+F.

Document type

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`CPF`
`2`	`CNPJ`

Bank account type

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`CHECKING`
`2`	`SALARY`
`3`	`SAVINGS`
`4`	`PAYMENT`

PIX key type

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`CPF`
`2`	`CNPJ`
`3`	`EMAIL`
`4`	`PHONE`
`5`	`EVP`

PIX key status

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`ACTIVE`
`2`	`INACTIVE`
`3`	`BLOCKED`
`4`	`DELETED`

Base status

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`ACTIVE`
`2`	`INACTIVE`

Transaction status

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`PENDING`
`2`	`COMPLETED`
`3`	`FAILED`
`4`	`CANCELLED`
`5`	`PROCESSING`
`6`	`REFUNDED`
`7`	`PARTIALLY_REFUNDED`
`8`	`DISPUTED`

Source type

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`APP`
`2`	`API`
`3`	`SCHEDULE`
`4`	`BATCH`

Transaction type

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`PAYMENT`
`2`	`REFUND`
`3`	`TRANSFER`
`4`	`WITHDRAWAL`
`5`	`DEPOSIT`
`6`	`DISPUTE`

Payment method

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`PIX`
`2`	`CARD`
`3`	`TED`
`4`	`BOLETO`

Payment variant

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`PIX_MANUAL`
`2`	`PIX_KEY`
`3`	`STATIC_QRCODE`
`4`	`DYNAMIC_QRCODE`
`5`	`AUTO_PIX`
`6`	`TED_MANUAL`

QR status

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`ACTIVE`
`2`	`COMPLETED`
`3`	`PAYEE_REMOVED`
`4`	`PSP_REMOVED`

QR type

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`NOT_SET`
`11`	`STATIC`
`12`	`DYNAMIC_INSTANT_PAYMENT`
`13`	`DYNAMIC_EXPIRE_PAYMENT`
`14`	`COMPOSITE_PAYMENT`

Funds type

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`CREDIT`
`2`	`DEBIT`

Pagination direction

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`FORWARD`
`2`	`BACKWARD`

TED purpose

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`TAX`
`2`	`PUBLIC_UTILITY`
`3`	`DIVIDENDS`
`4`	`SALARY`
`5`	`SUPPLIER`
`6`	`PROFESSIONAL_FEES`
`7`	`RENT_CONDOMINIUM`
`8`	`TRADE_BILLS`
`9`	`SCHOOL_TUITION`
`10`	`ACCOUNT_CREDIT`
`11`	`BROKERAGE`
`12`	`REGISTRY_BANK_SLIP`
`13`	`COLLECTION_FEES`
`14`	`PROTEST_REGISTRY`
`15`	`CARD_OPERATOR_SETTLEMENT`

Webhook and onboarding enums

Webhook event selectors and onboarding fields use the following numeric values. For webhook response event names, see string exceptions. Account status and compliance status are separate enums. Read each field independently; the tables list values, not a guaranteed sequence of lifecycle transitions.

Webhook request event type

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`PIX_IN`
`2`	`PIX_OUT`
`3`	`REFUND_IN`
`4`	`REFUND_OUT`
`5`	`VA_ACCOUNT_KYB`
`6`	`MASTER_ACCOUNT_KYB`

Managed account model

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`MOR`
`2`	`VA`
`3`	`PA`

Compliance status

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`PENDING`
`2`	`PENDING_SUBMISSION`
`3`	`APPROVED`
`4`	`REJECTED`
`5`	`EXPIRED`
`6`	`CREATION_FAILED`
`7`	`REVIEWING`
`8`	`ERROR`
`9`	`FORCE_APPROVED`

Master/managed account status

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`PENDING`
`2`	`ACTIVE`
`3`	`FROZEN`
`4`	`CLOSED`
`5`	`REJECTED`
`6`	`EXPIRED`
`7`	`PENDING_SUBMISSION`

Compliance mode

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`HOSTED_LINK`
`2`	`API_BODY`
`3`	`PROVIDER_SESSION`

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`EMAIL`
`2`	`PHONE`
`3`	`CPF`
`4`	`CNPJ`

MED enums

Use the canonical numeric fields to interpret MED status and events. Display strings are described under string exceptions. For case details, timelines, and available actions, see Get MED Case. Do not infer cancellation eligibility or deadlines from a status value alone. Use the endpoint response and its documented behavior.

Case status

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`CREATED`
`2`	`TRACKED`
`3`	`AWAITING_ANALYSIS`
`4`	`ANALYZED`
`5`	`RETURN_PROCESSING`
`6`	`COMPLETED`
`7`	`CANCELLED`
`8`	`FAILED`

Infraction task status

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`RECEIVED`
`2`	`BLOCKING_PENDING`
`3`	`BLOCKED`
`4`	`ANALYSIS_PENDING`
`5`	`CLOSED_AGREED`
`6`	`CLOSED_DISAGREED`
`7`	`CANCELLED`
`8`	`FAILED`

Refund task status

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`RECEIVED`
`2`	`PROCESSING`
`3`	`ACCEPTED_FULL`
`4`	`ACCEPTED_PARTIAL`
`5`	`REJECTED`
`6`	`CLOSED`
`7`	`CANCELLED`
`8`	`FAILED`

Flow type

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`AUTOMATED`
`2`	`MANUAL`

Original fraud situation

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`SCAM`
`2`	`ACCOUNT_TAKEOVER`
`3`	`COERCION`
`4`	`SOCIAL_ENGINEERING`
`5`	`OTHER`
`6`	`UNKNOWN`

Timeline event

Value	Enum name
`0`	`UNSPECIFIED`
`1`	`CASE_CREATED`
`2`	`CASE_TRACKED`
`3`	`ANALYSIS_AWAITING`
`4`	`ANALYZED`
`5`	`REFUND_TRIGGERED`
`6`	`REFUND_UPDATED`
`7`	`CASE_COMPLETED`
`8`	`CASE_CANCELLED`
`9`	`INFRACTION_RECEIVED`
`10`	`INFRACTION_CLOSED`
`11`	`REFUND_REQUEST_RECEIVED`
`12`	`REFUND_REQUEST_CLOSED`
`13`	`SLA_BREACHED`

String exceptions

Some fields intentionally use strings even though related fields use numeric enums. Keep their JSON types distinct.

Account document types

Context	JSON type	Values
Request/compliance document-type fields and party document types	Number	See Document type.
`MasterAccountInfo.document_type` and `ManagedAccountInfo.document_type`	String	`"CPF"` or `"CNPJ"`

Webhook event types

Webhook create requests and create responses use numeric event types. In get, list, and update responses, WebhookInfo.event_type is a string.

Numeric value	Request enum name	String in WebhookInfo
`1`	`PIX_IN`	`"PIX_PAYMENT_IN"`
`2`	`PIX_OUT`	`"PIX_PAYMENT_OUT"`
`3`	`REFUND_IN`	`"PIX_REFUND_IN"`
`4`	`REFUND_OUT`	`"PIX_REFUND_OUT"`
`5`	`VA_ACCOUNT_KYB`	`"VA_ACCOUNT_KYB"`
`6`	`MASTER_ACCOUNT_KYB`	`"MASTER_ACCOUNT_KYB"`

For example, Create Webhook returns "event_type": 1, while Get Webhook returns "event_type": "PIX_PAYMENT_IN" inside the webhook object. Do not reuse the numeric response model for both shapes.

Fee configuration and MED display fields

Field or model	JSON representation	How to use it
Every fee-config field, including `fee_kind`	String	Preserve the documented string representation.
MED `status_display`	Human-facing string	Use the adjacent numeric status field for program logic.
Infraction `freeze_status`	Human-facing string	Use the adjacent numeric status field for program logic.

Timestamp and duration checklist

Read explicit onboarding, webhook, and MED lifecycle timestamps as Unix milliseconds.
Keep other integer time fields unchanged unless the endpoint specifies their unit.
Treat dynamic QR expires as a duration in seconds, not an epoch timestamp. It defaults to 7200 seconds. See Generate Dynamic QR Code.

Browse API endpoints

Check required fields, validation rules, and response examples for your operation.

Handle API errors

Interpret the outer result code and choose the next troubleshooting step.

Handle JSON correctly

Explore shared objects

Look up enum values

Check string exceptions

​JSON types and field presence

​Example: transaction data

​Shared objects

​Core enums

​Document type

​Bank account type

​PIX key type

​PIX key status

​Base status

​Transaction status

​Source type

​Transaction type

​Payment method

​Payment variant

​QR status

​QR type

​Funds type

​Pagination direction

​TED purpose

​Webhook and onboarding enums

​Webhook request event type

​Managed account model

​Compliance status

​Master/managed account status

​Compliance mode

​Login account type

​MED enums

​Case status

​Infraction task status

​Refund task status

​Flow type

​Original fraud situation

​Timeline event

​String exceptions

​Account document types

​Webhook event types

​Fee configuration and MED display fields

​Timestamp and duration checklist

Browse API endpoints

Handle API errors

JSON types and field presence

Example: transaction data

Shared objects

Core enums

Document type

Bank account type

PIX key type

PIX key status

Base status

Transaction status

Source type

Transaction type

Payment method

Payment variant

QR status

QR type

Funds type

Pagination direction

TED purpose

Webhook and onboarding enums

Webhook request event type

Managed account model

Compliance status

Master/managed account status

Compliance mode

Login account type

MED enums

Case status

Infraction task status

Refund task status

Flow type

Original fraud situation

Timeline event

String exceptions

Account document types

Webhook event types

Fee configuration and MED display fields

Timestamp and duration checklist