HEhevn-inc
transactions

Retrieve one transaction

Changed on

Retrieve one ledger transaction with detailed counterparties, payment references and attachments visible to the selected account.

get/transactions/{transactionId}

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Path parameters

transactionIdstring required

Prefixed transaction id

Headers

X-Hevn-Accountstring nullable

The client account to act for, as a cl_… id. Omit it to act as yourself.

Example:cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41

Response

Successful Response

idstring nullable

Stable public identifier for this transaction.

typestring required

Public transaction type.

status'pending' | 'rfi' | 'success' | 'failed' | 'refunded' required
isIncomeboolean required

Whether this transaction increases the selected account's balance.

account'USDC' | 'EURC' | 'RD' | 'USDC_ARB' | 'FDIC_USD' | 'FDIC_EUR' | 'KYC_CARDS'
counterpartystring nullable

Human-readable counterparty name.

paymentReferencestring nullable

Reference or memo associated with the transfer.

remitterstring nullable

Originator information reported by the payment network.

txHashstring nullable

On-chain transaction hash associated with this ledger entry.

tagstring nullable

Public transaction classification tag.

hasAttachmentsboolean

Whether supporting documents are attached.

createdAtstring date-time required

UTC timestamp when the transaction was created.

descriptionstring nullable

Human-readable description supplied for this transaction.

explorerUrlstring nullable

Public blockchain-explorer URL for the transaction.

traceNumberstring nullable

Account-transfer or payment-network trace identifier.

attachmentIdsstring[]

Supporting document identifiers.

Example response

{
  "id": "txn_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
  "from": {
    "amount": "500.00",
    "usdRate": "500.00"
  },
  "to": {
    "amount": "500.00",
    "usdRate": "500.00"
  },
  "fee": {
    "amount": "500.00",
    "usdRate": "500.00"
  }
}

Changes

  • 299a3aa6f521Revision changes
    • warning

      added the new FDIC_EUR enum value to the / response property for the response status

    • warning

      added the new verification_not_applicable enum value to the / response property for the response status

    • info

      removed the phone_required enum value from the / response property for the response status

    • info

      removed the rail_requirements_unmet enum value from the / response property for the response status

  • a02795de2d2bRevision changes
    • warning

      deleted the header request parameter x-api-key

    • warning

      added the new client_already_linked enum value to the / response property for the response status

    • warning

      added the new kyb_documents_processing enum value to the / response property for the response status

    • warning

      added the new link_code_expired enum value to the / response property for the response status

    • warning

      added the new link_code_invalid enum value to the / response property for the response status

    • warning

      added the new payout_not_awaiting_signature enum value to the / response property for the response status

    • warning

      added the new redirect_uri_not_allowed enum value to the / response property for the response status

    • warning

      added the new sandbox_amount_limit_exceeded enum value to the / response property for the response status

    • warning

      added the new sandbox_faucet_balance_too_high enum value to the / response property for the response status

    • info

      added the optional property to the response with the status

    • info

      removed the client_policy_not_enabled enum value from the / response property for the response status

    • info

      removed the client_request_conflict enum value from the / response property for the response status

    • info

      removed the email_in_use enum value from the / response property for the response status

    • info

      removed the integrator_inactive enum value from the / response property for the response status

    • info

      removed the name_in_use enum value from the / response property for the response status