Objetos

Os schemas nomeados do documento OpenAPI: recursos devolvidos pela API e corpos de requisição. Campos novos podem aparecer nas respostas sem aviso prévio — ignore os que não conhece.

Error
PaymentNextAction
PayerView
PaymentIntent
PaymentActivity
Refund
Dispute
Payout
FinancePayout
FinancePayoutList
Notification
NotificationPage
SettlementBatch
Order
OrderPage
Product
ProductAccessLink
ProductAccessLinkList
ProductListItem
ProductPage
Offer
OfferPage
OfferBump
OfferBumpList
CheckoutSession
CreatedCheckoutSession
ReplayedCheckoutSession
CheckoutPayment
CapturedCheckoutLead
PublicCheckoutSession
PaymentLink
PaymentLinkList
OpenedPaymentLinkSession
WebhookEndpoint
CreatedLiveWebhookEndpoint
ReplayedLiveWebhookEndpoint
RotatedWebhookEndpointSecret
ReplayedRotatedWebhookEndpointSecret
WebhookDelivery
ApiCredential
CreatedApiCredential
ReplayedApiCredential
Organization
OrganizationClosureRequest
Dashboard
DashboardPeriod
AbandonedCheckout
AbandonedCheckoutPage
CreatedCheckoutRecoveryLink
ReplayedCheckoutRecoveryLink
FinanceSnapshot
SellerDashboard
SellerOrderItem
SellerOrder
SellerOrderPage
SellerOrderDetail
SellerProductListItem
SellerProductPage
FinanceStatement
FinanceFees
FinanceForecast
PayerInput
PaymentMethod
CreatePaymentIntentRequest
ConfirmPaymentIntentRequest
CreateRefundRequest
CreateSellerPayoutRequest
CreateOrderRequest
CreateProductRequest
UpdateProductRequest
CreateProductAccessLinkRequest
CreateOfferRequest
UpdateOfferRequest
CreateOfferBumpRequest
UpdateOfferBumpRequest
CatalogStatusRequest
CreateCheckoutSessionRequest
PayCheckoutSessionRequest
CheckoutSessionSecretRequest
CaptureCheckoutLeadRequest
CreatePaymentLinkRequest
PaymentLinkStatusRequest
CreateWebhookEndpointRequest
UpdateWebhookEndpointRequest
EmptyRequest
CreateApiCredentialRequest
CreateOrganizationRequest
CreateOrganizationClosureRequest
UpdateCurrentOrganizationRequest

Error

Campos de Error
Campo	Tipo	Detalhes
`error` obrigatório	object
`error.code` obrigatório	string
`error.message` obrigatório	string
`error.request_id` obrigatório	string
`error.details`	qualquer

PaymentNextAction

Um destes formatos:

object

Campo Tipo Detalhes

type obrigatório "pix_qr"
qr_code_payload obrigatório string
mínimo 1 caractere(s)
expires_at obrigatório string

Campo	Tipo	Detalhes
`type` obrigatório	"pix_qr"
`qr_code_payload` obrigatório	string	mínimo 1 caractere(s)
`expires_at` obrigatório	string

PayerView

Campos de PayerView
Campo	Tipo	Detalhes
`name` obrigatório	string \| null
`email` obrigatório	string \| null
`phone` obrigatório	string \| null
`document` obrigatório	object \| null
`document.type` obrigatório	string	Valores: `cpf`, `cnpj`
`document.last2` obrigatório	string	Padrão `^[0-9]{2}$`

PaymentIntent

Campos de PaymentIntent
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `pi_`
`order_id` obrigatório	string \| null
`amount_minor` obrigatório	string
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`status` obrigatório	string	Valores: `requires_payment_method`, `requires_action`, `processing`, `succeeded`, `failed`, `canceled`
`provider_id` obrigatório	string
`latest_provider_attempt_id` obrigatório	string \| null
`failure_code` obrigatório	string \| null
`payment_method_types` obrigatório	string[]	Valores: `card`, `pix` 1 a n itens
`payment_method_type` obrigatório	string \| null
`description` obrigatório	string \| null
`metadata` obrigatório	mapa de string
`payer` obrigatório	PayerView \| null
`next_action` obrigatório	PaymentNextAction \| null
`expires_at` obrigatório	string \| null
`cancellation_reason` obrigatório	string \| null

PaymentActivity

Campos de PaymentActivity
Campo	Tipo	Detalhes
`payment_intent` obrigatório	object
`payment_intent.id` obrigatório	string	Começa com `pi_`
`payment_intent.order_id` obrigatório	string \| null
`payment_intent.amount_minor` obrigatório	string
`payment_intent.currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`payment_intent.status` obrigatório	string	Valores: `requires_payment_method`, `requires_action`, `processing`, `succeeded`, `failed`, `canceled`
`payment_intent.provider_id` obrigatório	string
`payment_intent.latest_provider_attempt_id` obrigatório	string \| null
`payment_intent.failure_code` obrigatório	string \| null
`payment_intent.payment_method_types` obrigatório	string[]	Valores: `card`, `pix` 1 a n itens
`payment_intent.payment_method_type` obrigatório	string \| null
`payment_intent.description` obrigatório	string \| null
`payment_intent.metadata` obrigatório	mapa de string
`payment_intent.payer` obrigatório	PayerView \| null
`payment_intent.next_action` obrigatório	PaymentNextAction \| null
`payment_intent.expires_at` obrigatório	string \| null
`payment_intent.cancellation_reason` obrigatório	string \| null
`payment_intent.created_at` obrigatório	string
`payment_intent.updated_at` obrigatório	string
`attempts` obrigatório	object[]	0 a 25 itens
`attempts[].id` obrigatório	string	Começa com `pat_`
`attempts[].state` obrigatório	string	Valores: `created`, `submitted`, `succeeded`, `failed`, `unknown`, `reconciled_succeeded`, `reconciled_failed`
`attempts[].provider_id` obrigatório	string
`attempts[].external_id` obrigatório	string \| null
`attempts[].canonical_error_code` obrigatório	string \| null
`attempts[].created_at` obrigatório	string
`attempts[].updated_at` obrigatório	string
`refunds` obrigatório	object[]	0 a 50 itens
`refunds[].id` obrigatório	string	Começa com `rfd_`
`refunds[].payment_intent_id` obrigatório	string	Começa com `pi_`
`refunds[].charge_id` obrigatório	string	Começa com `chg_`
`refunds[].amount_minor` obrigatório	string
`refunds[].currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`refunds[].status` obrigatório	string	Valores: `created`, `processing`, `succeeded`, `failed`, `unknown`
`refunds[].provider_id` obrigatório	string
`refunds[].external_id` obrigatório	string \| null
`refunds[].failure_code` obrigatório	string \| null
`refunds[].created_at` obrigatório	string
`refunds[].updated_at` obrigatório	string
`disputes` obrigatório	Dispute[]	0 a 50 itens
`truncated` obrigatório	object
`truncated.attempts` obrigatório	boolean
`truncated.refunds` obrigatório	boolean
`truncated.disputes` obrigatório	boolean

Refund

