Sign in

v1

latestOpenAPI 3.1.02026-07-1325128129.5 KB
pay-orders

Get Payment Details

Get payment details for a PayOrder

post/pay-orders/{payorder_id}/payment-details

Path parameters

payorder_idstring required

Headers

X-API-KEYstring required

API key for authentication

Request body

refund_addressstring nullable
quote_idstring nullable
payment_rail'CRYPTO' | 'FIAT'

Example request

{
  "payment_rail": "FIAT",
  "source_currency": {
    "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
    "chain_id": 30000000000001
  }
}

Response

Payment details

payorder_idstring required
status'PENDING' | 'EXPIRED' | 'FAILED' | 'AWAITING_PAYMENT' | 'OPTIMISTIC_CONFIRMED' | 'AWAITING_CONFIRMATION' | 'EXECUTING_ORDER' | 'COMPLETED' | 'REFUNDED' | 'PARTIAL_PAYMENT' required

Example response

{
  "data": {
    "destination_tx_hash": "0x5678...efgh",
    "dst": {
      "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "amount_out_minimum": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "chain_id": 30000000000001,
      "currency_amount": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "decimals": 6,
      "id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
      "name": "USD Coin",
      "price_usd": 1,
      "ticker": "USDC"
    },
    "estimated_duration_seconds": 120,
    "expires_at": "2025-11-03T12:30:00Z",
    "fee_tx_hash": "0xfee1...fee2",
    "payment_rail": "CRYPTO",
    "receiving_address": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM",
    "refund_address": "7xVt9ovu6g6E4gvz9K9eV4kxY7yQZ8h3kZ2vY8xZ7xVt",
    "refund_tx_hash": "0x9abc...ijkl",
    "refunded_reason": "execution failed: provider error",
    "source_tx_hash": "0x1234...abcd",
    "src": {
      "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "amount_out_minimum": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "base": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "chain_id": 30000000000001,
      "currency_amount": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "decimals": 6,
      "fees": {
        "custom_fee": {
          "raw_amount": "2400000",
          "ui_amount": 2.4,
          "ui_amount_display": "2.4",
          "value_usd": 123.45
        },
        "protocol_fee": {
          "raw_amount": "2400000",
          "ui_amount": 2.4,
          "ui_amount_display": "2.4",
          "value_usd": 123.45
        },
        "relayer_fee": {
          "raw_amount": "2400000",
          "ui_amount": 2.4,
          "ui_amount_display": "2.4",
          "value_usd": 123.45
        },
        "total_fee": {
          "raw_amount": "2400000",
          "ui_amount": 2.4,
          "ui_amount_display": "2.4",
          "value_usd": 123.45
        }
      },
      "gas": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      },
      "id": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "image_uri": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v/logo.png",
      "name": "USD Coin",
      "price_usd": 1,
      "ticker": "USDC",
      "total": {
        "raw_amount": "2400000",
        "ui_amount": 2.4,
        "ui_amount_display": "2.4",
        "value_usd": 123.45
      }
    },
    "steps": [
      {
        "deposit_address": "5xVt9ovu6g6E4gvz9K9eV4kxY7yQZ8h3kZ2vY8xZ5xVt",
        "kind": "deposit",
        "rail": "CRYPTO"
      }
    ]
  },
  "payorder_id": "cuidjkhg3e289y74u5t6v",
  "status": "AWAITING_PAYMENT"
}