HEhevn-inc
transfers

Retrieve an outgoing transfer

Changed on

Retrieve the current transfer lifecycle, including quote, contact, settlement result and any actionable failure.

get/payouts/{payoutId}

Request

Path parameters

payoutIdstring required

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 required

Stable public identifier for this outgoing transfer.

kind'fiat' | 'onchain' required
status'awaitingSignature' | 'submitted' | 'settled' | 'failed' | 'refunded' required
transactionHashstring nullable

On-chain transaction hash, when broadcast.

transactionIdstring nullable

Ledger transaction identifier, when created.

paymentReferencestring nullable

Reference or memo delivered with the transfer.

createdAtstring date-time required

UTC timestamp when the transfer was created.

settledAtstring date-time nullable

UTC timestamp when settlement completed.

Example response

{
  "id": "po_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
  "quote": {
    "fromAmount": "500.00",
    "toAmount": "500.00",
    "rate": "500.00",
    "feeAmount": "500.00"
  },
  "transactionId": "txn_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
  "contact": {
    "contactId": "ct_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"
  }
}

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 KYC_CARDS enum value to the /// response property for the response status

    • warning

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

    • warning

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

    • 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

      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