Campos de Refund
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `rfd_`
`payment_intent_id` obrigatório	string	Começa com `pi_`
`charge_id` obrigatório	string	Começa com `chg_`
`amount_minor` obrigatório	string
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`status` obrigatório	string	Valores: `created`, `processing`, `succeeded`, `failed`, `unknown`
`provider_id` obrigatório	string
`external_id` obrigatório	string \| null
`failure_code` obrigatório	string \| null

Dispute

Campos de Dispute
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `dsp_`
`payment_intent_id` obrigatório	string	Começa com `pi_`
`charge_id` obrigatório	string	Começa com `chg_`
`amount_minor` obrigatório	string
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`status` obrigatório	string	Valores: `created`, `won`, `lost`
`reason_code` obrigatório	string	Valores: `fraudulent`, `product_not_received`, `not_as_described`, `duplicate`, `other`
`provider_id` obrigatório	string
`external_id` obrigatório	string
`provider_status` obrigatório	string
`synthetic_obligation` obrigatório	true
`created_at` obrigatório	string
`updated_at` obrigatório	string
`resolved_at` obrigatório	string \| null

Payout

Campos de Payout
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `pyo_`
`amount_minor` obrigatório	string
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`status` obrigatório	string	Valores: `created`, `paid`, `failed`
`origin` obrigatório	string	Valores: `admin`, `seller`
`provider_id` obrigatório	string
`provider_request_key` obrigatório	string
`external_id` obrigatório	string \| null
`destination_ref` obrigatório	string	Padrão `^sim_[A-Za-z0-9_-]{3,120}$`
`provider_status` obrigatório	string \| null
`synthetic_obligation` obrigatório	true
`created_at` obrigatório	string
`updated_at` obrigatório	string
`resolved_at` obrigatório	string \| null

FinancePayout

Campos de FinancePayout
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `pyo_`
`amount_minor` obrigatório	string
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`status` obrigatório	string	Valores: `created`, `paid`, `failed`
`origin` obrigatório	string	Valores: `admin`, `seller`
`destination_ref` obrigatório	string	Padrão `^sim_[A-Za-z0-9_-]{3,120}$`
`synthetic_obligation` obrigatório	true
`created_at` obrigatório	string
`resolved_at` obrigatório	string \| null

FinancePayoutList

Campos de FinancePayoutList
Campo	Tipo	Detalhes
`data` obrigatório	FinancePayout[]

Notification

Campos de Notification
Campo	Tipo	Detalhes
`id` obrigatório	string	1 a 128 caracteres
`kind` obrigatório	string	Valores: `pix_issued`, `payment_approved`, `payment_declined`, `refund_completed`, `payout_requested`, `payout_paid`, `payout_failed`
`occurred_at` obrigatório	string
`amount_minor` obrigatório	string	Padrão `^[0-9]+$`
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`resource_id` obrigatório	string	1 a 128 caracteres
`reference` obrigatório	string	Padrão `^[A-Z0-9]{1,8}$`
`payment_method` obrigatório	string \| null
`payout_origin` obrigatório	string \| null

NotificationPage

Campos de NotificationPage
Campo	Tipo	Detalhes
`data` obrigatório	Notification[]
`next_cursor` obrigatório	string	Padrão `^n1_[0-9a-f]+$` até 512 caracteres
`has_more` obrigatório	boolean

SettlementBatch

Campos de SettlementBatch
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `stb_`
`provider_id` obrigatório	string
`external_id` obrigatório	string
`window_start` obrigatório	string
`window_end` obrigatório	string
`status` obrigatório	string	Valores: `created`, `processing`, `completed`, `requires_review`
`origin` obrigatório	string	Valores: `admin`, `auto`
`synthetic_obligation` obrigatório	true
`created_at` obrigatório	string
`updated_at` obrigatório	string
`finalized_at` obrigatório	string \| null
`lines` obrigatório	object[]
`lines[].id` obrigatório	string	Começa com `stl_`
`lines[].charge_id` obrigatório	string	Começa com `chg_`
`lines[].amount_minor` obrigatório	string
`lines[].fee_minor` obrigatório	string
`lines[].currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`lines[].status` obrigatório	string	Valores: `pending`, `available`, `mismatch`
`lines[].available_minor` obrigatório	string \| null
`lines[].reserve_minor` obrigatório	string \| null
`lines[].reconciliation_case_id` obrigatório	string \| null

Order

Campos de Order
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `ord_`
`offer_id` obrigatório	string	Começa com `off_`
`product_id` obrigatório	string	Começa com `prd_`
`checkout_session_id` obrigatório	string \| null
`amount_minor` obrigatório	string
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`status` obrigatório	string	Valores: `pending_payment`, `paid`, `canceled`, `expired`
`paid_payment_intent_id` obrigatório	string \| null
`paid_charge_id` obrigatório	string \| null
`created_at` obrigatório	string
`updated_at` obrigatório	string
`paid_at` obrigatório	string \| null
`canceled_at` obrigatório	string \| null
`expired_at` obrigatório	string \| null
`items` obrigatório	object[]
`items[].id` obrigatório	string	Começa com `oi_`
`items[].kind` obrigatório	string	Valores: `main`, `bump`
`items[].offer_id` obrigatório	string	Começa com `off_`
`items[].product_id` obrigatório	string	Começa com `prd_`
`items[].offer_bump_id` obrigatório	string \| null
`items[].amount_minor` obrigatório	string
`items[].currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`items[].position` obrigatório	integer	de 0 a 3

OrderPage

Campos de OrderPage
Campo	Tipo	Detalhes
`data` obrigatório	Order[]
`next_cursor` obrigatório	string \| null

Product

Campos de Product
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `prd_`
`name` obrigatório	string
`status` obrigatório	string	Valores: `draft`, `active`, `archived`
`created_at` obrigatório	string
`description` obrigatório	string \| null
`category` obrigatório	string \| null
`sales_page_url` obrigatório	string \| null
`guarantee_days` obrigatório	integer	de 0 a 30
`support_name` obrigatório	string \| null
`support_email` obrigatório	string \| null
`support_whatsapp` obrigatório	string \| null
`statement_descriptor` obrigatório	string \| null

ProductAccessLink

Campos de ProductAccessLink
Campo	Tipo	Detalhes
`id` obrigatório	string	Padrão `^pal_[A-Za-z0-9]{1,64}$`
`product_id` obrigatório	string	Começa com `prd_`
`label` obrigatório	string
`url` obrigatório	string
`host` obrigatório	string
`position` obrigatório	integer	de 0 a 9007199254740991
`created_at` obrigatório	string

ProductAccessLinkList

Campos de ProductAccessLinkList
Campo	Tipo	Detalhes
`data` obrigatório	ProductAccessLink[]	0 a 5 itens

ProductListItem

Campos de ProductListItem
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `prd_`
`name` obrigatório	string
`status` obrigatório	string	Valores: `draft`, `active`, `archived`
`created_at` obrigatório	string
`description` obrigatório	string \| null
`category` obrigatório	string \| null
`sales_page_url` obrigatório	string \| null
`guarantee_days` obrigatório	integer	de 0 a 30
`support_name` obrigatório	string \| null
`support_email` obrigatório	string \| null
`support_whatsapp` obrigatório	string \| null
`statement_descriptor` obrigatório	string \| null
`offer_count` obrigatório	integer	de 0 a 9007199254740991
`active_offer_count` obrigatório	integer	de 0 a 9007199254740991

