---
title: "Get Payout details"
method: GET
path: "/v3/payouts/{id}"
tags: ["Payout"]
---

# Get Payout details

`GET /v3/payouts/{id}`

## Request

- Base URL: `https://confirmo.net/api`
- URL: `https://confirmo.net/api/v3/payouts/{id}`
- Auth: HTTP bearer

Retrieves detailed information about a specific Payout by its ID.

## Path parameters

- `id` string, required

## Response `200`

OK

- PayoutToV3
  - `address` string
  - `amountFrom` number
  - `amountTo` number
  - `btcPriority` 'LOW' | 'MEDIUM' | 'HIGH': Valid only for the payment method for native BTC. For BTC transactions, HIGH is default.
  - `completedAt` integer
  - `createdAt` integer
  - `currencyFrom` 'BTC' | 'CZK' | 'EUR' | 'USD' | 'USDC' | 'USDT': Balance of this asset is affected by the payout.
  - `currencyTo` 'BNB' | 'BTC' | 'ETH' | 'EURC' | 'LTC' | 'POL' | 'SOL' | 'TRX' | 'USAT' | 'USDC' | 'USDG' | 'USDT' | 'XPL': Superseded by paymentMethodId.
  - `customerEmail` string: The email address to which email notifications for the customer will be sent.
  - `customerProfile` CustomerProfileReferenceTo: Customer profile reference
    - `profileId` string: Merchant's identifier of the customer profile.
  - `debitedAmount` number: The debited amount (in currencyFrom asset) from merchant balance.
  - `exchangeRate` number: Price of one crypto in source asset.
  - `expiration` integer
  - `fee` number
  - `feeCurrency` string: The same asset code as currencyFrom.
  - `feePaymentMode` 'MERCHANT' | 'RECIPIENT' | 'NETWORK_FEE_RECIPIENT'
  - `id` string
  - `layer2Attributes` LightningLayerAttributesTo
    - `protocolName` 'LIGHTNING' | 'POLYGON' | 'ARBITRUM' | 'OPTIMISM': Layer 2 protocol name.
    - `bolt` string
    - `lnurl` string
    - `paymentHash` string
  - `notifyEmail` string: E-mail where payout notifications will be sent.
  - `notifyUrl` string, url: Webhook URL where payout webhooks will be sent.
  - `paymentMethodId` string
  - `reference` string: Any data the merchant wishes to store in the payout. It might be, for instance, a JSON or any other string identifying the payout in the merchant's system. The maximum length is 512 characters.
  - `sentAt` integer
  - `sourceAddresses` string[]
  - `status` string: Indicates the state of the payout. See the statuses section in the documentation for all possible values.
  - `substatus` string: Set on a `canceled` payout when the reason is one the catalogue names (`screening_rejected`, `verification_rejected`, `manually_canceled`). Not every cancellation has a reason to report, so its absence is not itself information. The one non-terminal value is `compliance_hold`: the payout is held in `confirmed` for an extended review while funds stay reserved — substatus changes never fire webhooks, so re-query the payout if it stays `confirmed` unusually long. Treat this as an open set: new values are added as they are announced, and your integration must tolerate ones it does not recognise.
  - `treatAsGrossAmount` boolean: The total fee (processing and network) was deducted from the requested amount.
  - `txid` string
  - `url` string, uri: The URL of the Payout's public view for the customers.
  - `validTo` integer: The time until which the transaction is valid to. After this time the transaction is not registered.

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict

---

[API](https://skmtc.dev/confirmo/apis/confirmo-api.md) - [All operations](https://skmtc.dev/confirmo/apis/confirmo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/confirmo/apis/confirmo-api/revisions/09bef7db3dd1?raw)