Orders

Pedidos de uma oferta e seus pagamentos.

get /v1/orders — Listar pedidos
post /v1/orders — Criar pedido
get /v1/orders/{id} — Consultar pedido
post /v1/orders/{id}/cancel — Cancelar pedido
post /v1/orders/{id}/expire — Expirar pedido
post /v1/orders/{id}/payment-intents — Criar PaymentIntent do pedido

get/v1/orders

Listar pedidos (listOrders)

Sem parâmetros de consulta a resposta é a lista completa legada ({data}); com qualquer parâmetro ela é paginada por cursor ({data, next_cursor}). Parâmetro desconhecido → 400 VALIDATION_FAILED. A página traz produto, método, comprador mascarado (a***@gmail.com, Ana S.), display_status (vocabulário do painel) e counts por status de exibição para os mesmos filtros, sem o status. q busca por id do pedido/pagamento, e-mail completo do comprador ou parte do nome (3+ caracteres); from/to são datas locais (inclusivas) no fuso da organização; status usa o vocabulário de exibição e ainda aceita pending_payment (status canônico do pedido).

rate limit: api_authenticated

Autenticação: API key (sk_test_...) ou sessão do app do seller
Escopos: orders:read
URL: https://api.v2.wolfpayteste.online/v1/orders

Parâmetros

Nome	Onde	Tipo	Detalhes
`q`	consulta	string	1 a 120 caracteres
`status`	consulta	string \| "pending_payment"
`min_amount`	consulta	string	Padrão `^[1-9][0-9]*$`
`product_id`	consulta	string	Padrão `^prd_[A-Za-z0-9]+$` até 128 caracteres
`offer_id`	consulta	string	Padrão `^off_[A-Za-z0-9]+$` até 128 caracteres
`method`	consulta	string	Valores: `card`, `pix`
`from`	consulta	string	Padrão `^\d{4}-\d{2}-\d{2}$`
`to`	consulta	string	Padrão `^\d{4}-\d{2}-\d{2}$`
`limit`	consulta	integer	de 1 a 100 Padrão: `50`
`cursor`	consulta	string	Padrão `^o1_[0-9a-f]+$` até 2048 caracteres
`wolf-organization-id`	cabeçalho	string	Só para sessão do app do seller com mais de uma organização (senão `409 TENANT_SELECTION_REQUIRED`). Ignorado para API keys. Padrão `^org_`

Resposta 200

Pedidos.

Um destes formatos:

SellerOrderPage
object

Campo Tipo Detalhes

data obrigatório Order[]

Campo	Tipo	Detalhes
`data` obrigatório	Order[]

Exemplo de resposta 200 json

{
  "data": [
    {
      "id": "ord_0f1e2d3c4b5a69788796a5b4c3d2e1f0",
      "offer_id": "off_1b2c3d4e5f60718293a4b5c6d7e8f901",
      "product_id": "prd_7e6d5c4b3a2918f7e6d5c4b3a2918f7e",
      "checkout_session_id": null,
      "amount_minor": "9900",
      "currency": "BRL",
      "status": "paid",
      "paid_payment_intent_id": "pi_3b9f0c2d1e4a5b6c7d8e9f0a1b2c3d4e",
      "paid_charge_id": "chg_8a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d",
      "created_at": "2026-11-06T12:00:00.000Z",
      "updated_at": "2026-11-06T12:00:05.000Z",
      "paid_at": "2026-11-06T12:00:05.000Z",
      "canceled_at": null,
      "expired_at": null,
      "items": [
        {
          "id": "oi_1f2e3d4c5b6a79808f7e6d5c4b3a2918",
          "kind": "main",
          "offer_id": "off_1b2c3d4e5f60718293a4b5c6d7e8f901",
          "product_id": "prd_7e6d5c4b3a2918f7e6d5c4b3a2918f7e",
          "offer_bump_id": null,
          "amount_minor": "9900",
          "currency": "BRL",
          "position": 0,
          "product_name": "Curso de fotografia"
        }
      ],
      "product_name": "Curso de fotografia",
      "offer_name": null,
      "payment_intent_id": "pi_3b9f0c2d1e4a5b6c7d8e9f0a1b2c3d4e",
      "payment_method": "pix",
      "buyer": {
        "name": "Ana C.",
        "email": "a***@example.com",
        "phone": "+55 11 9****-4321"
      },
      "display_status": "paid",
      "refunded_minor": "0"
    }
  ],
  "next_cursor": null,
  "counts": {
    "all": 1,
    "pending": 0,
    "processing": 0,
    "paid": 1,
    "declined": 0,
    "refunded": 0,
    "partially_refunded": 0,
    "canceled": 0,
    "expired": 0,
    "disputed": 0,
    "chargeback": 0,
    "failed": 0
  }
}