ProductPage

Campos de ProductPage
Campo	Tipo	Detalhes
`data` obrigatório	ProductListItem[]
`next_cursor` obrigatório	string \| null

Offer

Campos de Offer
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `off_`
`product_id` obrigatório	string	Começa com `prd_`
`amount_minor` obrigatório	string
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`status` obrigatório	string	Valores: `draft`, `active`, `archived`
`created_at` obrigatório	string
`accepted_methods` obrigatório	string[]	Valores: `pix`, `card` 1 a 2 itens

OfferPage

Campos de OfferPage
Campo	Tipo	Detalhes
`data` obrigatório	Offer[]
`next_cursor` obrigatório	string \| null

OfferBump

Campos de OfferBump
Campo	Tipo	Detalhes
`id` obrigatório	string	Padrão `^ob_[A-Za-z0-9]{1,64}$`
`offer_id` obrigatório	string	Começa com `off_`
`bump_offer_id` obrigatório	string	Começa com `off_`
`headline` obrigatório	string
`description` obrigatório	string
`position` obrigatório	integer	de 0 a 9007199254740991
`status` obrigatório	string	Valores: `active`, `inactive`
`bump_offer` obrigatório	object
`bump_offer.product_id` obrigatório	string	Começa com `prd_`
`bump_offer.amount_minor` obrigatório	string
`bump_offer.currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`bump_offer.status` obrigatório	string	Valores: `draft`, `active`, `archived`
`created_at` obrigatório	string
`updated_at` obrigatório	string

OfferBumpList

Campos de OfferBumpList
Campo	Tipo	Detalhes
`data` obrigatório	OfferBump[]

CheckoutSession

Campos de CheckoutSession
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `cs_`
`offer_id` obrigatório	string	Começa com `off_`
`amount_minor` obrigatório	string
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`status` obrigatório	string	Valores: `open`, `completed`, `expired`
`payment_intent_id` obrigatório	string \| null
`expires_at` obrigatório	string

CreatedCheckoutSession

Campos de CreatedCheckoutSession
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `cs_`
`offer_id` obrigatório	string	Começa com `off_`
`amount_minor` obrigatório	string
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`status` obrigatório	string	Valores: `open`, `completed`, `expired`
`payment_intent_id` obrigatório	string \| null
`expires_at` obrigatório	string
`client_secret` obrigatório	string	Começa com `csec_`

ReplayedCheckoutSession

Campos de ReplayedCheckoutSession
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `cs_`
`offer_id` obrigatório	string	Começa com `off_`
`amount_minor` obrigatório	string
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`status` obrigatório	string	Valores: `open`, `completed`, `expired`
`payment_intent_id` obrigatório	string \| null
`expires_at` obrigatório	string
`secret_already_revealed` obrigatório	true

CheckoutPayment

Campos de CheckoutPayment
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `pi_`
`order_id` obrigatório	string \| null
`status` obrigatório	string	Valores: `requires_payment_method`, `requires_action`, `processing`, `succeeded`, `failed`, `canceled`
`amount_minor` obrigatório	string
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`failure_code` obrigatório	string \| null
`next_action` obrigatório	PaymentNextAction \| null
`cancellation_reason` obrigatório	string \| null

CapturedCheckoutLead

Campos de CapturedCheckoutLead
Campo	Tipo	Detalhes
`checkout_session_id` obrigatório	string	Começa com `cs_`
`captured` obrigatório	true

PublicCheckoutSession

Campos de PublicCheckoutSession
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `cs_`
`offer_id` obrigatório	string	Começa com `off_`
`amount_minor` obrigatório	string
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`status` obrigatório	string	Valores: `open`, `completed`, `expired`
`payment_intent_id` obrigatório	string \| null
`expires_at` obrigatório	string
`seller` obrigatório	object
`seller.display_name` obrigatório	string	mínimo 1 caractere(s)
`product` obrigatório	object
`product.name` obrigatório	string	mínimo 1 caractere(s)
`product.description` obrigatório	string \| null
`support` obrigatório	object \| null
`support.name` obrigatório	string \| null
`support.email` obrigatório	string \| null
`support.whatsapp` obrigatório	string \| null
`guarantee_days` obrigatório	integer	de 0 a 30
`accepted_methods` obrigatório	string[]	Valores: `pix`, `card` 1 a 2 itens
`access_links` obrigatório	object[] \| null
`access_links.label` obrigatório	string
`access_links.url` obrigatório	string
`access_links.host` obrigatório	string
`payment` obrigatório	CheckoutPayment \| null
`bumps` obrigatório	object[]
`bumps[].id` obrigatório	string	Padrão `^ob_[A-Za-z0-9]{1,64}$`
`bumps[].headline` obrigatório	string
`bumps[].description` obrigatório	string
`bumps[].product_name` obrigatório	string
`bumps[].amount_minor` obrigatório	string
`bumps[].currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`order` obrigatório	object \| null
`order.id` obrigatório	string	Começa com `ord_`
`order.amount_minor` obrigatório	string
`order.currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`order.items` obrigatório	object[]
`order.items[].kind` obrigatório	string	Valores: `main`, `bump`
`order.items[].bump_id` obrigatório	string \| null
`order.items[].product_name` obrigatório	string
`order.items[].amount_minor` obrigatório	string
`order.items[].currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`selected_bump_ids` obrigatório	string[]	Padrão `^ob_[A-Za-z0-9]{1,64}$`

PaymentLink

Campos de PaymentLink
Campo	Tipo	Detalhes
`id` obrigatório	string	Padrão `^plk_[A-Za-z0-9]{1,64}$`
`offer_id` obrigatório	string	Começa com `off_`
`status` obrigatório	string	Valores: `active`, `inactive`
`session_count` obrigatório	integer	de 0 a 9007199254740991
`completed_session_count` obrigatório	integer	de 0 a 9007199254740991
`last_session_at` obrigatório	string \| null
`created_at` obrigatório	string
`updated_at` obrigatório	string

PaymentLinkList

Campos de PaymentLinkList
Campo	Tipo	Detalhes
`data` obrigatório	PaymentLink[]

OpenedPaymentLinkSession

Campos de OpenedPaymentLinkSession
Campo	Tipo	Detalhes
`checkout_session_id` obrigatório	string	Começa com `cs_`
`client_secret` obrigatório	string	Começa com `csec_`
`expires_at` obrigatório	string

WebhookEndpoint

Campos de WebhookEndpoint
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `whe_`
`url` obrigatório	string (URL)
`enabled` obrigatório	boolean
`status` obrigatório	string	Valores: `active`, `disabled`, `deleted`
`disabled_reason` obrigatório	string \| null
`consecutive_failures` obrigatório	integer	de 0 a 9007199254740991
`selected_events` obrigatório	string[]
`product_ids` obrigatório	string[]	Começa com `prd_`
`payment_methods` obrigatório	string[]	Valores: `card`, `pix`
`delivery_mode` obrigatório	string	Valores: `simulated`, `live`
`secret_rotated_at` obrigatório	string \| null
`deleted_at` obrigatório	string \| null
`created_at` obrigatório	string

