Submit the signature for a prepared escrow action

Submit the signature for the previously prepared escrow action. The path idempotency key must match the prepared action and makes safe retries return the first result.

POST /escrow/{escrowId}/actions/{idempotencyKey}/confirm

Submit the signature for a prepared escrow action

cURL

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

200

{
  "deal": {
    "id": "<string>",
    "status": "draft",
    "availableActions": [
      "approve"
    ],
    "sender": {
      "clientId": "<string>"
    },
    "receiver": {
      "clientId": "<string>"
    },
    "onchainEscrowUrl": "<string>",
    "token": "<string>",
    "maxAmount": "500.00",
    "authorizedAmount": "500.00",
    "capturableAmount": "500.00",
    "refundableAmount": "500.00",
    "windows": {
      "approveBy": "2023-11-07T05:31:56Z",
      "holdUntil": "2023-11-07T05:31:56Z",
      "refundableUntil": "2023-11-07T05:31:56Z"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "completionConditions": "<string>",
    "action": {
      "action": "approve",
      "idempotencyKey": "<string>",
      "status": "awaitingSignature",
      "amount": "500.00",
      "feeBps": 123,
      "transactionHash": "<string>",
      "approval": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "payload": "<string>",
        "expiresAt": "2023-11-07T05:31:56Z"
      }
    },
    "consistent": true
  },
  "action": {
    "action": "approve",
    "idempotencyKey": "<string>",
    "status": "awaitingSignature",
    "amount": "500.00",
    "feeBps": 123,
    "transactionHash": "<string>",
    "approval": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payload": "<string>",
      "expiresAt": "2023-11-07T05:31:56Z"
    }
  },
  "events": [
    {
      "name": "<string>",
      "transactionHash": "<string>",
      "blockNumber": 123,
      "amount": "500.00"
    }
  ],
  "pollUrl": "<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"

Path Parameters

escrowId · string · required

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

idempotencyKey · string · required

Required string length: 1 - 128

Body

application/json

signature · string · required

Base64 DER ECDSA P-256/SHA-256 signature over the decoded 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

200

application/json

Successful Response

deal · EscrowView · object · required

Latest escrow state after processing the action.

Show child attributes

action · EscrowActionView · object · required

Prepared or submitted action.

Show child attributes

events · EscrowEventView · object[]

Observed on-chain events for this action.

Show child attributes

pollUrl · string | null

Relative API URL to poll while processing continues.