Erros

400 — VALIDATION_FAILED
401 — AUTHENTICATION_REQUIRED
403 — FORBIDDEN
409 — TENANT_SELECTION_REQUIRED
429 — RATE_LIMITED
500 — INTERNAL_ERROR

post/v1/orders

Criar pedido (createOrder)

Cria um pedido pending_payment de uma oferta active. bump_ids (opcional, até 3) acrescenta order bumps ativos desta oferta: o servidor valida e precifica cada um, e o amount_minor do pedido é a soma dos items. Bump de outra oferta, inativo, repetido ou desconhecido → 409 BUMP_NOT_AVAILABLE, sem criar nada. Repetir a requisição com a mesma Idempotency-Key e o mesmo corpo devolve o mesmo resultado, sem nova cobrança; corpo diferente → 409 IDEMPOTENCY_CONFLICT.

Idempotency-Key obrigatória rate limit: api_authenticated

Autenticação: API key (sk_test_...) ou sessão do app do seller
Escopos: orders:write
URL: https://api.v2.wolfpayteste.online/v1/orders

Parâmetros

Nome Onde Tipo Detalhes

Nome	Onde	Tipo	Detalhes
`Idempotency-Key`obrigatório	cabeçalho	string	Chave escolhida pelo cliente (8 a 255 caracteres). Mesma chave + mesmo corpo = mesma resposta; corpo diferente = `409 IDEMPOTENCY_CONFLICT`. Guardada por 24 h. 8 a 255 caracteres
`wolf-organization-id`	cabeçalho	string	Só para sessão do app do seller com mais de uma organização (senão `409 TENANT_SELECTION_REQUIRED`). Ignorado para API keys. Padrão `^org_`

Idempotency-Keyobrigatório

cabeçalho

string

Chave escolhida pelo cliente (8 a 255 caracteres). Mesma chave + mesmo corpo = mesma resposta; corpo diferente = 409 IDEMPOTENCY_CONFLICT. Guardada por 24 h.

8 a 255 caracteres

wolf-organization-id

cabeçalho

string

Só para sessão do app do seller com mais de uma organização (senão 409 TENANT_SELECTION_REQUIRED). Ignorado para API keys.

Padrão ^org_

Corpo da requisição

Objeto CreateOrderRequest

Corpo de createOrder
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

Exemplo de corpo json

{
  "offer_id": "off_1b2c3d4e5f60718293a4b5c6d7e8f901",
  "bump_ids": [
    "ob_7d8e9f0a1b2c3d4e5f6a7b8c9d0e1f2a"
  ]
}

Resposta 201

Pedido criado.

Objeto Order

Resposta 201 de createOrder
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

Exemplo de resposta 201 json

