--- updatedAt: 2026-05-07T09:33:30.000Z agentTools: projectIndex: https://docs.getorbital.com/llms.txt --- # Get Crypto Payment Details - Payout Retrieve the full details of a cryptocurrency Payout using its unique transaction ID. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Get Crypto Payment by ID API", "version": "1.0.0", "description": "API endpoint to retrieve details of a specific cryptocurrency payment by its unique ID." }, "servers": [ { "url": "https://api.getorbital.io", "description": "Production server" } ], "paths": { "/crypto/payment/{id}": { "get": { "summary": "Get Crypto Payment Details - Payout", "description": "Retrieve the full details of a cryptocurrency Payout using its unique transaction ID.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "example": "d9b0645e-ae4b-447c-96c7-a1cf577c27e9" }, "description": "The unique identifier of the crypto payment transaction. " } ], "responses": { "200": { "description": "Payment details retrieved successfully - Payout", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "Indicates the status of the API request (e.g., 'success')." }, "data": { "type": "object", "description": "The core data object containing the payment details.", "properties": { "id": { "type": "string", "format": "uuid", "description": "The unique identifier of this specific crypto payment transaction." }, "externalId": { "type": "string", "description": "An optional identifier provided by an external system for this payment." }, "type": { "type": "string", "description": "The type of payment, either 'payin' (deposit) or 'payout' (withdrawal/payment sent)." }, "subType": { "type": "string", "description": "A more granular categorization of the payment type, e.g., 'channel'." }, "targetAmount": { "type": "string", "description": "The amount of cryptocurrency in the target currency (e.g., USDT)." }, "targetCurrency": { "type": "string", "description": "The currency of the target amount (e.g. 'USDT')." }, "sourceAmount": { "type": "string", "description": "The original amount in the source currency." }, "sourceCurrency": { "type": "string", "description": "The currency of the source amount (e.g., 'USD')." }, "cashierAmount": { "type": "string", "description": "The amount processed by the cashier service." }, "cashierCurrency": { "type": "string", "description": "The currency used by the cashier service." }, "mainCurrency": { "type": "string", "description": "The blockchain network for stablecoin (USDT or USDC) payments (e.g., 'ETH', 'TRX', 'BNB', 'MATIC', 'SOL', 'TON')." }, "status": { "type": "string", "description": "The current status of the payment (e.g., 'confirmed', 'pending', 'failed')." }, "kytAlertLevel": { "type": "string", "description": "Know Your Transaction (KYT) alert level, indicating potential risk (e.g., 'unknown', 'low', 'medium', 'high')." }, "kytStatus": { "type": "string", "description": "The status of the KYT review (e.g., 'no_review', 'in_review', 'cleared', 'flagged')." }, "notifyUrl": { "type": "string", "format": "uri", "description": "A webhook URL where Orbital sends notifications about status changes for this payment." }, "accountId": { "type": "string", "format": "uuid", "description": "The unique identifier of the user's account within the Orbital system associated with this payment." }, "blockchainTransactions": { "type": "array", "description": "An array of details for the underlying blockchain transactions related to this payment.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for this blockchain transaction record." }, "state": { "type": "string", "description": "The current state of the blockchain transaction (e.g., 'complete', 'pending', 'failed')." }, "direction": { "type": "string", "description": "The direction of the transaction (e.g., 'incoming', 'outgoing')." }, "amount": { "type": "string", "description": "The amount involved in the blockchain transaction, typically in the smallest unit (e.g., satoshis for BTC, wei for ETH)." }, "decimals": { "type": "integer", "description": "The number of decimal places for the blockchain transaction amount." }, "txHash": { "type": "string", "description": "The transaction hash on the blockchain." }, "vendorExternalId": { "type": "string", "description": "An external ID from the blockchain vendor or service." }, "currency": { "type": "string", "description": "The cryptocurrency of this blockchain transaction (e.g., 'USDT', 'BTC')." }, "createdAt": { "type": "string", "format": "date-time", "description": "The timestamp when this blockchain transaction record was created." }, "updatedAt": { "type": "string", "format": "date-time", "description": "The timestamp when this blockchain transaction record was last updated." }, "sourceAddresses": { "type": "array", "description": "A list of source wallet addresses for this blockchain transaction.", "items": { "type": "string" } }, "destinationAddresses": { "type": "array", "description": "A list of destination wallet addresses for this blockchain transaction.", "items": { "type": "string" } } } } }, "exchangeTransactions": { "type": "array", "description": "An array of details for any currency exchange operations that occurred as part of this payment.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for this exchange transaction record." }, "sourceCurrency": { "type": "string", "description": "The source currency of the exchange." }, "sourceAmount": { "type": "string", "description": "The amount in the source currency." }, "targetCurrency": { "type": "string", "description": "The target currency of the exchange." }, "targetAmount": { "type": "string", "description": "The amount in the target currency." }, "createdAt": { "type": "string", "format": "date-time", "description": "The timestamp when this exchange transaction record was created." } } } }, "fees": { "type": "array", "description": "An array listing any fees applied to this payment transaction.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for this fee record." }, "currency": { "type": "string", "description": "The currency in which the fee is charged." }, "amount": { "type": "string", "description": "The amount of the fee." }, "type": { "type": "string", "description": "The type of fee (e.g., 'crypto_fx' for crypto foreign exchange fees)." }, "createdAt": { "type": "string", "format": "date-time", "description": "The timestamp when this fee record was created." } } } }, "rates": { "type": "array", "description": "An array showing the exchange rates applied during the transaction for different currency pairs.", "items": { "type": "object", "properties": { "ticker": { "type": "string", "description": "The currency pair for the rate (e.g., 'USD_USDT')." }, "amount": { "type": "string", "description": "The amount used in the rate calculation." }, "price": { "type": "string", "description": "The price or converted amount based on the rate." }, "rate": { "type": "string", "description": "The actual exchange rate." }, "createdAt": { "type": "string", "format": "date-time", "description": "The timestamp when this rate was determined." } } } }, "createdAt": { "type": "string", "format": "date-time", "description": "The timestamp when the overall payment record was created." }, "updatedAt": { "type": "string", "format": "date-time", "description": "The timestamp when the overall payment record was last updated." } } }, "message": { "type": "string", "description": "Message indicating the result of the API request (e.g., 'Payment retrieved successfully')." } }, "example": { "status": "success", "data": { "id": "d9b0645e-ae4b-447c-96c7-a1cf577c27e9", "externalId": "3a25935e-3030-4079-a2d3-0dab03cbc6fe9", "type": "payout", "subType": "channel", "targetAmount": "1.4988", "targetCurrency": "USDT", "sourceAmount": "1.50", "sourceCurrency": "USD", "cashierAmount": "1.50", "cashierCurrency": "USD", "status": "confirmed", "kytAlertLevel": "unknown", "kytStatus": "no_review", "notifyUrl": "https://webhook.site/aa99fdfe-12bb-4b5f-b885-0a7b5664129d", "accountId": "13527a47-526b-4832-96b3-66fdcb0fc301", "blockchainTransactions": [ { "id": "3a37beee-f513-444b-9e34-aeb8a5ac80f8", "state": "complete", "direction": "outgoing", "amount": "1498800", "decimals": 6, "txHash": "3a37beeef513444b9e34aeb8a5ac80f8", "vendorExternalId": "368608554669973504", "currency": "USDT", "createdAt": "2025-06-09T15:38:54.716Z", "updatedAt": "2025-06-09T15:39:01.121Z", "sourceAddresses": [], "destinationAddresses": [] } ], "exchangeTransactions": [ { "id": "fae1a8c9-8197-4ca0-9da8-3a692acd36b3", "sourceCurrency": "USD", "sourceAmount": "1.50", "targetCurrency": "USD", "targetAmount": "1.50", "createdAt": "2025-06-09T15:38:54.479Z" }, { "id": "29cd4b7d-2e4d-4134-9609-c5252bc49545", "sourceCurrency": "USD", "sourceAmount": "1.50", "targetCurrency": "USDT", "targetAmount": "1.4988", "createdAt": "2025-06-09T15:38:54.504Z" } ], "fees": [ { "id": "be03c61f-8d69-4dce-9503-facdf6ccaf34", "currency": "USD", "amount": "0.02", "type": "crypto_fx", "createdAt": "2025-06-09T15:38:54.533Z" } ], "rates": [ { "ticker": "USD_USD", "amount": "1.50", "price": "1.50", "rate": "1" }, { "ticker": "USD_USDT", "amount": "1.50", "price": "1.4988", "rate": "1.0008", "createdAt": "2025-06-09T15:38:54.488Z" } ], "createdAt": "2025-06-09T15:38:54.448Z", "updatedAt": "2025-06-09T15:39:03.725Z" }, "message": "Payment retrieved successfully" } } } } }, "401": { "description": "Unauthorized. Authentication is required or the provided API Key is invalid.", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "A message indicating that authentication failed or is required." } } }, "example": { "message": "Unauthorized" } } } }, "404": { "description": "Not Found. The provided `id` does not correspond to an existing crypto payment transaction.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "Indicates the status of the API request (e.g., 'fail')." }, "data": { "type": "object", "description": "Contains information about the requested resource that was not found.", "properties": { "id": { "type": "string", "format": "uuid", "description": "The ID of the payment that was not found." } } }, "message": { "type": "string", "description": "A message indicating that the requested resource was not found." } } }, "example": { "status": "fail", "data": { "id": "038f1bc2-2de9-4ae5-9dc2-a9ef99aa1dee" }, "message": "Payment not found" } } } } }, "security": [ { "apiKeyAuth": [] } ] } } }, "components": { "securitySchemes": { "apiKeyAuth": { "type": "apiKey", "in": "header", "name": "x-api-key" } } } } ```