Skip to main content
GET
/
v1
/
invoices
List invoices
curl --request GET \
  --url https://api.swiftpay.finance/v1/invoices \
  --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": []
    }
  ],
  "metadata": {
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 42,
      "totalPages": 3
    }
  }
}

Authorizations

X-Swift-Key
string
header
required

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

Query Parameters

page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
limit
integer
default:20

Number of results per page

Required range: 1 <= x <= 100

Response

Paginated invoice list

success
enum<boolean>
Available options:
true
data
object[]
metadata
object