{
  "id": "ord_0f1e2d3c4b5a69788796a5b4c3d2e1f0",
  "offer_id": "off_1b2c3d4e5f60718293a4b5c6d7e8f901",
  "product_id": "prd_7e6d5c4b3a2918f7e6d5c4b3a2918f7e",
  "checkout_session_id": null,
  "amount_minor": "12600",
  "currency": "BRL",
  "status": "pending_payment",
  "paid_payment_intent_id": null,
  "paid_charge_id": null,
  "created_at": "2026-11-06T12:00:00.000Z",
  "updated_at": "2026-11-06T12:00:00.000Z",
  "paid_at": null,
  "canceled_at": null,
  "expired_at": null,
  "items": [
    {
      "id": "oi_1f2e3d4c5b6a79808f7e6d5c4b3a2918",
      "kind": "main",
      "offer_id": "off_1b2c3d4e5f60718293a4b5c6d7e8f901",
      "product_id": "prd_7e6d5c4b3a2918f7e6d5c4b3a2918f7e",
      "offer_bump_id": null,
      "amount_minor": "9900",
      "currency": "BRL",
      "position": 0
    },
    {
      "id": "oi_2a3b4c5d6e7f8091a2b3c4d5e6f70819",
      "kind": "bump",
      "offer_id": "off_5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d",
      "product_id": "prd_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f",
      "offer_bump_id": "ob_7d8e9f0a1b2c3d4e5f6a7b8c9d0e1f2a",
      "amount_minor": "2700",
      "currency": "BRL",
      "position": 1
    }
  ]
}

Erros

400 — IDEMPOTENCY_KEY_REQUIRED,VALIDATION_FAILED
401 — AUTHENTICATION_REQUIRED
403 — FORBIDDEN
404 — RESOURCE_NOT_FOUND
409 — BUMP_NOT_AVAILABLE,IDEMPOTENCY_CONFLICT,INVALID_STATE_TRANSITION,TENANT_SELECTION_REQUIRED
429 — RATE_LIMITED
500 — INTERNAL_ERROR

get/v1/orders/{id}

Consultar pedido (getOrder)

O pedido com a visão da listagem e o comprador completo em buyer_details (lido do pagamento do pedido).

rate limit: api_authenticated

Autenticação: API key (sk_test_...) ou sessão do app do seller
Escopos: orders:read
URL: https://api.v2.wolfpayteste.online/v1/orders/{id}

Parâmetros

Nome Onde Tipo Detalhes

Nome	Onde	Tipo	Detalhes
`id`obrigatório	caminho	string	Id do pedido (`ord_...`). mínimo 1 caractere(s)
`wolf-organization-id`	cabeçalho	string	Só para sessão do app do seller com mais de uma organização (senão `409 TENANT_SELECTION_REQUIRED`). Ignorado para API keys. Padrão `^org_`

idobrigatório

caminho

string

Id do pedido (ord_...).

mínimo 1 caractere(s)

wolf-organization-id

cabeçalho

string

Só para sessão do app do seller com mais de uma organização (senão 409 TENANT_SELECTION_REQUIRED). Ignorado para API keys.

Padrão ^org_

Resposta 200

Pedido.

Objeto SellerOrderDetail

Resposta 200 de getOrder
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

Exemplo de resposta 200 json

{
  "id": "ord_0f1e2d3c4b5a69788796a5b4c3d2e1f0",
  "offer_id": "off_1b2c3d4e5f60718293a4b5c6d7e8f901",
  "product_id": "prd_7e6d5c4b3a2918f7e6d5c4b3a2918f7e",
  "checkout_session_id": null,
  "amount_minor": "9900",
  "currency": "BRL",
  "status": "paid",
  "paid_payment_intent_id": "pi_3b9f0c2d1e4a5b6c7d8e9f0a1b2c3d4e",
  "paid_charge_id": "chg_8a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d",
  "created_at": "2026-11-06T12:00:00.000Z",
  "updated_at": "2026-11-06T12:00:05.000Z",
  "paid_at": "2026-11-06T12:00:05.000Z",
  "canceled_at": null,
  "expired_at": null,
  "items": [
    {
      "id": "oi_1f2e3d4c5b6a79808f7e6d5c4b3a2918",
      "kind": "main",
      "offer_id": "off_1b2c3d4e5f60718293a4b5c6d7e8f901",
      "product_id": "prd_7e6d5c4b3a2918f7e6d5c4b3a2918f7e",
      "offer_bump_id": null,
      "amount_minor": "9900",
      "currency": "BRL",
      "position": 0,
      "product_name": "Curso de fotografia"
    }
  ],
  "product_name": "Curso de fotografia",
  "offer_name": null,
  "payment_intent_id": "pi_3b9f0c2d1e4a5b6c7d8e9f0a1b2c3d4e",
  "payment_method": "pix",
  "buyer": {
    "name": "Ana C.",
    "email": "a***@example.com",
    "phone": "+55 11 9****-4321"
  },
  "display_status": "paid",
  "refunded_minor": "0",
  "buyer_details": {
    "name": "Ana Compradora",
    "email": "ana@example.com",
    "phone": "+5511987654321"
  }
}

