Get offramp transactions by ID

curl --request GET \
  --url https://api.developer.coinbase.com/onramp/v1/sell/user/{partnerUserRef}/transactions \
  --header 'Authorization: Bearer <token>'

{
  "next_page_key": "<string>",
  "total_count": 123,
  "transactions": [
    {
      "asset": "<string>",
      "coinbase_fee": {
        "currency": "<string>",
        "value": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "exchange_rate": {
        "currency": "<string>",
        "value": "<string>"
      },
      "from_address": "<string>",
      "minimum_total": {
        "currency": "<string>",
        "value": "<string>"
      },
      "network": "<string>",
      "redirect_url": "<string>",
      "sell_amount": {
        "currency": "<string>",
        "value": "<string>"
      },
      "status": "TRANSACTION_STATUS_CREATED",
      "subtotal": {
        "currency": "<string>",
        "value": "<string>"
      },
      "to_address": "<string>",
      "total": {
        "currency": "<string>",
        "value": "<string>"
      },
      "transaction_id": "<string>",
      "tx_hash": "<string>",
      "unit_price": {
        "currency": "<string>",
        "value": "<string>"
      },
      "updated_at": "2023-11-07T05:31:56Z",
      "payment_method": "UNSPECIFIED"
    }
  ]
}

Onramp/Offramp

Get offramp transactions by ID

When you initialize the Offramp Widget you can pass a partnerUserRef parameter to associate the transaction created during that session with the ID. You can then use that ID in this API to retrieve that transaction and any others that share the ID. The value of the partnerUserRef param can be any string you want e.g. the ID of the user in your app, a unique transaction ID, or a combination of values. Anything that is meaningful to your app.

GET

sell

user

{partnerUserRef}

transactions

Get offramp transactions by ID

curl --request GET \
  --url https://api.developer.coinbase.com/onramp/v1/sell/user/{partnerUserRef}/transactions \
  --header 'Authorization: Bearer <token>'

{
  "next_page_key": "<string>",
  "total_count": 123,
  "transactions": [
    {
      "asset": "<string>",
      "coinbase_fee": {
        "currency": "<string>",
        "value": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "exchange_rate": {
        "currency": "<string>",
        "value": "<string>"
      },
      "from_address": "<string>",
      "minimum_total": {
        "currency": "<string>",
        "value": "<string>"
      },
      "network": "<string>",
      "redirect_url": "<string>",
      "sell_amount": {
        "currency": "<string>",
        "value": "<string>"
      },
      "status": "TRANSACTION_STATUS_CREATED",
      "subtotal": {
        "currency": "<string>",
        "value": "<string>"
      },
      "to_address": "<string>",
      "total": {
        "currency": "<string>",
        "value": "<string>"
      },
      "transaction_id": "<string>",
      "tx_hash": "<string>",
      "unit_price": {
        "currency": "<string>",
        "value": "<string>"
      },
      "updated_at": "2023-11-07T05:31:56Z",
      "payment_method": "UNSPECIFIED"
    }
  ]
}

Authorizations

Authorization

string

header

required

Enter your JSON Web Token (JWT) here. Refer to the Generate JWT section of our Authentication docs for information on how to generate your Bearer Token.

Path Parameters

partnerUserRef

string

required

The partnerUserRef parameter used to initialize the Offramp Widget

Query Parameters

pageKey

string

Page key returned by this API for pagination

pageSize

integer<int64>

The number of transactions to return, between 1 and 1000

Response

Get Offramp Transactions by ID API response

next_page_key

string

The page key to be passed into this API to get the next page of results

total_count

integer<int64>

The number of transactions returned by this call

transactions

object[]

List of transactions matching the partnerUserRef

Show child attributes

transactions.asset

string

Currency symbol e.g. ETH

transactions.coinbase_fee

object

A monetary amount represented by a decimal value and currency symbol

Show child attributes

transactions.coinbase_fee.currency

string

Currency symbol e.g. USD, BTC

transactions.coinbase_fee.value

string

Non-localized amount in decimal notation (e.g. 1.234)

transactions.created_at

string<date-time>

Create at timestamp

transactions.exchange_rate

object

A monetary amount represented by a decimal value and currency symbol

Show child attributes

transactions.exchange_rate.currency

string

Currency symbol e.g. USD, BTC

transactions.exchange_rate.value

string

Non-localized amount in decimal notation (e.g. 1.234)

transactions.from_address

string

Address crypto was received from

transactions.minimum_total

object

A monetary amount represented by a decimal value and currency symbol

Show child attributes

transactions.minimum_total.currency

string

Currency symbol e.g. USD, BTC

transactions.minimum_total.value

string

Non-localized amount in decimal notation (e.g. 1.234)

transactions.network

string

Network name e.g. ethereum

transactions.redirect_url

string

The URL the user was redirected to after confirming their offramp transaction

transactions.sell_amount

object

A monetary amount represented by a decimal value and currency symbol

Show child attributes

transactions.sell_amount.currency

string

Currency symbol e.g. USD, BTC

transactions.sell_amount.value

string

Non-localized amount in decimal notation (e.g. 1.234)

transactions.status

enum<string>

Current status of the transaction

Available options:

TRANSACTION_STATUS_CREATED,

TRANSACTION_STATUS_EXPIRED,

TRANSACTION_STATUS_STARTED,

TRANSACTION_STATUS_SUCCESS,

TRANSACTION_STATUS_FAILED

transactions.subtotal

object

A monetary amount represented by a decimal value and currency symbol

Show child attributes

transactions.subtotal.currency

string

Currency symbol e.g. USD, BTC

transactions.subtotal.value

string

Non-localized amount in decimal notation (e.g. 1.234)

transactions.to_address

string

Address crypto was sent to

transactions.total

object

A monetary amount represented by a decimal value and currency symbol

Show child attributes

transactions.total.currency

string

Currency symbol e.g. USD, BTC

transactions.total.value

string

Non-localized amount in decimal notation (e.g. 1.234)

transactions.transaction_id

string

Unique ID for the transaction

transactions.tx_hash

string

Onchain tx hash of the send

transactions.unit_price

object

A monetary amount represented by a decimal value and currency symbol

Show child attributes

transactions.unit_price.currency

string

Currency symbol e.g. USD, BTC

transactions.unit_price.value

string

Non-localized amount in decimal notation (e.g. 1.234)

transactions.updated_at

string<date-time>

Last update timestamp

transactions.payment_method

enum<string>

The payment method type used to cashout the crypto

Available options:

UNSPECIFIED,

CARD,

ACH_BANK_ACCOUNT,

APPLE_PAY,

FIAT_WALLET,

CRYPTO_ACCOUNT,

GUEST_CHECKOUT_CARD,

PAYPAL,

RTP,

GUEST_CHECKOUT_APPLE_PAY

Get buy options

Get onramp transactions by ID

⌘I

CDP API V1

REST API

JSON-RPC API

Get offramp transactions by ID

Authorizations

Path Parameters

Query Parameters

Response