Documentation Index
Fetch the complete documentation index at: https://docs.pipevest.com/llms.txt
Use this file to discover all available pages before exploring further.
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
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' \
Transaction by Id
curl --request GET \
--url https://api.pipevest.com/v1/transactions/123456\
...
Entity Reference
| Property | Definition |
|---|
transactionId | Unique transaction identifier |
assetId | Unique asset identifier |
amount | The amount for the transaction |
currency | Associated currency |
requestType | The type of request being made |
status | The status for the transaction |
createdAt | Created at unix timestamp |
updatedAt | Updated at unix timestamp |
Status
| Name | Definition |
|---|
PENDING | The transaction is currently in progress |
COMPLETED | The transaction has completed processing |
CANCELED | The transaction was cancelled |
ERROR | The transaction ended in an error |
Request Type
| Name | Definition |
|---|
PURCHASE | The transaction request was of the purchase type |
SELL | The transaction request was of the sell type |
Webhook Subscriptions
| Subscription | Definition | Domain |
|---|
TRANSACTION | Only events that deal with transactions | Transactions |