Erros

401 — AUTHENTICATION_REQUIRED
403 — FORBIDDEN
404 — RESOURCE_NOT_FOUND
409 — TENANT_SELECTION_REQUIRED
429 — RATE_LIMITED
500 — INTERNAL_ERROR
503 — SERVICE_UNAVAILABLE

post/v1/orders/{id}/cancel

Cancelar pedido (cancelOrder)

Idempotency-Key obrigatória rate limit: api_authenticated

Autenticação: API key (sk_test_...) ou sessão do app do seller
Escopos: orders:write
URL: https://api.v2.wolfpayteste.online/v1/orders/{id}/cancel

Parâmetros

Nome Onde Tipo Detalhes

Nome	Onde	Tipo	Detalhes
`id`obrigatório	caminho	string	Id do pedido (`ord_...`). mínimo 1 caractere(s)
`Idempotency-Key`obrigatório	cabeçalho	string	Chave escolhida pelo cliente (8 a 255 caracteres). Mesma chave + mesmo corpo = mesma resposta; corpo diferente = `409 IDEMPOTENCY_CONFLICT`. Guardada por 24 h. 8 a 255 caracteres
`wolf-organization-id`	cabeçalho	string	Só para sessão do app do seller com mais de uma organização (senão `409 TENANT_SELECTION_REQUIRED`). Ignorado para API keys. Padrão `^org_`

idobrigatório

caminho

string

Id do pedido (ord_...).

mínimo 1 caractere(s)

Idempotency-Keyobrigatório

cabeçalho

string

Chave escolhida pelo cliente (8 a 255 caracteres). Mesma chave + mesmo corpo = mesma resposta; corpo diferente = 409 IDEMPOTENCY_CONFLICT. Guardada por 24 h.

8 a 255 caracteres

wolf-organization-id

cabeçalho

string

Só para sessão do app do seller com mais de uma organização (senão 409 TENANT_SELECTION_REQUIRED). Ignorado para API keys.

Padrão ^org_

Resposta 200

Pedido cancelado.

Objeto Order

Resposta 200 de cancelOrder
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

Erros

400 — IDEMPOTENCY_KEY_REQUIRED,VALIDATION_FAILED
401 — AUTHENTICATION_REQUIRED
403 — FORBIDDEN
404 — RESOURCE_NOT_FOUND
409 — IDEMPOTENCY_CONFLICT,INVALID_STATE_TRANSITION,TENANT_SELECTION_REQUIRED
429 — RATE_LIMITED
500 — INTERNAL_ERROR

post/v1/orders/{id}/expire

Expirar pedido (expireOrder)

Idempotency-Key obrigatória rate limit: api_authenticated

Autenticação: API key (sk_test_...) ou sessão do app do seller
Escopos: orders:write
URL: https://api.v2.wolfpayteste.online/v1/orders/{id}/expire

Parâmetros

Nome Onde Tipo Detalhes

Nome	Onde	Tipo	Detalhes
`id`obrigatório	caminho	string	Id do pedido (`ord_...`). mínimo 1 caractere(s)
`Idempotency-Key`obrigatório	cabeçalho	string	Chave escolhida pelo cliente (8 a 255 caracteres). Mesma chave + mesmo corpo = mesma resposta; corpo diferente = `409 IDEMPOTENCY_CONFLICT`. Guardada por 24 h. 8 a 255 caracteres
`wolf-organization-id`	cabeçalho	string	Só para sessão do app do seller com mais de uma organização (senão `409 TENANT_SELECTION_REQUIRED`). Ignorado para API keys. Padrão `^org_`

