> ## Documentation Index
> Fetch the complete documentation index at: https://developer.uphold.com/llms.txt
> Use this file to discover all available pages before exploring further.
# List transactions
> List transactions associated with a user.
export const RestEndpointSubjects = ({subjects = []}) => {
const subjectToIconMap = {
'client': 'browser',
'user:individual': 'user',
'user:business': 'briefcase'
};
if (subjects.length === 0) {
return null;
}
return <>
{subjects.map(subject =>
{subject}
)}
;
};
## OpenAPI
````yaml _media/specs/core-openapi.mintlify.json get /core/transactions
openapi: 3.1.0
info:
version: 0.1.0
title: Core API
description: >-
The Core API provides essential building blocks that empower businesses to
embed financial services into their applications.
contact:
name: Uphold API Team
email: developers@uphold.com
url: https://developer.uphold.com
servers:
- url: https://api.enterprise.sandbox.uphold.com
description: Sandbox
- url: https://api.enterprise.uphold.com
description: Production
security:
- OAuth2: []
tags:
- name: Authentication
description: Authentication.
- name: Countries
description: Countries.
- name: Users
description: Users.
- name: KYC
description: Individual User's KYC.
- name: KYB
description: Business User's KYB.
- name: Capabilities
description: User capabilities.
- name: Terms of service
description: User terms of service.
- name: Files
description: Files.
- name: Assets
description: Assets, networks and rails.
- name: Accounts
description: Accounts.
- name: External accounts
description: External accounts.
- name: Transactions
description: Transactions.
- name: Portfolio
description: Portfolio.
- name: Statements
description: Statements.
- name: Metadata
description: Metadata.
- name: Webhooks
description: Webhooks.
paths:
/core/transactions:
get:
tags:
- Transactions
summary: List transactions
description: List transactions associated with a user.
operationId: core.list-transactions
parameters:
- $ref: '#/components/parameters/pagination-per-page'
responses:
'200':
$ref: '#/components/responses/list-transactions-response'
security:
- OAuth2:
- core.transactions:read
components:
parameters:
pagination-per-page:
name: perPage
description: The number of items per page.
in: query
schema:
type: integer
format: int32
minimum: 1
maximum: 100
default: 10
examples:
10 Items Per Page:
value: 10
responses:
list-transactions-response:
description: Transactions retrieved.
content:
application/json:
schema:
type: object
properties:
transactions:
type: array
items:
$ref: '#/components/schemas/transaction'
pagination:
$ref: '#/components/schemas/pagination'
required:
- transactions
- pagination
examples:
Transactions Retrieved:
value:
transactions:
- id: 623000c8-9bdf-4a2b-aa3d-6a6b44a7f6a0
origin:
amount: '100.00'
asset: GBP
rate: '47619.04761904762'
node:
type: account
id: b98e4f0d-a67d-4126-a99d-666f7e0315d9
ownerId: e4ce04dc-67b7-4e9f-af91-482cb6f9fc4a
destination:
amount: '0.0021'
asset: BTC
rate: '0.000021'
node:
type: account
id: 555a99a1-620d-4431-a0ac-b43e1aad2bdc
ownerId: e4ce04dc-67b7-4e9f-af91-482cb6f9fc4a
denomination:
amount: '100.00'
asset: GBP
target: origin
rate: '1'
fees: []
status: completed
quotedAt: '2024-07-24T15:02:39.000Z'
createdAt: '2024-07-24T15:22:39.000Z'
updatedAt: '2024-07-24T15:33:08.000Z'
pagination:
first: >-
https://api.enterprise.uphold.com/core/transactions?page=1&perPage=1
next: >-
https://api.enterprise.uphold.com/core/transactions?page=2&perPage=1
headers:
x-uphold-request-id:
description: >-
A unique identifier for the request that can be shared with Uphold
for troubleshooting purposes.
required: true
schema:
type: string
format: uuid
examples:
Request ID:
value: 9092ee4d-f0fb-42e9-8787-b668dbcec531
schemas:
transaction:
type: object
properties:
id:
description: The id of the transaction.
type: string
format: uuid
origin:
$ref: '#/components/schemas/transaction-origin-endpoint'
description: The origin of the transaction.
destination:
$ref: '#/components/schemas/transaction-destination-endpoint'
description: The destination of the transaction.
denomination:
$ref: '#/components/schemas/transaction-denomination'
description: The denomination of the transaction.
fees:
$ref: '#/components/schemas/transaction-fees'
description: The fees of the transaction.
status:
description: Status of the transaction.
type: string
enum:
- processing
- on-hold
- completed
- failed
statusDetails:
description: The details of the status of the transaction.
type: object
properties:
reason:
$ref: '#/components/schemas/transaction-status-reason'
quotedAt:
description: The time at which the quote was created.
type: string
format: date-time
createdAt:
description: The time at which the transaction was created.
type: string
format: date-time
updatedAt:
description: The last time at which the transaction was updated.
type: string
format: date-time
completedAt:
description: The date and time the transaction was completed.
type: string
format: date-time
required:
- id
- origin
- destination
- fees
- status
- createdAt
- updatedAt
- quotedAt
pagination:
description: The pagination information.
type: object
properties:
first:
description: The URL to the first set of results.
type: string
format: uri
prev:
description: The URL to the previous set of results.
type: string
format: uri
next:
description: The URL to the next set of results.
type: string
format: uri
transaction-origin-endpoint:
type: object
properties:
asset:
description: The asset of the endpoint.
type: string
amount:
description: The amount of the endpoint.
type: string
rate:
description: >-
The rate of the endpoint against its counter-part (origin to
destination and vice-versa).
type: string
node:
$ref: '#/components/schemas/transaction-origin-node'
description: The node of the endpoint.
required:
- asset
- amount
- rate
- node
transaction-destination-endpoint:
type: object
properties:
asset:
description: The asset of the endpoint.
type: string
amount:
description: The amount of the endpoint.
type: string
rate:
description: >-
The rate of the endpoint against its counter-part (origin to
destination and vice-versa).
type: string
node:
$ref: '#/components/schemas/transaction-destination-node'
description: The node of the endpoint.
required:
- asset
- amount
- rate
- node
transaction-denomination:
type: object
properties:
asset:
description: The asset in which the transaction is denominated.
type: string
amount:
description: The amount of the transaction.
type: string
rate:
description: The rate against the specified target (origin or destination).
type: string
target:
description: >-
Whether this exact amount should be paid by the origin or received
by the destination.
type: string
enum:
- origin
- destination
required:
- asset
- amount
- rate
- target
transaction-fees:
type: array
items:
type: object
properties:
type:
description: The type of the fee.
type: string
enum:
- deposit
- exchange
- network
- withdrawal
code:
description: The code of the fee.
type: string
asset:
description: The asset in which the fee is denominated.
type: string
amount:
description: The amount of the fee.
type: string
percentage:
description: >-
The percentage of the fee, if the amount was calculated from a
percentage.
type: string
required:
- type
- code
- asset
- amount
transaction-status-reason:
description: The reason why the transaction failed.
type: string
enum:
- apm-account-holder-data-mismatch
- apm-authorization-failed
- apm-missing-account-holder-data
- apm-payment-method-declined
- bank-account-holder-name-mismatch
- beneficiary-country-restricted
- card-declined-by-bank
- card-expired
- card-permanently-declined-by-bank
- card-unauthorized
- card-unsupported
- insufficient-funds
- pending-requests-for-information
- provider-maximum-limit-exceeded
- screening-verification-failed
- travel-rule-verification-failed
- unspecified-error
- velocity
transaction-origin-node:
type: object
discriminator:
propertyName: type
mapping:
account:
$ref: '#/components/schemas/transaction-node-account'
external-account:
$ref: '#/components/schemas/transaction-node-external-account'
bank-address:
$ref: '#/components/schemas/transaction-node-bank-address'
apm:
$ref: '#/components/schemas/transaction-node-apm'
crypto-address:
$ref: '#/components/schemas/transaction-node-crypto-address'
oneOf:
- $ref: '#/components/schemas/transaction-node-account'
title: Account
- $ref: '#/components/schemas/transaction-node-external-account'
title: External account
- $ref: '#/components/schemas/transaction-node-bank-address'
title: Bank address
- $ref: '#/components/schemas/transaction-node-apm'
title: Alternative payment method
- $ref: '#/components/schemas/transaction-node-crypto-address'
title: Crypto address
transaction-destination-node:
type: object
discriminator:
propertyName: type
mapping:
account:
$ref: '#/components/schemas/transaction-node-account'
external-account:
$ref: '#/components/schemas/transaction-node-external-account'
bank-address:
$ref: '#/components/schemas/transaction-node-bank-address'
apm:
$ref: '#/components/schemas/transaction-node-apm'
crypto-address:
$ref: '#/components/schemas/transaction-node-crypto-address'
oneOf:
- $ref: '#/components/schemas/transaction-node-account'
title: Account
- $ref: '#/components/schemas/transaction-node-external-account'
title: External account
- $ref: '#/components/schemas/transaction-node-bank-address'
title: Bank address
- $ref: '#/components/schemas/transaction-node-apm'
title: Alternative payment method
- $ref: '#/components/schemas/transaction-node-crypto-address'
title: Crypto address
transaction-node-account:
type: object
properties:
type:
description: The type of the node.
type: string
enum:
- account
id:
description: The account id.
type: string
format: uuid
ownerId:
description: The id of the user that owns the account.
type: string
format: uuid
required:
- type
- id
- ownerId
transaction-node-external-account:
type: object
properties:
type:
description: The type of the node.
type: string
enum:
- external-account
id:
description: The external account id.
type: string
format: uuid
confirmationUrl:
description: >-
The URL to confirm the authorization using the external account
(e.g., 3DS).
type: string
format: uri
ownerId:
description: The id of the user that owns the external account.
type: string
format: uuid
network:
description: The network used for the transaction with the external account.
type: string
required:
- type
- id
- ownerId
transaction-node-bank-address:
type: object
properties:
type:
description: The type of the node.
type: string
enum:
- bank-address
network:
description: The network of the bank transfer.
type: string
required:
- type
- network
transaction-node-apm:
type: object
properties:
type:
description: The type of the node.
type: string
enum:
- apm
method:
description: The alternative payment method to be used in the operation.
enum:
- paypal
- venmo
required:
- type
- method
transaction-node-crypto-address:
type: object
properties:
type:
description: The type of the node.
type: string
enum:
- crypto-address
network:
$ref: '#/components/schemas/string-no-edge-spaces'
description: The network that the crypto address is on.
address:
$ref: '#/components/schemas/string-no-edge-spaces'
description: The crypto address (may not be available for deposits).
reference:
description: >-
The additional identifier (e.g., destination tag, memo, or message)
for the crypto address.
type: string
execution:
$ref: '#/components/schemas/transaction-node-crypto-address-execution'
description: The execution details for the transaction.
required:
- type
- network
string-no-edge-spaces:
type: string
pattern: ^\S.*\S$|^\S$
transaction-node-crypto-address-execution:
type: object
discriminator:
propertyName: mode
mapping:
onchain:
$ref: >-
#/components/schemas/transaction-node-crypto-address-execution-onchain
offchain:
$ref: >-
#/components/schemas/transaction-node-crypto-address-execution-offchain
simulated:
$ref: >-
#/components/schemas/transaction-node-crypto-address-execution-simulated
oneOf:
- $ref: >-
#/components/schemas/transaction-node-crypto-address-execution-onchain
title: On-chain
- $ref: >-
#/components/schemas/transaction-node-crypto-address-execution-offchain
title: Off-chain
- $ref: >-
#/components/schemas/transaction-node-crypto-address-execution-simulated
title: Simulated
transaction-node-crypto-address-execution-onchain:
type: object
properties:
mode:
description: The mode of execution.
type: string
enum:
- onchain
transactionHash:
$ref: '#/components/schemas/string-no-edge-spaces'
description: The hash of the transaction in the blockchain.
required:
- mode
transaction-node-crypto-address-execution-offchain:
type: object
properties:
mode:
description: The mode of execution.
type: string
enum:
- offchain
accountId:
description: The account id to which the off-chain transaction was made.
type: string
format: uuid
accountOwnerId:
description: >-
The id of the user that owns the account to which the off-chain
transaction was made.
type: string
format: uuid
required:
- mode
transaction-node-crypto-address-execution-simulated:
type: object
properties:
mode:
description: The mode of execution.
type: string
enum:
- simulated
transactionHash:
$ref: '#/components/schemas/string-no-edge-spaces'
description: The simulated transaction hash.
required:
- mode
securitySchemes:
OAuth2:
type: oauth2
description: OAuth 2.0 authentication.
flows:
clientCredentials:
tokenUrl: /core/oauth2/token
scopes:
core.users:act-on-behalf-of: Grants access to act on behalf of a user
core.users:create: Grants access to create users
core.users:read: Grants access to view users
core.users:delete: Grants access to delete users
core.users.metadata:read: Grants access to view user metadata
core.users.metadata:write: Grants access to modify user metadata
core.kyc:read: Grants access to view KYC processes
core.kyc.profile:update: Grants access to update profile KYC process
core.kyc.address:update: Grants access to update address KYC process
core.kyc.email:update: Grants access to update email KYC process
core.kyc.phone:update: Grants access to update phone KYC process
core.kyc.identity:update: Grants access to update identity KYC process
core.kyc.proof-of-address:update: Grants access to update proof-of-address KYC process
core.kyc.customer-due-diligence:update: Grants access to update customer due diligence KYC process
core.kyc.enhanced-due-diligence:update: Grants access to update enhanced due diligence KYC process
core.kyc.crypto-risk-assessment:update: Grants access to update crypto risk assessment KYC process
core.kyc.self-categorization-statement:update: Grants access to update self-categorization statement KYC process
core.kyc.tax-details:update: Grants access to update tax details KYC process
core.capabilities:read: Grants access to view user capabilities
core.terms-of-service:read: Grants access to view terms of service
core.terms-of-service:accept: Grants access to accept terms of service
core.files:create: Grants access to create files
core.files:read: Grants access to view files
core.files.metadata:read: Grants access to view files metadata
core.files.metadata:write: Grants access to modify files metadata
core.accounts:create: Grants access to create accounts
core.accounts:read: Grants access to view accounts
core.accounts:update: Grants access to update accounts
core.accounts:archive: Grants access to archive accounts
core.accounts:deposit-method: >-
Grants access to deposit method needed for depositing into
accounts
core.accounts:use-test-helpers: Grants access to test helpers of accounts
core.accounts.metadata:read: Grants access to view accounts metadata
core.accounts.metadata:write: Grants access to modify accounts metadata
core.assets:use-test-helpers: Grants access to test helpers of assets
core.external-accounts:create: Grants access to create external accounts
core.external-accounts:read: Grants access to view external accounts
core.external-accounts:update: Grants access to update external accounts
core.external-accounts:delete: Grants access to delete external accounts
core.external-accounts.metadata:read: Grants access to view external accounts metadata
core.external-accounts.metadata:write: Grants access to modify external accounts metadata
core.transactions:create: Grants access to commit quotes
core.transactions:read: Grants access to view transactions
core.transactions.metadata:read: Grants access to view transactions metadata
core.transactions.metadata:write: Grants access to modify transactions metadata
core.transactions.requests-for-information:read: Grants access to view transactions requests for information
core.transactions.requests-for-information:update: Grants access to update transactions requests for information
core.portfolio:read: >-
Grants access to view portfolio overview, performance, and
historical balance
core.statements:read: Grants access to read statements
core.webhooks:management-link: Grants access to create webhook management links
````