Objeto de pagamento

Campos que verá nas respostas da API e/ou nos webhooks quando o estado mudar.

Referência de campos

Campo	Tipo	Descrição
payment_id	string	Id único do pagamento na Cobrex (p-…).
user_id	string	Id de utilizador Cobrex (u-…).
merchant	object	Dados breves do comerciante.
merchant.merchant_id	string	Id do comerciante (m-…).
merchant.name	string	Nome.
merchant.url	string	URL do comerciante.
merchant.fees_on	number	Comportamento de taxas por defeito (contrato/painel).
asset	object	Via de crédito.
asset.name	string	Nome legível (ex.: «Tether USDT TRC-20»).
asset.asset	string	Ticker (USDT, BTC, …).
asset.network	string	Rede (TRON, BTC, …).
txs	array	Transações on-chain relacionadas.
txs[].hash	string	Hash da transação.
txs[].sender	string	Endereço do remetente.
txs[].confirmations	number	Confirmações na rede.
client	string	O seu id externo de cliente / encomenda.
address	string	Endereço de depósito na Cobrex.
amount	string	Montante do pagamento (cadeia decimal).
details	object	Taxas e equivalentes.
details.credited	string	Montante creditado no saldo.
details.fee	string	Taxa de serviço.
details.network_fee	string	Taxa de rede.
details.total_fees	string	Taxas totais.
details.usdt	string	Equivalente em USDT (segundo a Cobrex).
status	object	Estado do processamento.
status.final	boolean	Se o ciclo de vida terminou.
status.code	string	Código grosseiro: PENDING, SUCCESS, FAIL.
status.substatus	string	Detalhe, ex.: PAID.
created_at	string (ISO 8601)	Criação.
updated_at	string (ISO 8601)	Última atualização.
paid_at	string | null	Hora do pagamento bem-sucedido.
canceled_at	string | null	Hora do cancelamento, se aplicável.

Exemplo completo

{
  "payment_id": "p-1a9a67a1-46ce-11f1-8b35-7cc255316480",
  "user_id": "u-96bada25-a20f-49d6-99e9-5893d0769af2",
  "merchant": {
    "merchant_id": "m-ca33fcbe-317f-47fb-bf3a-520827816658",
    "name": "Cobrex",
    "url": "https://cobrex.com",
    "fees_on": 0
  },
  "asset": {
    "name": "Tether USDT TRC-20",
    "asset": "USDT",
    "network": "TRON"
  },
  "txs": [
    {
      "hash": "b9ccd188fa62c4cad987088b25085ee3783fbae8d0884a1d2b416878b99d51ac",
      "sender": "TU4vEruvZwLLkSfV9bNw12EJTPvNr7Pvab",
      "confirmations": 18
    }
  ],
  "client": "743858",
  "address": "TV9jGGXR4SCPGnRMP77pvurBWE5SMjjjvA",
  "amount": "75.000000000000000000",
  "details": {
    "credited": "74.925000000000000000",
    "fee": "0.075000000000000000",
    "network_fee": "0.000000000000000000",
    "total_fees": "0.075000000000000000",
    "usdt": "75.000000000000000000"
  },
  "status": {
    "final": true,
    "code": "SUCCESS",
    "substatus": "PAID"
  },
  "created_at": "2026-05-03T08:57:24.000Z",
  "updated_at": "2026-05-03T08:58:19.000Z",
  "paid_at": "2026-05-03T08:58:19.000Z",
  "canceled_at": null
}

Seguinte: carteira estática, consultar pagamento.