Authorize a transfer between the client's own accounts - HEVN

Authorize a transfer between the client's own accounts

curl --request POST \
  --url https://api.example.com/swaps/{swapId}/confirm \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "signature": "<string>"
}
'

import requests

url = "https://api.example.com/swaps/{swapId}/confirm"

payload = { "signature": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({signature: '<string>'})
};

fetch('https://api.example.com/swaps/{swapId}/confirm', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "swp_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
  "status": "awaitingSignature",
  "transactionHash": "<string>",
  "pollUrl": "<string>",
  "failure": {
    "code": "<string>"
  }
}

{
  "id": "swp_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
  "status": "awaitingSignature",
  "transactionHash": "<string>",
  "pollUrl": "<string>",
  "failure": {
    "code": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {}
  }
}

POST

/

swaps

/

{swapId}

/

confirm

Authorize a transfer between the client's own accounts

curl --request POST \
  --url https://api.example.com/swaps/{swapId}/confirm \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "signature": "<string>"
}
'

import requests

url = "https://api.example.com/swaps/{swapId}/confirm"

payload = { "signature": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({signature: '<string>'})
};

fetch('https://api.example.com/swaps/{swapId}/confirm', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "swp_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
  "status": "awaitingSignature",
  "transactionHash": "<string>",
  "pollUrl": "<string>",
  "failure": {
    "code": "<string>"
  }
}

{
  "id": "swp_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
  "status": "awaitingSignature",
  "transactionHash": "<string>",
  "pollUrl": "<string>",
  "failure": {
    "code": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "details": {}
  }
}

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

Body

application/json

signature

string

required

Base64 DER ECDSA P-256/SHA-256 signature over base64decode(approval.payload).

Required string length: 1 - 2048

publicKey

string | null

Registered P-256 public key; omit when the signature uniquely identifies the key.

Required string length: 1 - 512

Response

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

transactionHash

string | null

On-chain transaction hash, when broadcast.

pollUrl

string | null

Relative API URL to poll while processing continues.

failure

SwapFailureView · object | null

Terminal or actionable failure details.

Show child attributes