HEhevn-inc
transfers

Retrieve a transfer between the client's own accounts

Changed on

Retrieve the current lifecycle of a swap, the quote it was fixed at and any actionable failure.

get/swaps/{swapId}

Request

Path parameters

swapIdstring 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 swap.

status'awaitingSignature' | 'submitted' | 'settled' | 'failed' required
sourceAccount'USDC' | 'EURC' | 'RD' | 'USDC_ARB' | 'FDIC_USD' | 'FDIC_EUR' | 'KYC_CARDS'
destinationAccount'USDC' | 'EURC' | 'RD' | 'USDC_ARB' | 'FDIC_USD' | 'FDIC_EUR' | 'KYC_CARDS'
transactionHashstring nullable

On-chain transaction hash, when broadcast.

transactionIdstring nullable

Ledger transaction identifier, when projected.

createdAtstring date-time required

UTC timestamp when the swap was created.

settledAtstring date-time nullable

UTC timestamp when settlement completed.

Example response

{
  "id": "swp_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
  "quote": {
    "fromAmount": "500.00",
    "toAmount": "500.00",
    "rate": "500.00",
    "feeAmount": "500.00",
    "minimumToAmount": "500.00"
  },
  "transactionId": "txn_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"
}

Changes

  • 299a3aa6f521Revision changes
    • warning

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

    • 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 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 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 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