Transactions represent the movement of money for each Request. This document will guide you on how to get transaction details.

Retrieving Transactions

When requesting transaction types details you can do so either by getting:

  • A list of transaction types
  • An transaction by a given Id

List of Transactions

Make a GET request to /transactions.

  curl --request GET \
    --url https://api.pipevest.com/v1/transactions?customerId=123456\
    --header 'Authorization: Bearer 123456' \
    --header 'Signature: sig1=:OTEyMjY4...A5NTNDMEQ=:' \
    --header 'Signature-Input: sig1=("Authorization" "Content-Digest" "Content-Length" "Content-Type" "X-Client-Id" "X-Idempotency-Key" "@method" "@target-uri" "@path" "@query");keyid="staging-pipevest-ed25519";created=1732893484;expires=1732893584' \
    --header 'X-Client-Id: 123456' \
This endpoint can be paginated and sorted.

Transaction by Id

Make a GET request to /transactions/{transactionId}

  curl --request GET \
    --url https://api.pipevest.com/v1/transactions/123456\
    ...

Entity Reference

PropertyDefinition
transactionIdUnique transaction identifier
assetIdUnique asset identifier
amountThe amount for the transaction
currencyAssociated currency
requestTypeThe type of request being made
statusThe status for the transaction
createdAtCreated at unix timestamp
updatedAtUpdated at unix timestamp

Status

NameDefinition
PENDINGThe transaction is currently in progress
COMPLETEDThe transaction has completed processing
CANCELEDThe transaction was cancelled
ERRORThe transaction ended in an error

Request Type

NameDefinition
PURCHASEThe transaction request was of the purchase type
SELLThe transaction request was of the sell type

Webhook Subscriptions

SubscriptionDefinitionDomain
TRANSACTIONOnly events that deal with transactionsTransactions