Retrieve an outgoing transfer

Retrieve the current transfer lifecycle, including quote, contact, settlement result and any actionable failure.

GET /payouts/{payoutId}

Retrieve an outgoing transfer

cURL

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

200

{
  "id": "po_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
  "kind": "fiat",
  "status": "awaitingSignature",
  "createdAt": "2023-11-07T05:31:56Z",
  "quote": {
    "fromAmount": "500.00",
    "fromCurrency": "<string>",
    "toAmount": "500.00",
    "toCurrency": "<string>",
    "rate": "500.00",
    "feeAmount": "500.00",
    "feeCurrency": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z",
    "fromChainId": "<string>",
    "toChainId": "<string>"
  },
  "transactionHash": "<string>",
  "transactionId": "txn_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
  "contact": {
    "contactId": "ct_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41",
    "name": "<string>",
    "address": "<string>",
    "chainId": "<string>",
    "token": "<string>"
  },
  "paymentReference": "<string>",
  "settledAt": "2023-11-07T05:31:56Z",
  "attention": {
    "kind": "rfi",
    "url": "<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

Response

200

application/json

Successful Response

id · string · required

Stable public identifier for this outgoing transfer.

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

Example:

"po_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

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

createdAt · string<date-time> · required

UTC timestamp when the transfer was created.

quote · PayoutQuoteView · object | null

Price, fee and conversion terms fixed at creation.

Show child attributes

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"

contact · PayoutContactView · object | null

Contact snapshot fixed at creation.

Show child attributes

paymentReference · string | null

Reference or memo delivered with the transfer.

settledAt · string<date-time> | null

UTC timestamp when settlement completed.

attention · PayoutAttentionView · object | null

Additional action required before processing.

Show child attributes

failure · PayoutFailureView · object | null

Terminal or actionable failure details.

Show child attributes