idobrigatório

caminho

string

Id do pedido (ord_...).

mínimo 1 caractere(s)

Idempotency-Keyobrigatório

cabeçalho

string

Chave escolhida pelo cliente (8 a 255 caracteres). Mesma chave + mesmo corpo = mesma resposta; corpo diferente = 409 IDEMPOTENCY_CONFLICT. Guardada por 24 h.

8 a 255 caracteres

wolf-organization-id

cabeçalho

string

Só para sessão do app do seller com mais de uma organização (senão 409 TENANT_SELECTION_REQUIRED). Ignorado para API keys.

Padrão ^org_

Resposta 200

Pedido expirado.

Objeto Order

Resposta 200 de expireOrder
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

Erros

400 — IDEMPOTENCY_KEY_REQUIRED,VALIDATION_FAILED
401 — AUTHENTICATION_REQUIRED
403 — FORBIDDEN
404 — RESOURCE_NOT_FOUND
409 — IDEMPOTENCY_CONFLICT,INVALID_STATE_TRANSITION,TENANT_SELECTION_REQUIRED
429 — RATE_LIMITED
500 — INTERNAL_ERROR

post/v1/orders/{id}/payment-intents

Criar PaymentIntent do pedido (createOrderPaymentIntent)

Cria um PaymentIntent com o valor e a moeda do pedido, ligado a ele (order_id). Um pedido tem no máximo um PaymentIntent vivo.

Idempotency-Key obrigatória rate limit: api_authenticatedrate limit: payment_intent_create

Autenticação: API key (sk_test_...) ou sessão do app do seller
Escopos: payments:write
URL: https://api.v2.wolfpayteste.online/v1/orders/{id}/payment-intents

Parâmetros

Nome Onde Tipo Detalhes

Nome	Onde	Tipo	Detalhes
`id`obrigatório	caminho	string	Id do pedido (`ord_...`). mínimo 1 caractere(s)
`Idempotency-Key`obrigatório	cabeçalho	string	Chave escolhida pelo cliente (8 a 255 caracteres). Mesma chave + mesmo corpo = mesma resposta; corpo diferente = `409 IDEMPOTENCY_CONFLICT`. Guardada por 24 h. 8 a 255 caracteres
`wolf-organization-id`	cabeçalho	string	Só para sessão do app do seller com mais de uma organização (senão `409 TENANT_SELECTION_REQUIRED`). Ignorado para API keys. Padrão `^org_`

idobrigatório

caminho

string

Id do pedido (ord_...).

mínimo 1 caractere(s)

Idempotency-Keyobrigatório

cabeçalho

string

Chave escolhida pelo cliente (8 a 255 caracteres). Mesma chave + mesmo corpo = mesma resposta; corpo diferente = 409 IDEMPOTENCY_CONFLICT. Guardada por 24 h.

8 a 255 caracteres

wolf-organization-id

cabeçalho

string

Só para sessão do app do seller com mais de uma organização (senão 409 TENANT_SELECTION_REQUIRED). Ignorado para API keys.

Padrão ^org_

Resposta 201

PaymentIntent criado para o pedido.

Objeto PaymentIntent

Resposta 201 de createOrderPaymentIntent
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

Erros

400 — IDEMPOTENCY_KEY_REQUIRED,VALIDATION_FAILED
401 — AUTHENTICATION_REQUIRED
403 — FORBIDDEN
404 — RESOURCE_NOT_FOUND
409 — IDEMPOTENCY_CONFLICT,INVALID_STATE_TRANSITION,PAYMENT_LIMIT_EXCEEDED,TENANT_SELECTION_REQUIRED
429 — RATE_LIMITED
500 — INTERNAL_ERROR