> ## Documentation Index
> Fetch the complete documentation index at: https://dev.moonpay.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Swap transaction
> Returns a swap transaction by id. Refer to our Recipes section for more detailed examples.
## OpenAPI
````yaml GET /v4/swap/transaction/{transactionId}
openapi: 3.0.0
info:
title: Ramps & Swaps
version: 1.0.0
servers:
- url: https://api.moonpay.com
security: []
tags:
- name: Account details
description: >-
Get your account details, including the verification status and the
current fees.
- name: On-ramp
description: Get quotes and transaction details for buying cryptocurrencies.
- name: Off-ramp
description: Get quotes and transaction details for selling cryptocurrencies.
- name: Swaps
description: Get quotes and transaction details for swapping cryptocurrencies.
- name: Data
description: >-
Get currently supported countries, currencies, and payment methods. Also
check the customers's IP address restrictions.
- name: DefiToken
description: Retrieve token data and token lists for DeFi assets.
paths:
/v4/swap/transaction/{transactionId}:
get:
tags:
- Swaps
summary: Get Swap transaction
description: >-
Returns a swap transaction by id. Refer to our Recipes section for more detailed examples.
operationId: getSwapTransaction
parameters:
- name: authorization
in: header
schema:
type: string
example: Bearer hello.world.token
description: >-
A valid customer authentication token in the format 'Bearer [auth
token]'.
required: true
- name: transactionId
in: path
schema:
type: string
example: bafaf3a5-24b1-4c2f-8d13-da8739722559
description: A valid Swap transaction ID.
required: true
responses:
'200':
description: Successful response — Swap Transaction
content:
application/json:
schema:
$ref: '#/components/schemas/SwapTransaction'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- apiKey: []
components:
schemas:
SwapTransaction:
type: object
properties:
id:
type: string
example: 9020fd02-42ac-497f-8b5f-41fdf4dd0b1d
description: Unique identifier for the object.
createdAt:
type: string
example: '2024-02-23T00:58:26.577Z'
description: >-
Time at which the object was created. Returned as an ISO 8601
string.
updatedAt:
type: string
example: '2024-02-23T00:58:26.577Z'
description: >-
Time at which the object was last updated. Returned as an ISO 8601
string.
baseCurrencyAmount:
type: string
example: '1.123'
description: >-
A positive string number representing how much crypto the user wants
to swap.
quoteCurrencyAmount:
type: string
example: '0.0564'
description: >-
A positive string number representing the amount of cryptocurrency
the customer will receive.
feeAmount:
type: string
example: '0.0002'
description: A positive number representing the fee for the transaction.
quoteCurrency:
$ref: '#/components/schemas/CryptoCurrency'
description: Crypto the customer wants to get.
baseCurrency:
$ref: '#/components/schemas/CryptoCurrency'
description: Crypto currency the customer wants to swap.
customerId:
type: string
example: 3b97352d-a9c2-4786-afe7-e7d74e0a8ad7
description: The identifier of the customer the transaction is associated with.
extraFeeAmount:
type: string
example: '0.0000005'
description: >-
A positive number string representing your extra fee for the
transaction. It is added to baseCurrencyAmount, feeAmount and
networkFeeAmount when the swap is executed.
networkFeeAmount:
type: string
example: '0.00039'
description: >-
A positive number string representing the network fee for the
transaction. It is added to baseCurrencyAmount, feeAmount and
extraFeeAmount when the swap is executed.
status:
type: string
example: completed
description: The transaction's status.
enum:
- completed
- failed
- waitingForDepositAddressGeneration
- waitingForDeposit
- executingSwap
- reQuoteRequired
- screeningWalletAddress
- frozen
depositHash:
type: string
nullable: true
description: >-
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: 8.377408903480862e+76
transactionHash:
type: string
nullable: true
description: >-
The cryptocurrency transaction identifier representing the transfer
from the MoonPay's wallet to the customer's wallet. Set when the
deposit has been executed and sent.
example: 8.377408903480862e+76
refundTransactionHash:
type: string
nullable: true
description: Same for transactionHash but a refund.
example: 8.377408903480862e+76
Error:
type: object
properties:
message:
type: string
description: A descriptive error message.
type:
type: string
description: An error type.
CryptoCurrency:
type: object
properties:
id:
type: string
description: Unique identifier for the currency.
example: aaefa32f-161b-42c8-8115-debcbf3d6a2d
createdAt:
type: string
description: >-
Time at which the object was created. Returned as an ISO 8601
string.
example: '2019-05-17T18:24:45.206Z'
updatedAt:
type: string
description: >-
Time at which the object was last updated. Returned as an ISO 8601
string.
example: '2019-05-17T18:24:45.206Z'
type:
type: string
enum:
- crypto
description: Always `crypto`
example: crypto
name:
type: string
description: The currency's name.
example: USD Coin (ERC-20)
code:
type: string
description: The currency's code.
example: usdc
precision:
type: number
description: The currency's precision (number of digits after decimal point).
example: 2
minBuyAmount:
type: number
nullable: true
description: Represents the minimum amount of cryptocurrency you can buy.
example: 30
maxBuyAmount:
type: number
nullable: true
description: Represents the maximum amount of cryptocurrency you can buy.
example: 1000
minSellAmount:
type: number
nullable: true
description: The minimum amount of cryptocurrency you can sell.
example: 15
maxSellAmount:
type: number
nullable: true
description: The maximum amount of cryptocurrency you can sell.
example: 100000
addressRegex:
type: string
description: >-
A regular expression which you can test against your end user's
wallet addresses.
example: ^(0x)[0-9A-Fa-f]{40}$
testnetAddressRegex:
type: string
description: >-
A regular expression which you can test against your end user's
testnet wallet addresses.
example: ^(0x)[0-9A-Fa-f]{40}$
supportsAddressTag:
type: boolean
description: Whether the currency supports address tags.
example: false
addressTagRegex:
type: string
nullable: true
description: >-
A regular expression which you can test against a wallet address
tag. Defined only if the currency supports address tags.
example: null
supportsTestMode:
type: boolean
description: Whether the currency supports test mode.
example: true
isSuspended:
type: boolean
description: >-
Whether purchases for this currency are suspended. If the currency
is suspended, exchange rates may not be available and it is not
possible to create a transaction with this currency.
example: false
isSupportedInUs:
type: boolean
description: Whether purchases for this currency are supported in the US.
example: true
isSellSupported:
type: boolean
description: Whether sales for this currency are supported.
example: true
notAllowedUSStates:
type: array
items:
type: string
enum:
- AL
- AK
- AZ
- AR
- AS
- CA
- CO
- CT
- DC
- DE
- FL
- GA
- GU
- HI
- ID
- IL
- IN
- IA
- KS
- KY
- LA
- MA
- MD
- ME
- MI
- MN
- MO
- MP
- MS
- MT
- NE
- NH
- NV
- NH
- NJ
- NM
- NY
- NC
- ND
- OH
- OK
- OR
- PA
- PR
- RI
- SC
- SD
- TN
- TX
- TT
- UT
- VT
- VA
- VI
- WA
- WV
- WI
- WY
description: >-
A list with all the US states for this currency that are not
supported.
example:
- LA
- VI
notAllowedCountries:
type: array
items:
type: string
description: >-
A list with all the ISO 3166-1 alpha-2 country codes for this
currency that are not supported.
example:
- CA
metadata:
type: object
description: Additional metadata for the currency.
properties:
contractAddress:
type: string
nullable: true
description: >-
Unique contract address where the token smart contract is
hosted.
example: 0
chainId:
type: string
nullable: true
description: ID used to identify different EVM compatible chains.
example: '1'
networkCode:
type: string
description: Name of the cryptocurrency
example: ethereum
securitySchemes:
apiKey:
type: apiKey
name: apiKey
in: query
````