GET
/
api
/
partner
/
v1
/
transactions
/
users
/
{userId}
cURL
curl --request GET \
  --url https://staging-api.capa.fi/api/partner/v1/transactions/users/{userId} \
  --header 'partner-api-key: <partner-api-key>' \
  --header 'x-supported-country: <x-supported-country>'
{
  "status": "ok",
  "data": {
    "data": [
      {
        "id": "1054c912-ddd7-4d71-aedd-de1ecf5b6e35",
        "fiatAmount": 5000,
        "cryptoAmount": 50,
        "toAddress": "0x1234567890abcdef",
        "fromAddress": "0x1234567890abcdef",
        "transactionHash": "0x1234567890abcdef",
        "usdcGasUsed": 10200,
        "type": "ON_RAMP",
        "status": "PENDING",
        "createdAt": "2024-04-05 13:45:27.063",
        "user": {
          "firstName": "John",
          "lastName": "Doe",
          "email": "JohnDoe@gmail.com",
          "phoneNumber": "+1234567890",
          "documentNumber": "001-1234567-8",
          "accountNumber": "01234567890",
          "bankName": "<string>",
          "accountType": "SAVINGS"
        },
        "blockchainToken": {
          "contractAddress": "0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174",
          "tokenLogoUrl": "https://s3.amazon/eth-logo.png",
          "blockchainLogoUrl": "https://s3.amazon/eth-logo.png",
          "blockchainName": "Optimism",
          "isChainDefaultToken": true,
          "vmType": "EVM",
          "chainId": 10,
          "order": 1,
          "id": "1054c912-ddd7-4d71-aedd-de1ecf5b6e35",
          "symbol": "eth",
          "name": "ethereum",
          "createdAt": "2024-04-05 13:45:27.063",
          "updatedAt": "2024-04-05 13:45:27.063"
        },
        "fiatCurrency": {
          "id": "12a121ad-cbea-4ec4-9e0a-5c861e528bba",
          "name": "mexican_peso",
          "symbol": "MXN",
          "country": "MX",
          "logoUrl": "https://s3.amazon/eth-logo.png",
          "isActive": true,
          "order": 1
        },
        "partnerRevenue": 250.75,
        "blockExplorerData": {
          "sourceChain": "<string>",
          "destinationChain": "<string>",
          "socketScan": "<string>"
        },
        "cepLink": "https://ceplink.io/tx/0x1234567890abcdef",
        "cancellationReason": "<string>"
      }
    ]
  }
}

Headers

​
partner-api-key
string
required

Api key for the affiliated partner that is performing the request

​
x-supported-country
string
required

Country code of the flow (MX or DO)

Path Parameters

​
userId
string
required

The userId from the user

Query Parameters

​
id
string

Transaction identifier

Example:

"8374f327-38bd-4b0b-b8a7-2524599eb903"

​
userId
string

Identifier for the user that submitted the transaction.

Example:

"8374f327-38bd-4b0b-b8a7-2524599eb903"

​
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,
EXPIRED,
CANCELLED,
IN_PROGRESS,
BANK_TRANSFER_PENDING,
READY_BANK_TRANSFER,
AWAITING_MANUAL_CRYPTO_TRANSFER,
AWAITING_MANUAL_FIAT_TRANSFER,
PENDING_FUNDS,
FUNDS_RECEIVED,
AWAITING_FUND_TRANSFER
Example:

"PENDING"

​
type
enum<string>

Transaction type

Available options:
ON_RAMP,
OFF_RAMP,
CROSS_RAMP
Example:

"ON_RAMP"

​
fiatCurrencyIds
string[]

An array of fiat currency ids

​
partnerId
string

Partner identifier

Example:

"8374f327-38bd-4b0b-b8a7-2524599eb903"

​
skip
number

The number of elements to exclude from the results.

Example:

5

​
limit
number

The maximum amount of results to return.

Example:

5

​
sortBy
string

Supported values:

  • createdAt
Example:

"createdAt"

Response

200 - application/json

Retrieves transactions of the user asociated with the current partner

​
status
string
Example:

"ok"

​
data
object