/api/partner/v2/transactions

Returns a paginated list of on-ramp and off-ramp transactions that belong to your partner account.
Use optional query parameters to filter or paginate the results.

🔐 Headers

Header	Description
`partner-api-key`	API key associated with your partner account. Required. See API Key Generation Guide.

⚠️
This endpoint requires authentication with a valid partner-api-key.

📥 Query Parameters

`Parameter`	`Type`	Required	Description
`id`	`string`	🔘	Transaction identifier.
`status`	`string`	🔘	Filter by transaction status (`FAILED`, `COMPLETED`, `PENDING`, `PENDING_PAYMENT`, `FIAT_PAYMENT_RECEIVED`, `FIAT_RECEIVED`, `CRYPTO_RECEIVED`, `CRYPTO_NOT_RECEIVED`, `COMPLETED_CRYPTO_RECEIVAL`, `EXPIRED`, `CANCELLED`, `IN_PROGRESS`, `BANK_TRANSFER_PENDING`, `READY_BANK_TRANSFER`, `AWAITING_MANUAL_CRYPTO_TRANSFER`, `AWAITING_MANUAL_FIAT_TRANSFER`)
`type`	`string`	🔘	Filter by transaction type (`ON_RAMP` or `OFF_RAMP`).
`fiatCurrency`	`string`	🔘	Fiat currency code (e.g. `MXN`, `USD`).
`userId`	`string`	🔘	Return transactions for a specific user.
`skip`	`number`	🔘	Skip parameter for pagination.
`limit`	`number`	🔘	Maximum number of items per page (1–100). Defaults to `20`.
`sortBy`	`string`	🔘	Field to sort by (e.g. `createdAt`).
`sortOrder`	`string`	🔘	Sort order (`ASC` or `DESC`).

📨 Example Request

curl --request GET \
     --url 'https://staging-api.capa.fi/api/partner/v2/transactions?id=8374f327-38bd-4b0b-b8a7-2524599eb903&type=ON_RAMP&fiatCurrency=MXN&userId=8374f327-38bd-4b0b-b8a7-2524599eb903' \
     --header 'accept: application/json' \
     --header 'partner-api-key: {{API-KEY}}'

📤 Response Body

Field	Type	Description
`success`	`boolean`	`true` if the request was successful.
`data.count`	`number`	Total number of transactions matching the filters.
`data.data[]`	`array`	Array of transaction objects. Each object includes the following fields:
`id`	`string`	Unique ID of the transaction.
`userId`	`string`	User ID associated with the transaction.
`status`	`string`	Current status of the transaction. Default is PENDING on creation
`type`	`string`	Transaction type (`ON_RAMP` or `OFF_RAMP`).
`tokenSymbol`	`string`	Symbol of the cryptocurrency used.
`blockchainSymbol`	`string`	Symbol of the blockchain the crypto belongs to.
`fiatCurrency`	`string`	Fiat currency code (e.g., `MXN`, `DOP`).
`fiatAmount`	`number`	Amount of fiat currency after conversion.
`cryptoAmount`	`string` \| `number`	Amount of crypto used (as string for precision).
`exchangeRate`	`string` \| `number`	Exchange rate used for the conversion.
`premiumSpread`	`string` \| `number`	Premium spread applied to the exchange rate.
`createdAt`	`string`	ISO timestamp when the transaction was created.
`completedAt`	`string` \| `null`	ISO timestamp when the transaction was completed, or `null` if pending.
`destinationWalletAddress`	`string`	Wallet address used for the crypto transfer.
`bankAccount.isVerified`	`boolean`	Whether the bank account is verified.
`bankAccount.accountIdentifier`	`string` \| `null`	CLABE (MX) or account number (DO).
`bankAccount.country`	`string`	Country where the bank account is registered.
`bankAccount.accountType`	`string` \| `null`	Type of bank account. Required for Dominican Republic.
`bankAccount.bankName`	`string` \| `null`	Name of the bank. Required for Dominican Republic.
`bankAccount.documentIdentifier`	`string` \| `null`	ID document linked to the bank account.
`invoice.transactionHash`	`string` \| `null`	Blockchain transaction hash, if available.
`invoice.paymentUrl`	`string` \| `null`	Payment URL for on-ramp invoice payments.

📘 Example Response

{
  "success": true,
  "data": {
    "count": 2,
    "data": [
      {
        "id": "af6e3ab7-b982-4ce7-adf6-f54d4d8de10a",
        "userId": "d3127f5f-ff64-47f9-a9cc-ff603862eca6",
        "status": "PENDING",
        "type": "ON_RAMP",
        "tokenSymbol": "USDC",
        "blockchainSymbol": "OP",
        "fiatCurrency": "DOP",
        "fiatAmount": 12,
        "cryptoAmount": "0.197576",
        "exchangeRate": "60.73613361949396",
        "premiumSpread": "0.02",
        "createdAt": "2025-06-10T05:54:28.572Z",
        "completedAt": null,
        "destinationWalletAddress": "0xc003f42ae20560eb57949038df3542071c6e759b",
        "bankAccount": {
          "country": "DO",
          "accountIdentifier": "00112548542",
          "isVerified": false,
          "bankName": "Sample",
          "accountType": "SAVINGS",
          "documentIdentifier": "123456789013"
        },
        "invoice": {
          "transactionHash": null,
          "paymentUrl": null
        }
      }
    ]
  }
}

⚠️ Important Notes & Requirements

Partner API Key is mandatory: Include PartnerApiKey in the header.
Limit cap: limit must not exceed 100.
Scoped access: You can only retrieve transactions created via your own credentials.
Filtering: Combine filters such as status, type, and userId is valid.

✅ Use Cases

User dashboards: Show a list of past transactions per user.
Reconciliation: Fetch completed flows for accounting.
Customer support: Manually inspect and manage pending transactions.

🔐 Headers

⚠️This endpoint requires authentication with a valid partner-api-key.

📥 Query Parameters

📨 Example Request

📤 Response Body

📘 Example Response

⚠️ Important Notes & Requirements

✅ Use Cases

⚠️
This endpoint requires authentication with a valid `partner-api-key`.