Get transaction

curl --request GET \
  --url https://api.enterprise.sandbox.uphold.com/core/transactions/{transactionId} \
  --header 'Authorization: Bearer <token>'

{
  "transaction": {
    "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:39Z",
    "createdAt": "2024-07-24T15:22:39Z",
    "updatedAt": "2024-07-24T15:33:08Z"
  }
}

GET

core

transactions

{transactionId}

Get transaction

curl --request GET \
  --url https://api.enterprise.sandbox.uphold.com/core/transactions/{transactionId} \
  --header 'Authorization: Bearer <token>'

{
  "transaction": {
    "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:39Z",
    "createdAt": "2024-07-24T15:22:39Z",
    "updatedAt": "2024-07-24T15:33:08Z"
  }
}

Authorizations

Authorization

string

header

required

OAuth 2.0 authentication.

Path Parameters

transactionId

string<uuid>

required

The transaction id.

Response

Transaction retrieved.

transaction

object

required

Show child attributes

transaction.id

string<uuid>

required

The id of the transaction.

transaction.origin

object

required

The origin of the transaction.

Show child attributes

transaction.origin.asset

string

required

The asset of the endpoint.

transaction.origin.amount

string

required

The amount of the endpoint.

transaction.origin.rate

string

required

The rate of the endpoint against its counter-part (origin to destination and vice-versa).

transaction.origin.node

Account · object

required

The node of the endpoint.

Account
External account
Crypto address

Show child attributes

transaction.origin.node.type

enum<string>

required

The type of the node.

Available options:

account

transaction.origin.node.id

string<uuid>

required

The account id.

transaction.origin.node.ownerId

string<uuid>

required

The id of the user that owns the account.

transaction.destination

object

required

The destination of the transaction.

Show child attributes

transaction.destination.asset

string

required

The asset of the endpoint.

transaction.destination.amount

string

required

The amount of the endpoint.

transaction.destination.rate

string

required

The rate of the endpoint against its counter-part (origin to destination and vice-versa).

transaction.destination.node

Account · object

required

The node of the endpoint.

Account
External account
Crypto address

Show child attributes

transaction.destination.node.type

enum<string>

required

The type of the node.

Available options:

account

transaction.destination.node.id

string<uuid>

required

The account id.

transaction.destination.node.ownerId

string<uuid>

required

The id of the user that owns the account.

transaction.fees

object[]

required

The fees of the transaction.

Show child attributes

transaction.fees.type

enum<string>

required

The type of the fee.

Available options:

deposit,

exchange,

network,

withdrawal

transaction.fees.code

string

required

The code of the fee.

transaction.fees.asset

string

required

The asset in which the fee is denominated.

transaction.fees.amount

string

required

The amount of the fee.

transaction.fees.percentage

string

The percentage of the fee, if the amount was calculated from a percentage.

transaction.status

enum<string>

required

Status of the transaction.

Available options:

processing,

on-hold,

completed,

failed

transaction.quotedAt

string<date-time>

required

The time at which the quote was created.

transaction.createdAt

string<date-time>

required

The time at which the transaction was created.

transaction.updatedAt

string<date-time>

required

The last time at which the transaction was updated.

transaction.denomination

object

The denomination of the transaction.

Show child attributes

transaction.denomination.asset

string

required

The asset in which the transaction is denominated.

transaction.denomination.amount

string

required

The amount of the transaction.

transaction.denomination.rate

string

required

The rate against the specified target (origin or destination).

transaction.denomination.target

enum<string>

required

Whether this exact amount should be paid by the origin or received by the destination.

Available options:

origin,

destination

transaction.statusDetails

object

The details of the status of the transaction.

Show child attributes

transaction.statusDetails.reason

enum<string>

The reason why the transaction failed.

Available options:

amount-limit-exceed,

bank-account-holder-name-mismatch,

card-declined-by-bank,

card-expired,

card-permanently-declined-by-bank,

card-unauthorized,

card-unsupported,

crypto-transaction-screening,

insufficient-funds,

velocity,

unspecified-error

Create transaction Transaction created

⌘I

Core API

Topper API

Widgets API

Get transaction

Authorizations

Path Parameters

Response