Skip to main content
GET
/
v1
/
invoices
/
{id}
Get an invoice
curl --request GET \
  --url https://api.swiftpay.finance/v1/invoices/{id} \
  --header 'X-Swift-Key: <api-key>'
{
  "success": true,
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "merchantId": "m1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "externalRef": "order_8675309",
    "reference": "SP-2024-001",
    "addresses": [
      {
        "networkId": "ethereum",
        "network": "Ethereum",
        "address": "0xDepositAddress..."
      }
    ],
    "recipient": "0xYourWallet...",
    "tokenAddress": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
    "tokenSymbol": "USDC",
    "targetNetwork": "ethereum",
    "amountExpected": "100.00",
    "pendingAmount": "0.00",
    "receivedAmount": "100.00",
    "platformFee": "1.00",
    "amountRemitted": "99.00",
    "overpaidAmount": "0.00",
    "status": "completed",
    "expiresAt": "2024-03-11T11:00:00Z",
    "createdAt": "2024-03-11T10:00:00Z",
    "paidAt": "2024-03-11T10:05:00Z",
    "completedAt": "2024-03-11T10:06:00Z",
    "metadata": {
      "userId": "user_123"
    },
    "transactions": [
      {
        "id": "tx1b2c3d-e5f6-7890-abcd-ef1234567890",
        "invoiceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "invoiceRef": "SP-2024-001",
        "merchantId": "m1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "txHash": "0xabc123def456...",
        "chain": "ethereum",
        "asset": "USDC",
        "amount": "100.00",
        "fee": "1.00",
        "merchantAmount": "99.00",
        "status": "confirmed",
        "type": "payment",
        "blockNumber": 19500000,
        "confirmedAt": "2024-03-11T10:05:30Z",
        "createdAt": "2024-03-11T10:05:00Z"
      }
    ]
  }
}

Authorizations

X-Swift-Key
string
header
required

Your secret API key (sk_live_*). Keep this server-side only.

Path Parameters

id
string<uuid>
required

Invoice ID (UUID)

Response

Invoice found

success
enum<boolean>
Available options:
true
data
object