CreatedLiveWebhookEndpoint

Campos de CreatedLiveWebhookEndpoint
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `whe_`
`url` obrigatório	string (URL)
`enabled` obrigatório	boolean
`status` obrigatório	string	Valores: `active`, `disabled`, `deleted`
`disabled_reason` obrigatório	string \| null
`consecutive_failures` obrigatório	integer	de 0 a 9007199254740991
`selected_events` obrigatório	string[]
`product_ids` obrigatório	string[]	Começa com `prd_`
`payment_methods` obrigatório	string[]	Valores: `card`, `pix`
`delivery_mode` obrigatório	string	Valores: `simulated`, `live`
`secret_rotated_at` obrigatório	string \| null
`deleted_at` obrigatório	string \| null
`created_at` obrigatório	string
`signing_secret` obrigatório	string	Padrão `^whsec_live_[A-Za-z0-9_-]+$`

ReplayedLiveWebhookEndpoint

Campos de ReplayedLiveWebhookEndpoint
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `whe_`
`url` obrigatório	string (URL)
`enabled` obrigatório	boolean
`status` obrigatório	string	Valores: `active`, `disabled`, `deleted`
`disabled_reason` obrigatório	string \| null
`consecutive_failures` obrigatório	integer	de 0 a 9007199254740991
`selected_events` obrigatório	string[]
`product_ids` obrigatório	string[]	Começa com `prd_`
`payment_methods` obrigatório	string[]	Valores: `card`, `pix`
`delivery_mode` obrigatório	"live"
`secret_rotated_at` obrigatório	string \| null
`deleted_at` obrigatório	string \| null
`created_at` obrigatório	string
`secret_already_revealed` obrigatório	true

RotatedWebhookEndpointSecret

Campos de RotatedWebhookEndpointSecret
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `whe_`
`url` obrigatório	string (URL)
`enabled` obrigatório	boolean
`status` obrigatório	string	Valores: `active`, `disabled`, `deleted`
`disabled_reason` obrigatório	string \| null
`consecutive_failures` obrigatório	integer	de 0 a 9007199254740991
`selected_events` obrigatório	string[]
`product_ids` obrigatório	string[]	Começa com `prd_`
`payment_methods` obrigatório	string[]	Valores: `card`, `pix`
`delivery_mode` obrigatório	"live"
`secret_rotated_at` obrigatório	string \| null
`deleted_at` obrigatório	string \| null
`created_at` obrigatório	string
`signing_secret` obrigatório	string	Padrão `^whsec_live_[A-Za-z0-9_-]+$`

ReplayedRotatedWebhookEndpointSecret

Campos de ReplayedRotatedWebhookEndpointSecret
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `whe_`
`url` obrigatório	string (URL)
`enabled` obrigatório	boolean
`status` obrigatório	string	Valores: `active`, `disabled`, `deleted`
`disabled_reason` obrigatório	string \| null
`consecutive_failures` obrigatório	integer	de 0 a 9007199254740991
`selected_events` obrigatório	string[]
`product_ids` obrigatório	string[]	Começa com `prd_`
`payment_methods` obrigatório	string[]	Valores: `card`, `pix`
`delivery_mode` obrigatório	"live"
`secret_rotated_at` obrigatório	string \| null
`deleted_at` obrigatório	string \| null
`created_at` obrigatório	string
`secret_already_revealed` obrigatório	true

WebhookDelivery

Campos de WebhookDelivery
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `whd_`
`endpoint_id` obrigatório	string	Começa com `whe_`
`event_id` obrigatório	string	Começa com `evt_`
`event_type` obrigatório	string
`attempt` obrigatório	integer	de -∞ a 9007199254740991
`status` obrigatório	string	Valores: `pending`, `delivering`, `succeeded`, `failed`, `dead_letter`
`response_status` obrigatório	integer \| null
`latency_ms` obrigatório	integer \| null
`created_at` obrigatório	string

ApiCredential

Campos de ApiCredential
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `key_`
`name` obrigatório	string
`key_prefix` obrigatório	string
`scopes` obrigatório	string[]	Valores: `payments:read`, `payments:write`, `refunds:write`, `products:read`, `products:write`, `offers:read`, `offers:write`, `orders:read`, `orders:write`, `reports:read`, `finance:read`, `webhooks:write`, `api-keys:write`, `checkout.exports:create`, `checkout.exports:read`
`status` obrigatório	string	Valores: `active`, `revoked`, `expired`
`expires_at` obrigatório	string \| null
`last_used_at` obrigatório	string \| null
`created_at` obrigatório	string
`revoked_at` obrigatório	string \| null

CreatedApiCredential

Campos de CreatedApiCredential
Campo	Tipo	Detalhes
`credential` obrigatório	ApiCredential
`secret` obrigatório	string	Padrão `^sk_(test\|live)_[A-Za-z0-9_-]+$`

ReplayedApiCredential

Campos de ReplayedApiCredential
Campo	Tipo	Detalhes
`credential` obrigatório	ApiCredential
`secret_already_revealed` obrigatório	true

Organization

Campos de Organization
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `org_`
`seller_id` obrigatório	string	Começa com `sel_`
`legal_name` obrigatório	string
`display_name` obrigatório	string
`status` obrigatório	string
`role` obrigatório	string
`capabilities` obrigatório	string[]
`timezone` obrigatório	string	Valores: `America/Sao_Paulo`, `America/Araguaina`, `America/Bahia`, `America/Belem`, `America/Boa_Vista`, `America/Campo_Grande`, `America/Cuiaba`, `America/Eirunepe`, `America/Fortaleza`, `America/Maceio`, `America/Manaus`, `America/Noronha`, `America/Porto_Velho`, `America/Recife`, `America/Rio_Branco`, `America/Santarem`, `UTC`

OrganizationClosureRequest

Campos de OrganizationClosureRequest
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `ocr_`
`organization_id` obrigatório	string	Começa com `org_`
`reason` obrigatório	string \| null
`requested_at` obrigatório	string

Dashboard

