Retrieve a transfer between the client's own accounts

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

GET /swaps/{swapId}

Retrieve a transfer between the client's own accounts

cURL

curl --request GET \
  --url https://api.example.com/swaps/{swapId} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "swp_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
  "status": "awaitingSignature",
  "createdAt": "2023-11-07T05:31:56Z",
  "sourceAccount": "USDC",
  "destinationAccount": "USDC",
  "quote": {
    "fromAmount": "500.00",
    "fromCurrency": "<string>",
    "toAmount": "500.00",
    "toCurrency": "<string>",
    "rate": "500.00",
    "feeAmount": "500.00",
    "feeCurrency": "<string>",
    "minimumToAmount": "500.00",
    "estimated": false,
    "etaHours": 123,
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "transactionHash": "<string>",
  "transactionId": "txn_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
  "settledAt": "2023-11-07T05:31:56Z",
  "failure": {
    "code": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Hevn-Account · string | null

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

Example:

"cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

x-api-key · string | null

Path Parameters

swapId · string · required

Response

200

application/json

Successful Response

id · string · required

Stable public identifier for this swap.

Pattern: ^(?:swp_)?[A-Za-z0-9._:\-]{1,216}$

Example:

"swp_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

status · enum<string> · required

Current public lifecycle status of the swap.

Available options: awaitingSignature, submitted, settled, failed

createdAt · string<date-time> · required

UTC timestamp when the swap was created.

sourceAccount · enum<string> | null

Account the money leaves.

Available options: USDC, EURC, FDIC_USD

destinationAccount · enum<string> | null

Account the money lands on.

Available options: USDC, EURC, FDIC_USD

quote · SwapQuoteView · object | null

Terms fixed when the swap was created.

Show child attributes

transactionHash · string | null

On-chain transaction hash, when broadcast.

transactionId · string | null

Ledger transaction identifier, when projected.

Pattern: ^(?:txn_)?[A-Za-z0-9._:\-]{1,216}$

Example:

"txn_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

settledAt · string<date-time> | null

UTC timestamp when settlement completed.

failure · SwapFailureView · object | null

Terminal or actionable failure details.

Show child attributes