Get Buy 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 /v1/transactions/ext/{externalTransactionId}

Get Buy transaction by External identifier

cURL

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

200

{
  "id": "defb7c52-7bd3-422b-9052-374df50cc51a",
  "createdAt": "2024-02-17T18:24:45.206Z",
  "updatedAt": "2024-02-17T18:24:45.206Z",
  "quoteExpiresAt": "2024-02-17T18:54:45.206Z",
  "baseCurrencyAmount": 45.5,
  "quoteCurrencyAmount": 0.0154,
  "feeAmount": 1.7,
  "extraFeeAmount": 0.43,
  "paymentMethod": "credit_debit_card",
  "networkFeeAmount": 2.37,
  "areFeesIncluded": true,
  "status": "completed",
  "failureReason": null,
  "walletAddress": "0xc216eD2D6c295579718dbd4a797845CdA70B3C36",
  "walletAddressTag": null,
  "cryptoTransactionId": "0x6751c8fce2e0fb5d57bb4801b31b35a7160fa362e0c5703d44cfd508317ee2f8",
  "redirectUrl": "https://api.moonpay.com/secure/url?transactionId=defb7c52-7bd3-422b-9052-374df50cc51a",
  "returnUrl": "https://buy.moonpay.com/transaction_receipt?transactionId=defb7c52-7bd3-422b-9052-374df50cc51a",
  "widgetRedirectUrl": null,
  "eurRate": 0.92432,
  "usdRate": 1,
  "gbpRate": 0.79016,
  "currencyId": "8d305f63-1fd7-4e01-a220-8445e591aec4",
  "currency": {
    "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"
    }
  },
  "baseCurrencyId": "edd81f1f-f735-4692-b410-6def107f17d2",
  "baseCurrency": {
    "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
  },
  "customerId": "77cc1309-0058-4177-b170-8e9657fe12eb",
  "cardId": "0a7e23d8-6a52-44c7-b189-91b37bd13796",
  "bankAccountId": null,
  "externalCustomerId": "<string>",
  "externalTransactionId": "<string>",
  "country": "GBR",
  "state": null,
  "stages": [
    {
      "stage": "stage_one_ordering",
      "status": "success",
      "failureReason": null,
      "actions": []
    }
  ]
}

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. Buy Transaction

id · string

Unique identifier for the transaction.

Example:

"defb7c52-7bd3-422b-9052-374df50cc51a"

createdAt · string

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

Example:

"2024-02-17T18:24:45.206Z"

updatedAt · string

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

Example:

"2024-02-17T18:24:45.206Z"

quoteExpiresAt · string | null

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

Example:

"2024-02-17T18:54:45.206Z"

baseCurrencyAmount · number

A positive number representing how much the customer wants to spend. The minimum amount is 20.

Example:

45.5

quoteCurrencyAmount · number

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

Example:

0.0154

feeAmount · number

A positive number representing the fee for the transaction. It is added to baseCurrencyAmount, extraFeeAmount and networkFeeAmount when the customer's card is charged.

Example:

1.7

extraFeeAmount · number

A positive number representing your extra fee for the transaction. It is added to baseCurrencyAmount and feeAmount when the customer's card is charged.

Example:

0.43

paymentMethod · enum<string>

The transaction's payment method.

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

Example:

"credit_debit_card"

networkFeeAmount · number

A positive number representing the network fee for the transaction. It is added to baseCurrencyAmount, feeAmount and extraFeeAmount when the customer's card is charged.

Example:

2.37

areFeesIncluded · boolean

A boolean indicating whether baseCurrencyAmount includes or excludes the feeAmount, extraFeeAmount and networkFeeAmount.

Example:

true

status · enum<string>

The transaction's status. Possible values are waitingPayment (pending bank transfers where MoonPay is not in receipt), pending (transaction is in progress), waitingAuthorization (waiting for card approval, i.e. 3DS, bank side security), failed or completed.

Available options: waitingPayment, pending, waitingAuthorization, failed, completed

Example:

"completed"

failureReason · string | null

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

Example:

null

walletAddress · string

The cryptocurrency wallet address the purchased funds will be sent to.

Example:

"0xc216eD2D6c295579718dbd4a797845CdA70B3C36"

walletAddressTag · string | null

The secondary cryptocurrency wallet address identifier for coins such as EOS, XRP and XMR.

Example:

null

cryptoTransactionId · string | null

The cryptocurrency transaction identifier representing the transfer to the customer's wallet. Set when the withdrawal has been executed.

Example:

"0x6751c8fce2e0fb5d57bb4801b31b35a7160fa362e0c5703d44cfd508317ee2f8"

redirectUrl · string | null

The URL provided to you, when required, to which to redirect the customer as part of a redirect authentication flow.

Example:

"https://api.moonpay.com/secure/url?transactionId=defb7c52-7bd3-422b-9052-374df50cc51a"

returnUrl · string

The URL the customer is returned to after they authenticate or cancel their payment on the payment method's app or site. If you are using our widget implementation, this is always our transaction tracker page, which provides the customer with real-time information about their transaction.

Example:

"https://buy.moonpay.com/transaction_receipt?transactionId=defb7c52-7bd3-422b-9052-374df50cc51a"

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

eurRate · number

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

Example:

0.92432

usdRate · number

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

Example:

1

gbpRate · number

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

Example:

0.79016

currencyId · string

The identifier of the cryptocurrency the customer wants to purchase.

Example:

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

currency · object

Show child attributes

baseCurrencyId · string

The identifier of the fiat currency the customer wants to use for the transaction.

Example:

"edd81f1f-f735-4692-b410-6def107f17d2"

baseCurrency · object

Show child attributes

customerId · string

The identifier of the customer the transaction is associated with.

Example:

"77cc1309-0058-4177-b170-8e9657fe12eb"

cardId · string | null

For token or card transactions, the identifier of the payment card used for this transaction.

Example:

"0a7e23d8-6a52-44c7-b189-91b37bd13796"

bankAccountId · string | null

For bank transfer transactions, the identifier of the bank account used for this transaction.

Example:

null

externalCustomerId · string | null

An identifier associated with the customer, provided by you.

externalTransactionId · string | null

An identifier associated with the transaction, provided by you.

country · string

The customer's country. Returned as an ISO 3166-1 alpha-3 code.

Example:

"GBR"

state · string | null

The customer's state, if the customer is from the USA. Returned as a two-letter code.

Example:

null

stages · object[]

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

Show child attributes