Campos de Dashboard
Campo	Tipo	Detalhes
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`total_payments` obrigatório	integer	de 0 a 9007199254740991
`succeeded_payments` obrigatório	integer	de 0 a 9007199254740991
`failed_payments` obrigatório	integer	de 0 a 9007199254740991
`processing_payments` obrigatório	integer	de 0 a 9007199254740991
`gross_volume_minor` obrigatório	string
`recent_payments` obrigatório	object[]
`recent_payments[].id` obrigatório	string
`recent_payments[].status` obrigatório	string
`recent_payments[].amount_minor` obrigatório	string
`recent_payments[].currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`recent_payments[].created_at` obrigatório	string

DashboardPeriod

Campos de DashboardPeriod
Campo	Tipo	Detalhes
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`from` obrigatório	string	Padrão `^\d{4}-\d{2}-\d{2}$`
`to` obrigatório	string	Padrão `^\d{4}-\d{2}-\d{2}$`
`timezone` obrigatório	"UTC"
`generated_at` obrigatório	string
`initiated_payments` obrigatório	integer	de 0 a 9007199254740991
`succeeded_payments` obrigatório	integer	de 0 a 9007199254740991
`failed_payments` obrigatório	integer	de 0 a 9007199254740991
`processing_payments` obrigatório	integer	de 0 a 9007199254740991
`canceled_payments` obrigatório	integer	de 0 a 9007199254740991
`gross_volume_minor` obrigatório	string	Padrão `^[0-9]+$`
`succeeded_refunds` obrigatório	integer	de 0 a 9007199254740991
`refunded_volume_minor` obrigatório	string	Padrão `^[0-9]+$`
`recent_payments` obrigatório	object[]	0 a 20 itens
`recent_payments[].id` obrigatório	string	Começa com `pi_`
`recent_payments[].status` obrigatório	string	Valores: `requires_payment_method`, `requires_action`, `processing`, `succeeded`, `failed`, `canceled`
`recent_payments[].amount_minor` obrigatório	string
`recent_payments[].currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`recent_payments[].created_at` obrigatório	string

AbandonedCheckout

Campos de AbandonedCheckout
Campo	Tipo	Detalhes
`id` obrigatório	string	Padrão `^lead_[A-Za-z0-9]{1,64}$`
`checkout_session_id` obrigatório	string	Começa com `cs_`
`offer_id` obrigatório	string	Começa com `off_`
`product_id` obrigatório	string	Começa com `prd_`
`product_name` obrigatório	string
`amount_minor` obrigatório	string
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`customer` obrigatório	object
`customer.name` obrigatório	string \| null
`customer.email` obrigatório	string \| null
`customer.phone` obrigatório	string \| null
`customer.visibility` obrigatório	string	Valores: `full`, `masked`
`captured_at` obrigatório	string
`reason` obrigatório	string	Valores: `expired`, `inactive`

AbandonedCheckoutPage

Campos de AbandonedCheckoutPage
Campo	Tipo	Detalhes
`data` obrigatório	AbandonedCheckout[]
`next_cursor` obrigatório	string \| null
`timezone` obrigatório	string

CreatedCheckoutRecoveryLink

Campos de CreatedCheckoutRecoveryLink
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `cs_`
`offer_id` obrigatório	string	Começa com `off_`
`amount_minor` obrigatório	string
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`status` obrigatório	string	Valores: `open`, `completed`, `expired`
`payment_intent_id` obrigatório	string \| null
`expires_at` obrigatório	string
`client_secret` obrigatório	string	Começa com `csec_`
`lead_id` obrigatório	string	Padrão `^lead_[A-Za-z0-9]{1,64}$`

ReplayedCheckoutRecoveryLink

Campos de ReplayedCheckoutRecoveryLink
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `cs_`
`offer_id` obrigatório	string	Começa com `off_`
`amount_minor` obrigatório	string
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`status` obrigatório	string	Valores: `open`, `completed`, `expired`
`payment_intent_id` obrigatório	string \| null
`expires_at` obrigatório	string
`secret_already_revealed` obrigatório	true
`lead_id` obrigatório	string	Padrão `^lead_[A-Za-z0-9]{1,64}$`

FinanceSnapshot

Campos de FinanceSnapshot
Campo	Tipo	Detalhes
`balances` obrigatório	object[]
`balances[].code` obrigatório	string
`balances[].currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`balances[].balance_minor` obrigatório	string
`journals` obrigatório	object[]
`journals[].id` obrigatório	string	Começa com `jrn_`
`journals[].source_type` obrigatório	string
`journals[].source_id` obrigatório	string
`journals[].operation_key` obrigatório	string
`journals[].currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`journals[].debit_minor` obrigatório	string
`journals[].credit_minor` obrigatório	string
`journals[].created_at` obrigatório	string

SellerDashboard

