Skip to main content
GET
/
api
/
partner
/
v2
/
transactions
cURL
curl --request GET \
  --url https://staging-api.capa.fi/api/partner/v2/transactions \
  --header 'partner-api-key: <partner-api-key>'
{
  "success": true,
  "data": {
    "count": 2,
    "data": [
      {
        "id": "tx-1",
        "userId": "user-123",
        "status": "PENDING_PAYMENT",
        "type": "ON_RAMP",
        "exchangeRate": 19.9,
        "createdAt": "2025-05-08T18:00:00Z",
        "tokenSymbol": "USDC",
        "blockchainSymbol": "POL",
        "fiatCurrency": "MXN",
        "fiatAmount": 5000,
        "cryptoAmount": 251.2,
        "premiumSpread": 0.01,
        "forwardingDays": 2,
        "effectiveForwardingDays": 4,
        "forwardingSettlementDate": "2026-03-14T03:25:27.495Z",
        "completedAt": "2025-05-08T18:12:00Z",
        "destinationWalletAddress": "0xabc123...",
        "bankAccount": {
          "country": "MX",
          "isVerified": true,
          "accountIdentifier": "0146...",
          "bankName": "Santander",
          "accountType": "SAVINGS",
          "documentIdentifier": "123abc",
          "bic": "DEUTDEFF",
          "iban": "DE89370400440532013000",
          "routingNumber": "021000021"
        },
        "invoice": {
          "transactionHash": "0xabc123...",
          "paymentUrl": "https://cdn.example.com/invoice"
        },
        "cancellationReason": "Transaction cancelled by user",
        "crossFiatCurrency": "<string>",
        "crossFiatAmount": 123,
        "sourceCurrency": "<string>",
        "targetCurrency": "<string>",
        "sourceAmount": 123,
        "targetAmount": 123,
        "sourceBankAccount": {
          "country": "MX",
          "isVerified": true,
          "accountIdentifier": "0146...",
          "bankName": "Santander",
          "accountType": "SAVINGS",
          "documentIdentifier": "123abc",
          "bic": "DEUTDEFF",
          "iban": "DE89370400440532013000",
          "routingNumber": "021000021"
        },
        "targetBankAccount": {
          "country": "MX",
          "isVerified": true,
          "accountIdentifier": "0146...",
          "bankName": "Santander",
          "accountType": "SAVINGS",
          "documentIdentifier": "123abc",
          "bic": "DEUTDEFF",
          "iban": "DE89370400440532013000",
          "routingNumber": "021000021"
        }
      }
    ]
  }
}
Returns a paginated list of on-ramp, off-ramp, and cross-ramp transactions belonging to your partner account. Use query parameters to filter by status, type, user, receiver, or currency.

​
Important Notes

  • Scoped access: You can only retrieve transactions created via your own partner credentials.
  • Pagination: Use skip and limit to paginate. limit must not exceed 100 (defaults to 20).
  • Combine filters such as status, type, userId, and receiverId freely.

​
Use Cases

  • User dashboards: Display past transactions per user.
  • Reconciliation: Fetch completed transactions for accounting.
  • Customer support: Inspect and manage pending transactions.

​
Error Codes

​
Common Errors

HTTP StatusCodeMessage
401UNAUTHORIZED”API Key is missing”
401UNAUTHORIZED”Invalid API Key format”
401UNAUTHORIZED”Invalid API Key”
403INVALID_PARTNER_FLOW”The partner has an invalid flow.”

​
Endpoint-Specific Errors

HTTP StatusCodeMessage
400INVALID_USER_INPUT_ERROR”Invalid User Input”

Headers

​
partner-api-key
string
required

Api key for the affiliated partner that is performing the request

Query Parameters

​
id
string

Transaction identifier

​
status
enum<string>

Transaction status

Available options:
FAILED,
COMPLETED,
PENDING,
PENDING_PAYMENT,
FIAT_PAYMENT_RECEIVED,
FIAT_RECEIVED,
CRYPTO_RECEIVED,
CRYPTO_NOT_RECEIVED,
COMPLETED_CRYPTO_RECEIVAL,
CANCELLED,
IN_PROGRESS,
BANK_TRANSFER_PENDING,
READY_BANK_TRANSFER,
AWAITING_MANUAL_CRYPTO_TRANSFER,
AWAITING_MANUAL_FIAT_TRANSFER,
PENDING_FUNDS,
FUNDS_RECEIVED,
AWAITING_FUND_TRANSFER
​
type
enum<string>

Transaction type

Available options:
ON_RAMP,
OFF_RAMP,
CROSS_RAMP
​
fiatCurrency
enum<string>

Fiat currency code

Available options:
MXN,
DOP,
USD,
EUR
​
userId
string

User id

​
partnerId
string

Partner identifier

​
receiverId
string

Receiver identifier to filter transactions by receiver

​
skip
number

The number of elements to exclude from the results.

​
limit
number

The maximum amount of results to return.

​
sortBy
string

Supported values:

  • createdAt

Response

200 - application/json

Retrieves transactions of the user associated with the current partner

​
success
boolean
Example:

true

​
data
object