Get Sell transaction by External identifier

Retrieve a transaction by its externalTransactionId. This is the identifier you assigned the transaction when creating it. This endpoint returns an array of objects because we cannot ensure the uniqueness of externalTransactionId.

GET /v3/sell_transactions/ext/{externalTransactionId}

Get Sell transaction by External identifier

cURL

curl --request GET \
  --url 'https://api.moonpay.com/v3/sell_transactions/ext/{externalTransactionId}?apiKey='

200

{
  "id": "9020fd02-42ac-497f-8b5f-41fdf4dd0b1d",
  "createdAt": "2024-02-23T00:58:26.577Z",
  "updatedAt": "2024-02-23T00:58:26.577Z",
  "quoteExpiresAt": "2024-02-23T01:28:26.577Z",
  "baseCurrencyAmount": 0.575,
  "quoteCurrencyAmount": 1521.11,
  "feeAmount": 15.36,
  "extraFeeAmount": 0,
  "status": "completed",
  "failureReason": null,
  "refundWalletAddress": "",
  "depositHash": "0x0e13c1c9d8b542a1888e63e6d5871a2199893a0f2851c9353120b7e18fce1802",
  "widgetRedirectUrl": null,
  "payoutMethod": "credit_debit_card",
  "eurRate": 1,
  "usdRate": 1.08193,
  "gbpRate": 0.85501,
  "quoteCurrencyId": "71435a8d-211c-4664-a59e-2a5361a6c5a7",
  "quoteCurrency": {
    "id": "6f424585-8936-4eb1-b01e-443fb306d1f5",
    "createdAt": "2019-05-17T18:24:45.206Z",
    "updatedAt": "2019-05-17T18:24:45.206Z",
    "type": "fiat",
    "name": "Pound Sterling",
    "code": "gbp",
    "precision": 2,
    "minBuyAmount": 30,
    "maxBuyAmount": 9000,
    "isSellSupported": true
  },
  "baseCurrencyId": "8d305f63-1fd7-4e01-a220-8445e591aec4",
  "baseCurrency": {
    "id": "aaefa32f-161b-42c8-8115-debcbf3d6a2d",
    "createdAt": "2019-05-17T18:24:45.206Z",
    "updatedAt": "2019-05-17T18:24:45.206Z",
    "type": "crypto",
    "name": "USD Coin (ERC-20)",
    "code": "usdc",
    "precision": 2,
    "minBuyAmount": 30,
    "maxBuyAmount": 1000,
    "minSellAmount": 15,
    "maxSellAmount": 100000,
    "addressRegex": "^(0x)[0-9A-Fa-f]{40}$",
    "testnetAddressRegex": "^(0x)[0-9A-Fa-f]{40}$",
    "supportsAddressTag": false,
    "addressTagRegex": null,
    "supportsTestMode": true,
    "isSuspended": false,
    "isSupportedInUs": true,
    "isSellSupported": true,
    "notAllowedUSStates": [
      "LA",
      "VI"
    ],
    "notAllowedCountries": [
      "CA"
    ],
    "metadata": {
      "contractAddress": "0x0000000000000000000000000000000000000000",
      "chainId": "1",
      "networkCode": "ethereum"
    }
  },
  "customerId": "3b97352d-a9c2-4786-afe7-e7d74e0a8ad7",
  "bankAccountId": "ee0e649f-a072-4cdb-96ce-a1ea393eac1e",
  "externalCustomerId": null,
  "externalTransactionId": null,
  "stages": [
    {
      "stage": "sell_stage_one_verification",
      "status": "success",
      "failureReason": null,
      "actions": [
        {
          "type": "complete_deposit",
          "url": "<string>"
        }
      ]
    }
  ]
}

Authorizations

apiKey · string · query · required

Your publishable API key, passed as the apiKey query parameter. Publishable keys are prefixed with pk_test_ (sandbox) or pk_live_ (production) and are safe to use in client-side code. Find your keys on the API keys page of the dashboard. See Authentication.

Path Parameters

externalTransactionId · string · required

An identifier associated with the transaction, provided by you.

Response

200

application/json

Successful response. Sell Transaction

id · string

Unique identifier for the object.

Example:

"9020fd02-42ac-497f-8b5f-41fdf4dd0b1d"

createdAt · string

Time at which the object was created. Returned as an ISO 8601 string.

Example:

"2024-02-23T00:58:26.577Z"

updatedAt · string

Time at which the object was last updated. Returned as an ISO 8601 string.

Example:

"2024-02-23T00:58:26.577Z"

quoteExpiresAt · string | null

Time at which the sell quote expires. Returned as an ISO 8601 string.

Example:

"2024-02-23T01:28:26.577Z"

baseCurrencyAmount · number

A positive number representing how much the customer wants to sell.

Example:

0.575

quoteCurrencyAmount · number

A positive number representing the amount of cryptocurrency the customer will receive. Set when the purchase of cryptocurrency has been executed.

Example:

1521.11

feeAmount · number

A positive number representing the fee for the transaction.

Example:

15.36

extraFeeAmount · number

A positive number representing your extra fee for the transaction.

Example:

0

status · enum<string>

The transaction's status.

Available options: waitingForDeposit, pending, failed, completed

Example:

"completed"

failureReason · string | null

The transaction's failure reason. Set when transaction's status is failed.

Example:

null

refundWalletAddress · string

A wallet address at which the customer can receive cryptocurrency. In case we cannot process the sale of the customer's cryptocurrency, we will return the cryptocurrency to this wallet address. Might be empty

Example:

""

depositHash · string | null

The cryptocurrency transaction identifier representing the transfer from the customer's wallet to MoonPay's wallet. Set when the deposit has been executed and received.

Example:

"0x0e13c1c9d8b542a1888e63e6d5871a2199893a0f2851c9353120b7e18fce1802"

widgetRedirectUrl · string | null

An optional URL used in a widget implementation. It is passed to us by you in the query parameters, and we include it as a link on the transaction tracker page.

Example:

null

payoutMethod · enum<string>

The transaction's payout method.

Available options: ach_bank_transfer, credit_debit_card, paypal, gbp_bank_transfer, sepa_bank_transfer

Example:

"credit_debit_card"

eurRate · number

The exchange rate between the transaction's base currency and Euro at the time of the transaction.

Example:

1

usdRate · number

The exchange rate between the transaction's base currency and US Dollar at the time of the transaction.

Example:

1.08193

gbpRate · number

The exchange rate between the transaction's base currency and British Pound at the time of the transaction.

Example:

0.85501

quoteCurrencyId · string

The identifier of the fiat the customer wants to get.

Example:

"71435a8d-211c-4664-a59e-2a5361a6c5a7"

quoteCurrency · object

Show child attributes

baseCurrencyId · string

The identifier of the crypto currency the customer wants to sell.

Example:

"8d305f63-1fd7-4e01-a220-8445e591aec4"

baseCurrency · object

Show child attributes

customerId · string

The identifier of the customer the transaction is associated with.

Example:

"3b97352d-a9c2-4786-afe7-e7d74e0a8ad7"

bankAccountId · string | null

The identifier of the bank account used for this transaction.

Example:

"ee0e649f-a072-4cdb-96ce-a1ea393eac1e"

externalCustomerId · string | null

An identifier associated with the customer, provided by you.

Example:

null

externalTransactionId · string | null

An identifier associated with the transaction, provided by you.

Example:

null

stages · object[]

An array of four objects, each representing one of the four stages of the purchase process

Show child attributes