Campos de SellerDashboard
Campo	Tipo	Detalhes
`period` obrigatório	string	Valores: `today`, `7d`, `30d`
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`timezone` obrigatório	string	Valores: `America/Sao_Paulo`, `America/Araguaina`, `America/Bahia`, `America/Belem`, `America/Boa_Vista`, `America/Campo_Grande`, `America/Cuiaba`, `America/Eirunepe`, `America/Fortaleza`, `America/Maceio`, `America/Manaus`, `America/Noronha`, `America/Porto_Velho`, `America/Recife`, `America/Rio_Branco`, `America/Santarem`, `UTC`
`from` obrigatório	string
`to` obrigatório	string
`previous_from` obrigatório	string
`previous_to` obrigatório	string
`generated_at` obrigatório	string
`kpis` obrigatório	object
`kpis.gross` obrigatório	object
`kpis.gross.value` obrigatório	string	Padrão `^(0\|[1-9][0-9]*)$`
`kpis.gross.previous` obrigatório	string	Padrão `^(0\|[1-9][0-9]*)$`
`kpis.gross.delta` obrigatório	string	Padrão `^-?(0\|[1-9][0-9]*)$`
`kpis.paid` obrigatório	object
`kpis.paid.value` obrigatório	integer	de 0 a 9007199254740991
`kpis.paid.previous` obrigatório	integer	de 0 a 9007199254740991
`kpis.paid.delta` obrigatório	integer	de -9007199254740991 a 9007199254740991
`kpis.pix_conversion` obrigatório	object
`kpis.pix_conversion.value` obrigatório	integer \| null
`kpis.pix_conversion.previous` obrigatório	integer \| null
`kpis.pix_conversion.delta` obrigatório	integer \| null
`kpis.pix_conversion.numerator` obrigatório	integer	de 0 a 9007199254740991
`kpis.pix_conversion.denominator` obrigatório	integer	de 0 a 9007199254740991
`kpis.pix_conversion.previous_numerator` obrigatório	integer	de 0 a 9007199254740991
`kpis.pix_conversion.previous_denominator` obrigatório	integer	de 0 a 9007199254740991
`kpis.card_approval` obrigatório	object
`kpis.card_approval.value` obrigatório	integer \| null
`kpis.card_approval.previous` obrigatório	integer \| null
`kpis.card_approval.delta` obrigatório	integer \| null
`kpis.card_approval.numerator` obrigatório	integer	de 0 a 9007199254740991
`kpis.card_approval.denominator` obrigatório	integer	de 0 a 9007199254740991
`kpis.card_approval.previous_numerator` obrigatório	integer	de 0 a 9007199254740991
`kpis.card_approval.previous_denominator` obrigatório	integer	de 0 a 9007199254740991
`series` obrigatório	object
`series.granularity` obrigatório	string	Valores: `hour`, `day`
`series.buckets` obrigatório	object[]	0 a 31 itens
`series.buckets[].start` obrigatório	string
`series.buckets[].label` obrigatório	string
`series.buckets[].gross_minor` obrigatório	string	Padrão `^(0\|[1-9][0-9]*)$`
`series.buckets[].pix_minor` obrigatório	string	Padrão `^(0\|[1-9][0-9]*)$`
`series.buckets[].card_minor` obrigatório	string	Padrão `^(0\|[1-9][0-9]*)$`
`series.buckets[].paid_count` obrigatório	integer	de 0 a 9007199254740991
`methods` obrigatório	object[]	2 a 2 itens
`methods[].method` obrigatório	string	Valores: `card`, `pix`
`methods[].paid_count` obrigatório	integer	de 0 a 9007199254740991
`methods[].gross_minor` obrigatório	string	Padrão `^(0\|[1-9][0-9]*)$`
`pix` obrigatório	object
`pix.emitted_count` obrigatório	integer	de 0 a 9007199254740991
`pix.paid_count` obrigatório	integer	de 0 a 9007199254740991
`pix.pending_count` obrigatório	integer	de 0 a 9007199254740991
`pix.expired_count` obrigatório	integer	de 0 a 9007199254740991
`pix.emitted_minor` obrigatório	string	Padrão `^(0\|[1-9][0-9]*)$`
`pix.paid_minor` obrigatório	string	Padrão `^(0\|[1-9][0-9]*)$`
`balances` obrigatório	object
`balances.available_minor` obrigatório	string	Padrão `^-?(0\|[1-9][0-9]*)$`
`balances.pending_minor` obrigatório	string	Padrão `^-?(0\|[1-9][0-9]*)$`
`balances.reserved_minor` obrigatório	string	Padrão `^-?(0\|[1-9][0-9]*)$`
`balances.dispute_hold_minor` obrigatório	string	Padrão `^-?(0\|[1-9][0-9]*)$`
`balances.payout_pending_minor` obrigatório	string	Padrão `^-?(0\|[1-9][0-9]*)$`
`balances.paid_out_minor` obrigatório	string	Padrão `^(0\|[1-9][0-9]*)$`
`waterfall` obrigatório	object
`waterfall.gross_minor` obrigatório	string	Padrão `^(0\|[1-9][0-9]*)$`
`waterfall.refunds_minor` obrigatório	string	Padrão `^(0\|[1-9][0-9]*)$`
`waterfall.disputes_minor` obrigatório	string	Padrão `^(0\|[1-9][0-9]*)$`
`waterfall.fees_minor` obrigatório	string	Padrão `^(0\|[1-9][0-9]*)$`
`waterfall.net_minor` obrigatório	string	Padrão `^-?(0\|[1-9][0-9]*)$`
`waterfall.fees_settled_payments` obrigatório	integer	de 0 a 9007199254740991
`waterfall.succeeded_payments` obrigatório	integer	de 0 a 9007199254740991
`rhythm` obrigatório	object \| object
`recent_sales` obrigatório	object[]	0 a 5 itens
`recent_sales[].payment_intent_id` obrigatório	string	Começa com `pi_`
`recent_sales[].order_id` obrigatório	string \| null
`recent_sales[].amount_minor` obrigatório	string
`recent_sales[].currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`recent_sales[].status` obrigatório	string	Valores: `requires_payment_method`, `requires_action`, `processing`, `succeeded`, `failed`, `canceled`
`recent_sales[].display_status` obrigatório	string	Valores: `pending`, `processing`, `paid`, `declined`, `refunded`, `partially_refunded`, `canceled`, `expired`, `disputed`, `chargeback`, `failed`
`recent_sales[].payment_method` obrigatório	string \| null
`recent_sales[].created_at` obrigatório	string

SellerOrderItem

Campos de SellerOrderItem
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `oi_`
`kind` obrigatório	string	Valores: `main`, `bump`
`offer_id` obrigatório	string	Começa com `off_`
`product_id` obrigatório	string	Começa com `prd_`
`offer_bump_id` obrigatório	string \| null
`amount_minor` obrigatório	string
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`position` obrigatório	integer	de 0 a 3
`product_name` obrigatório	string \| null

SellerOrder

Campos de SellerOrder
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `ord_`
`offer_id` obrigatório	string	Começa com `off_`
`product_id` obrigatório	string	Começa com `prd_`
`checkout_session_id` obrigatório	string \| null
`amount_minor` obrigatório	string
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`status` obrigatório	string	Valores: `pending_payment`, `paid`, `canceled`, `expired`
`paid_payment_intent_id` obrigatório	string \| null
`paid_charge_id` obrigatório	string \| null
`created_at` obrigatório	string
`updated_at` obrigatório	string
`paid_at` obrigatório	string \| null
`canceled_at` obrigatório	string \| null
`expired_at` obrigatório	string \| null
`items` obrigatório	SellerOrderItem[]
`product_name` obrigatório	string
`offer_name` obrigatório	string \| null
`payment_intent_id` obrigatório	string \| null
`payment_method` obrigatório	string \| null
`buyer` obrigatório	object \| null
`buyer.name` obrigatório	string \| null
`buyer.email` obrigatório	string \| null
`buyer.phone` obrigatório	string \| null
`display_status` obrigatório	string	Valores: `pending`, `processing`, `paid`, `declined`, `refunded`, `partially_refunded`, `canceled`, `expired`, `disputed`, `chargeback`, `failed`
`refunded_minor` obrigatório	string	Padrão `^(0\|[1-9][0-9]*)$`

SellerOrderPage

Campos de SellerOrderPage
Campo	Tipo	Detalhes
`data` obrigatório	SellerOrder[]
`next_cursor` obrigatório	string \| null
`counts` obrigatório	object
`counts.all` obrigatório	integer	de 0 a 9007199254740991
`counts.pending` obrigatório	integer	de 0 a 9007199254740991
`counts.processing` obrigatório	integer	de 0 a 9007199254740991
`counts.paid` obrigatório	integer	de 0 a 9007199254740991
`counts.declined` obrigatório	integer	de 0 a 9007199254740991
`counts.refunded` obrigatório	integer	de 0 a 9007199254740991
`counts.partially_refunded` obrigatório	integer	de 0 a 9007199254740991
`counts.canceled` obrigatório	integer	de 0 a 9007199254740991
`counts.expired` obrigatório	integer	de 0 a 9007199254740991
`counts.disputed` obrigatório	integer	de 0 a 9007199254740991
`counts.chargeback` obrigatório	integer	de 0 a 9007199254740991
`counts.failed` obrigatório	integer	de 0 a 9007199254740991

SellerOrderDetail

Campos de SellerOrderDetail
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `ord_`
`offer_id` obrigatório	string	Começa com `off_`
`product_id` obrigatório	string	Começa com `prd_`
`checkout_session_id` obrigatório	string \| null
`amount_minor` obrigatório	string
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`status` obrigatório	string	Valores: `pending_payment`, `paid`, `canceled`, `expired`
`paid_payment_intent_id` obrigatório	string \| null
`paid_charge_id` obrigatório	string \| null
`created_at` obrigatório	string
`updated_at` obrigatório	string
`paid_at` obrigatório	string \| null
`canceled_at` obrigatório	string \| null
`expired_at` obrigatório	string \| null
`items` obrigatório	SellerOrderItem[]
`product_name` obrigatório	string
`offer_name` obrigatório	string \| null
`payment_intent_id` obrigatório	string \| null
`payment_method` obrigatório	string \| null
`buyer` obrigatório	object \| null
`buyer.name` obrigatório	string \| null
`buyer.email` obrigatório	string \| null
`buyer.phone` obrigatório	string \| null
`display_status` obrigatório	string	Valores: `pending`, `processing`, `paid`, `declined`, `refunded`, `partially_refunded`, `canceled`, `expired`, `disputed`, `chargeback`, `failed`
`refunded_minor` obrigatório	string	Padrão `^(0\|[1-9][0-9]*)$`
`buyer_details` obrigatório	object \| null
`buyer_details.name` obrigatório	string \| null
`buyer_details.email` obrigatório	string \| null
`buyer_details.phone` obrigatório	string \| null

SellerProductListItem

Campos de SellerProductListItem
Campo	Tipo	Detalhes
`id` obrigatório	string	Começa com `prd_`
`name` obrigatório	string
`status` obrigatório	string	Valores: `draft`, `active`, `archived`
`created_at` obrigatório	string
`description` obrigatório	string \| null
`category` obrigatório	string \| null
`sales_page_url` obrigatório	string \| null
`guarantee_days` obrigatório	integer	de 0 a 30
`support_name` obrigatório	string \| null
`support_email` obrigatório	string \| null
`support_whatsapp` obrigatório	string \| null
`statement_descriptor` obrigatório	string \| null
`offer_count` obrigatório	integer	de 0 a 9007199254740991
`active_offer_count` obrigatório	integer	de 0 a 9007199254740991
`offers_count` obrigatório	integer	de 0 a 9007199254740991
`links_count` obrigatório	integer	de 0 a 9007199254740991
`bumps_count` obrigatório	integer	de 0 a 9007199254740991
`revenue_30d_minor` obrigatório	string	Padrão `^(0\|[1-9][0-9]*)$`

SellerProductPage

Campos de SellerProductPage
Campo	Tipo	Detalhes
`data` obrigatório	SellerProductListItem[]
`next_cursor` obrigatório	string \| null

FinanceStatement

Campos de FinanceStatement
Campo	Tipo	Detalhes
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`account` obrigatório	"seller_available"
`balance_minor` obrigatório	string	Padrão `^-?(0\|[1-9][0-9]*)$`
`data` obrigatório	object[]
`data[].id` obrigatório	string	Começa com `pst_`
`data[].journal_id` obrigatório	string	Começa com `jrn_`
`data[].source_type` obrigatório	string
`data[].source_id` obrigatório	string
`data[].payment_intent_id` obrigatório	string \| null
`data[].amount_minor` obrigatório	string	Padrão `^-?(0\|[1-9][0-9]*)$`
`data[].balance_after_minor` obrigatório	string	Padrão `^-?(0\|[1-9][0-9]*)$`
`data[].created_at` obrigatório	string
`next_cursor` obrigatório	string \| null

FinanceFees

Campos de FinanceFees
Campo	Tipo	Detalhes
`overrides` obrigatório	object[]
`overrides[].scope` obrigatório	string	Valores: `global`, `seller`, `product`, `offer`
`overrides[].scope_id` obrigatório	string \| null
`overrides[].provider_id` obrigatório	string
`overrides[].fee_basis_points` obrigatório	integer	de 0 a 10000
`overrides[].reserve_basis_points` obrigatório	integer	de 0 a 10000
`overrides[].max_installments` obrigatório	integer	de 1 a 24
`overrides[].version` obrigatório	string

FinanceForecast

Campos de FinanceForecast
Campo	Tipo	Detalhes
`currency` obrigatório	string	Padrão `^[A-Z]{3}$`
`pending_minor` obrigatório	string	Padrão `^-?(0\|[1-9][0-9]*)$`
`data` obrigatório	object[]
`data[].date` obrigatório	string	Padrão `^\d{4}-\d{2}-\d{2}$`
`data[].amount_minor` obrigatório	string	Padrão `^(0\|[1-9][0-9]*)$`
`data[].gross_minor`	string	Padrão `^(0\|[1-9][0-9]*)$`
`data[].fee_minor`	string	Padrão `^(0\|[1-9][0-9]*)$`
`data[].reserve_minor`	string	Padrão `^(0\|[1-9][0-9]*)$`
`data[].payments`	integer	de 0 a 9007199254740991
`data[].methods` obrigatório	object[]
`data[].methods[].payment_method_type` obrigatório	string	Valores: `card`, `pix`
`data[].methods[].amount_minor` obrigatório	string	Padrão `^(0\|[1-9][0-9]*)$`
`data[].methods[].gross_minor` obrigatório	string	Padrão `^(0\|[1-9][0-9]*)$`
`data[].methods[].payments` obrigatório	integer	de 0 a 9007199254740991
`reason` obrigatório	string \| null
`terms` obrigatório	object[]
`terms[].payment_method_type` obrigatório	string	Valores: `card`, `pix`
`terms[].days` obrigatório	integer	de 0 a 60
`terms[].source` obrigatório	string	Valores: `platform_default`, `seller_override`
`held` obrigatório	object
`held.gross_minor` obrigatório	string	Padrão `^(0\|[1-9][0-9]*)$`
`held.payments` obrigatório	integer	de 0 a 9007199254740991
`held.reasons` obrigatório	object[]
`held.reasons[].reason` obrigatório	string	Valores: `dispute_open`, `refund_in_progress`, `settlement_in_progress`, `settlement_mismatch`, `seller_under_review`, `seller_suspended`
`held.reasons[].gross_minor` obrigatório	string	Padrão `^(0\|[1-9][0-9]*)$`
`held.reasons[].payments` obrigatório	integer	de 0 a 9007199254740991

PayerInput

Campos de PayerInput
Campo	Tipo	Detalhes
`name` obrigatório	string	2 a 160 caracteres
`email` obrigatório	string (e-mail)	Padrão `^(?!\.)(?!.\.\.)([A-Za-z0-9_'+\-\.])[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$` até 254 caracteres
`phone`	string	Padrão `^[0-9()+\-.\s]+$` 8 a 32 caracteres
`document`	object
`document.type` obrigatório	string	Valores: `cpf`, `cnpj`
`document.number` obrigatório	string	Padrão `^[0-9A-Za-z./ -]+$` 11 a 18 caracteres

PaymentMethod

Um destes formatos:

object

Campo Tipo Detalhes

type obrigatório "card"
test_card obrigatório string
Valores: approved, declined_insufficient_funds, declined_generic, unavailable_then_approved, unavailable_then_declined
object

Campo Tipo Detalhes

type obrigatório "pix"

CreatePaymentIntentRequest

Campos de CreatePaymentIntentRequest
Campo	Tipo	Detalhes
`amount_minor` obrigatório	string	Padrão `^[1-9][0-9]*$`
`currency`	string	Padrão `^[A-Z]{3}$` Padrão: `"BRL"`
`payment_method_types`	string[]	Valores: `card`, `pix` 1 a 2 itens
`payer`	PayerInput
`description`	string	1 a 500 caracteres
`metadata`	mapa de string	Chaves: `^[A-Za-z0-9_.-]{1,40}$`

ConfirmPaymentIntentRequest

Campos de ConfirmPaymentIntentRequest
Campo	Tipo	Detalhes
`payment_method` obrigatório	PaymentMethod

CreateRefundRequest

Campos de CreateRefundRequest
Campo	Tipo	Detalhes
`amount_minor` obrigatório	string	Padrão `^[1-9][0-9]*$`

CreateSellerPayoutRequest

Campos de CreateSellerPayoutRequest
Campo	Tipo	Detalhes
`amount_minor` obrigatório	string	Padrão `^[1-9][0-9]*$`
`currency`	string	Padrão `^[A-Z]{3}$` Padrão: `"BRL"`

CreateOrderRequest

Campos de CreateOrderRequest
Campo	Tipo	Detalhes
`offer_id` obrigatório	string	Começa com `off_`
`checkout_session_id`	string \| null
`bump_ids`	string[]	Padrão `^ob_[A-Za-z0-9]{1,64}$` 0 a 3 itens

CreateProductRequest

Campos de CreateProductRequest
Campo	Tipo	Detalhes
`name` obrigatório	string	2 a 160 caracteres

UpdateProductRequest

Campos de UpdateProductRequest
Campo	Tipo	Detalhes
`description`	string \| null
`category`	string \| null
`sales_page_url`	string \| null
`guarantee_days`	integer	de 0 a 30
`support_name`	string \| null
`support_email`	string (e-mail) \| null
`support_whatsapp`	string \| null
`statement_descriptor`	string \| null

CreateProductAccessLinkRequest

Campos de CreateProductAccessLinkRequest
Campo	Tipo	Detalhes
`label` obrigatório	string	1 a 80 caracteres
`url` obrigatório	string	9 a 2048 caracteres

CreateOfferRequest

Campos de CreateOfferRequest
Campo	Tipo	Detalhes
`product_id` obrigatório	string	Começa com `prd_`
`amount_minor` obrigatório	string	Padrão `^[1-9][0-9]*$`
`currency`	string	Padrão `^[A-Z]{3}$` Padrão: `"BRL"`

UpdateOfferRequest

Campos de UpdateOfferRequest
Campo	Tipo	Detalhes
`accepted_methods` obrigatório	string[]	Valores: `pix`, `card` 1 a 2 itens

CreateOfferBumpRequest

Campos de CreateOfferBumpRequest
Campo	Tipo	Detalhes
`bump_offer_id` obrigatório	string	Padrão `^off_[A-Za-z0-9]+$` até 128 caracteres
`headline` obrigatório	string	1 a 80 caracteres
`description`	string	até 280 caracteres
`position`	integer	de 0 a 99
`status`	string	Valores: `active`, `inactive`

UpdateOfferBumpRequest

Campos de UpdateOfferBumpRequest
Campo	Tipo	Detalhes
`headline`	string	1 a 80 caracteres
`description`	string	até 280 caracteres
`position`	integer	de 0 a 99
`status`	string	Valores: `active`, `inactive`

CatalogStatusRequest

Campos de CatalogStatusRequest
Campo	Tipo	Detalhes
`status` obrigatório	string	Valores: `draft`, `active`, `archived`

CreateCheckoutSessionRequest

Campos de CreateCheckoutSessionRequest
Campo	Tipo	Detalhes
`offer_id` obrigatório	string	Começa com `off_`
`ttl_minutes`	integer	de 5 a 1440

PayCheckoutSessionRequest

Campos de PayCheckoutSessionRequest
Campo	Tipo	Detalhes
`client_secret` obrigatório	string	Começa com `csec_`
`payer` obrigatório	PayerInput
`payment_method` obrigatório	PaymentMethod
`bump_ids`	string[]	Padrão `^ob_[A-Za-z0-9]{1,64}$` 0 a 3 itens

CheckoutSessionSecretRequest

Campos de CheckoutSessionSecretRequest
Campo	Tipo	Detalhes
`client_secret` obrigatório	string	Começa com `csec_`

CaptureCheckoutLeadRequest

Campos de CaptureCheckoutLeadRequest
Campo	Tipo	Detalhes
`client_secret` obrigatório	string	Começa com `csec_`
`name` obrigatório	string	2 a 160 caracteres
`email` obrigatório	string (e-mail)	Padrão `^(?!\.)(?!.\.\.)([A-Za-z0-9_'+\-\.])[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$` até 254 caracteres
`phone`	string	Padrão `^[0-9()+\-.\s]+$` 8 a 32 caracteres

CreatePaymentLinkRequest

Campos de CreatePaymentLinkRequest
Campo	Tipo	Detalhes
`offer_id` obrigatório	string	Padrão `^off_[A-Za-z0-9]+$` até 128 caracteres

PaymentLinkStatusRequest

Campos de PaymentLinkStatusRequest
Campo	Tipo	Detalhes
`status` obrigatório	string	Valores: `active`, `inactive`

CreateWebhookEndpointRequest

Campos de CreateWebhookEndpointRequest
Campo	Tipo	Detalhes
`url` obrigatório	string (URL)
`selected_events`	string[]	0 a 100 itens Padrão: `[]`
`delivery_mode`	string	Valores: `simulated`, `live` Padrão: `"simulated"`

UpdateWebhookEndpointRequest

Campos de UpdateWebhookEndpointRequest
Campo	Tipo	Detalhes
`status`	string	Valores: `active`, `disabled`
`product_ids`	string[]	Padrão `^prd_[A-Za-z0-9]{1,64}$` 0 a 50 itens
`payment_methods`	string[]	Valores: `card`, `pix` 0 a 2 itens

EmptyRequest

object

CreateApiCredentialRequest

Campos de CreateApiCredentialRequest
Campo	Tipo	Detalhes
`name` obrigatório	string	2 a 80 caracteres
`scopes` obrigatório	string[]	Valores: `payments:read`, `payments:write`, `refunds:write`, `products:read`, `products:write`, `offers:read`, `offers:write`, `orders:read`, `orders:write`, `reports:read`, `finance:read`, `webhooks:write`, `api-keys:write`, `checkout.exports:create`, `checkout.exports:read` 1 a n itens
`expires_at`	string (data-hora ISO-8601) \| null

CreateOrganizationRequest

Campos de CreateOrganizationRequest
Campo	Tipo	Detalhes
`legal_name` obrigatório	string	2 a 160 caracteres
`display_name`	string	2 a 80 caracteres

CreateOrganizationClosureRequest

Campos de CreateOrganizationClosureRequest
Campo	Tipo	Detalhes
`reason`	string	1 a 500 caracteres

UpdateCurrentOrganizationRequest

Campos de UpdateCurrentOrganizationRequest
Campo	Tipo	Detalhes
`timezone` obrigatório	string	Valores: `America/Sao_Paulo`, `America/Araguaina`, `America/Bahia`, `America/Belem`, `America/Boa_Vista`, `America/Campo_Grande`, `America/Cuiaba`, `America/Eirunepe`, `America/Fortaleza`, `America/Maceio`, `America/Manaus`, `America/Noronha`, `America/Porto_Velho`, `America/Recife`, `America/Rio_Branco`, `America/Santarem`, `UTC`