Read a payment session

curl --request GET \
  --url https://server.hypermid.io/v1/payments/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://server.hypermid.io/v1/payments/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "OK",
  "error": null,
  "data": {
    "id": "<string>",
    "status": "<string>",
    "mode": "<string>",
    "environment": "live",
    "merchantName": "<string>",
    "destChain": 123,
    "destToken": "<string>",
    "destAmount": "<string>",
    "openSized": true,
    "recipient": "<string>",
    "payChain": 123,
    "payToken": "<string>",
    "rail": "<string>",
    "depositAddress": "<string>",
    "depositMemo": "<string>",
    "minAmount": "<string>",
    "maxAmount": "<string>",
    "etaSeconds": 123,
    "expiresAt": "2023-11-07T05:31:56Z",
    "deadlineAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "sourceLimits": {},
    "destDecimals": 123,
    "destSymbol": "<string>",
    "destPriceUsd": 123,
    "destPrice": {
      "usdPerToken": "<string>",
      "observedAt": "2023-11-07T05:31:56Z",
      "validUntil": "2023-11-07T05:31:56Z"
    },
    "destAmountUsd": 123,
    "payTxHash": "<string>",
    "paidTxHash": "<string>",
    "paidAmount": "<string>",
    "crossChainEnabled": true,
    "nearEnabled": true,
    "fiatEnabled": true,
    "fiatSupport": {
      "supported": true,
      "reason": "chain-unmapped",
      "min": "<string>",
      "max": "<string>",
      "currency": "<string>"
    },
    "fiatCapabilities": {
      "status": "available",
      "currencies": [
        {
          "code": "<string>",
          "payinModes": [
            "<string>"
          ]
        }
      ]
    },
    "methodOrder": [
      "<string>"
    ],
    "connectPayTestEcosystems": [
      "<string>"
    ],
    "deliveryGuarantee": "exact",
    "refundVaultChains": [
      "<string>"
    ],
    "depositTarget": "<string>",
    "minAmountIn": "<string>",
    "minAmountOut": "<string>",
    "depositedAmount": "<string>",
    "refundedAmount": "<string>",
    "refundReason": "<string>",
    "processingStartedAt": "2023-11-07T05:31:56Z",
    "settlementStatus": "<string>",
    "serverNow": "2023-11-07T05:31:56Z",
    "orderId": "<string>",
    "metadata": {},
    "paidAmountInternal": "<string>",
    "payerAddress": "<string>",
    "successUrl": "<string>",
    "cancelUrl": "<string>",
    "swapRef": "<string>",
    "txHash": "<string>",
    "webhookDelivered": true
  }
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

GET

payments

{id}

Read a payment session

curl --request GET \
  --url https://server.hypermid.io/v1/payments/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://server.hypermid.io/v1/payments/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "OK",
  "error": null,
  "data": {
    "id": "<string>",
    "status": "<string>",
    "mode": "<string>",
    "environment": "live",
    "merchantName": "<string>",
    "destChain": 123,
    "destToken": "<string>",
    "destAmount": "<string>",
    "openSized": true,
    "recipient": "<string>",
    "payChain": 123,
    "payToken": "<string>",
    "rail": "<string>",
    "depositAddress": "<string>",
    "depositMemo": "<string>",
    "minAmount": "<string>",
    "maxAmount": "<string>",
    "etaSeconds": 123,
    "expiresAt": "2023-11-07T05:31:56Z",
    "deadlineAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "sourceLimits": {},
    "destDecimals": 123,
    "destSymbol": "<string>",
    "destPriceUsd": 123,
    "destPrice": {
      "usdPerToken": "<string>",
      "observedAt": "2023-11-07T05:31:56Z",
      "validUntil": "2023-11-07T05:31:56Z"
    },
    "destAmountUsd": 123,
    "payTxHash": "<string>",
    "paidTxHash": "<string>",
    "paidAmount": "<string>",
    "crossChainEnabled": true,
    "nearEnabled": true,
    "fiatEnabled": true,
    "fiatSupport": {
      "supported": true,
      "reason": "chain-unmapped",
      "min": "<string>",
      "max": "<string>",
      "currency": "<string>"
    },
    "fiatCapabilities": {
      "status": "available",
      "currencies": [
        {
          "code": "<string>",
          "payinModes": [
            "<string>"
          ]
        }
      ]
    },
    "methodOrder": [
      "<string>"
    ],
    "connectPayTestEcosystems": [
      "<string>"
    ],
    "deliveryGuarantee": "exact",
    "refundVaultChains": [
      "<string>"
    ],
    "depositTarget": "<string>",
    "minAmountIn": "<string>",
    "minAmountOut": "<string>",
    "depositedAmount": "<string>",
    "refundedAmount": "<string>",
    "refundReason": "<string>",
    "processingStartedAt": "2023-11-07T05:31:56Z",
    "settlementStatus": "<string>",
    "serverNow": "2023-11-07T05:31:56Z",
    "orderId": "<string>",
    "metadata": {},
    "paidAmountInternal": "<string>",
    "payerAddress": "<string>",
    "successUrl": "<string>",
    "cancelUrl": "<string>",
    "swapRef": "<string>",
    "txHash": "<string>",
    "webhookDelivered": true
  }
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

{
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "code": "INVALID_PARAMS",
  "error": "orderId is required",
  "data": null
}

Authorizations

Authorization

string

header

required

Secret partner API key (sk_live_… or sk_test_…). Required to create or manage payment sessions. Server-side only — it can move money, so it must never reach a browser bundle. The key's prefix also selects the environment: sk_test_ is confined to testnets.

Path Parameters

string

required

Response

Merchant payment-session view.

traceId

string

required

W3C trace id of the request — correlate with logs/traces in SigNoz.

Example:

"4bf92f3577b34da6a3ce929d0e0e4736"

code

enum<string>

required

Domain error code. OK on success; non-OK values come with a non-null error.

Available options:

OK,

BAD_REQUEST,

UNAUTHORIZED,

FORBIDDEN,

NOT_FOUND,

CONFLICT,

RATE_LIMITED,

PAYLOAD_TOO_LARGE,

UNSUPPORTED_CHAIN,

INTERNAL_ERROR,

UPSTREAM_TIMEOUT,

UPSTREAM_ERROR,

SERVICE_UNAVAILABLE,

KILL_SWITCH_ACTIVE,

CIRCUIT_BREAKER_OPEN,

NO_QUOTE_AVAILABLE,

QUOTE_STALE,

SIMULATION_REVERTED,

INVALID_PARAMS,

AMOUNT_OUT_OF_BOUNDS,

PAYOUT_TOKEN_NOT_ALLOWED,

RECIPIENT_NOT_ALLOWLISTED,

PAYMENT_EXPIRED,

PAYMENT_NOT_FOUND,

NOT_CONFIGURED,

INSUFFICIENT_LIQUIDITY,

ROUTE_TEMPORARILY_UNAVAILABLE,

UNSUPPORTED_ROUTE,

OVER_DELIVERY_CAP

Example:

"OK"

error

string | null

required

Human-readable error message. null on success.

Example:

null

data

object

required

Endpoint-specific payload. null on error.

Show child attributes

Overview

Endpoints

Webhooks

Read a payment session

Authorizations

Path Parameters

Response