Get channel payment details

GET
/channel-payments/{id}

Fetch particular channel payment details, including its on-chain evidence and conversion outcome.

Authorization

Bearer
headerAuthorizationBearer <JWT>

OAuth access token.

Path Parameters

id*string

Identifier of the channel payment.

Formatuuid

Header Parameters

X-Volt-Api-Version*1

Version of the API used. Currently, version 1 is the only version.

Value in1

Response Body

OK - Successful request, returning given channel payment's details.

application/json
  1. response

An incoming on-chain deposit received on a channel and converted into the channel's crediting wallet. The transaction object carries the on-chain evidence; credited and rate are null until the conversion settles. This object is also the payload of the channel payment webhooks.

id*string

Identifier of the channel payment.

Formatuuid
channelId*string

Identifier of the channel the deposit arrived on.

Formatuuid
status*ChannelPaymentStatusEnum

Channel payment status. On-chain progress is carried by the transaction timestamps, not by the status.

ValueMeaning
PROCESSINGDetected on-chain, awaiting confirmation and crediting.
ON_HOLDHeld for review.
COMPLETEDCredited to the wallet; terminal.
CANCELLEDCancelled or rejected; terminal.
Value in"PROCESSING""ON_HOLD""COMPLETED""CANCELLED"
risk*|

Risk screening of the deposit's on-chain source (provider AML / blockchain analytics). Informational only — crediting is not gated on it. This field is null until reported; the terminal webhook carries the final value.

endUser*

The channel's end user the deposit is attributed to, your correlation key. Only the reference is repeated here; read the channel for the full identity.

transaction*

On-chain evidence. The timestamps are the state: confirmedAt null means detected but not yet confirmed.

paid*|

What arrived on-chain, in the channel's pay currency.

credited*|

What was credited to the wallet after conversion. This field is null until the conversion settles.

rate*|

Settled conversion rate as an exact decimal string: 1 unit of the paid currency equals rate units of the credited currency (credited ≈ paid × rate, subject to rounding). This field is null until the conversion settles.

createdAt*string

Date of payment creation.

Formatdate-time
updatedAt*|

Date of payment's last update.

Formatdate-time
Example Request
curl -X GET 'https://stablecoins.sandbox.volt.io/channel-payments/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'X-Volt-Api-Version: 1'
Example Response
{  "id": "7f3b9d1e-5a2c-4e6f-b8d0-a4c6e8f0b2d4",  "channelId": "9c2e6b4a-8f1d-4c3a-b5e7-d0a2c4e6f8b1",  "status": "COMPLETED",  "risk": {    "level": "LOW"  },  "endUser": {    "reference": "user-8841"  },  "transaction": {    "hash": "0xdef4567890abcdef4567890abcdef4567890abcd",    "detectedAt": "2026-08-25T11:00:00+00:00",    "confirmedAt": "2026-08-25T11:05:00+00:00"  },  "paid": {    "amount": "100.500000",    "currency": "USDC"  },  "credited": {    "amount": "92.29",    "currency": "EUR"  },  "rate": "0.918270",  "createdAt": "2026-08-25T11:00:00+00:00",  "updatedAt": "2026-08-25T11:05:00+00:00"}