Authorize an outgoing transfer

Verify the developer-key signature against the immutable approval and fund the prepared transfer. A retry cannot change the contact, amount, payment method or quote.

POST /payouts/{payoutId}/confirm

Authorize an outgoing transfer

cURL

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

200

{
  "id": "<string>",
  "kind": "fiat",
  "status": "awaitingSignature",
  "transactionHash": "<string>",
  "transactionId": "txn_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
  "pollUrl": "<string>",
  "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

payoutId · 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

200

application/json

Successful Response

id · string · required

Stable public identifier for this outgoing transfer.

kind · enum<string> · required

Whether the contact is account-based or on-chain.

Available options: fiat, onchain

status · enum<string> · required

Current public lifecycle status of the transfer.

Available options: awaitingSignature, submitted, settled, failed, refunded

transactionHash · string | null

On-chain transaction hash, when broadcast.

transactionId · string | null

Ledger transaction identifier, when created.

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

Example:

"txn_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

pollUrl · string | null

Relative API URL to poll while processing continues.

failure · PayoutFailureView · object | null

Terminal or actionable failure details.

Show child attributes