Skip to main content
GET
/
pay-orders
Error
A valid request URL is required to generate request examples
{
  "data": [
    {
      "created_at": "2023-01-01T00:00:00Z",
      "fulfillment": {
        "amount": {
          "raw_amount": "2400000",
          "ui_amount": 2.4,
          "ui_amount_display": "2.4",
          "value_usd": 123.45
        },
        "asset": {
          "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
          "chain_id": 30000000000001,
          "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"
        },
        "swap": {
          "requested_destination_currency": {
            "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
            "chain_id": 30000000000001
          },
          "requested_source_currency": {
            "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
            "chain_id": 30000000000001
          }
        }
      },
      "hosted_url": "https://pay.coinvoyage.io/pay/cuidjkhg3e289y74u5t6v",
      "id": "cuidjkhg3e289y74u5t6v",
      "metadata": {
        "refund": {
          "additional_info": "Item was never shipped",
          "currency": "USD",
          "name": "Order Cancellation",
          "reason": "Customer requested refund",
          "refund_amount": 99.98
        }
      },
      "mode": "DEPOSIT",
      "organization_id": "org_1234567890abcdef",
      "payment": {
        "destination_tx_hash": "0x5678...efgh",
        "dst": {
          "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
          "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"
        },
        "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",
          "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
          }
        }
      },
      "settings": {
        "hide_footer": true,
        "logo_url": "https://example.com/logo.png",
        "theme_color": "#000000"
      },
      "status": "PENDING",
      "updated_at": "2023-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total_count": 42
  }
}

Documentation Index

Fetch the complete documentation index at: https://coinvoyage-3c99945b.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-API-KEY
string
header
required

Headers

X-API-KEY
string
required

API key for authentication

Query Parameters

limit
integer
default:20

Number of items to return (default: 20, max: 100)

offset
integer
default:0

Number of items to skip (default: 0)

Response

List of pay orders with pagination info

data
object[]
pagination
object
Example:
{
  "limit": 20,
  "offset": 0,
  "total_count": 42
}