Search for transfers
Find transfers by specified conditions. Conditions are passed as query parameters and can be combined or omitted. For example:
-
Find all transfers created in September 2024:
/v1/transfers/search?created_at=gte:2024-09-01T00:00:00Z&created_at=lt:2024-10-01T00:00:00Z
-
Find all transfers with a given
external_id
:/v1/transfers/search?external_id=custom_id_001
Note: external_id
is only available for transfers created using the Standalone integration.
curl --request GET \
--url https://api.sandbox.meso.network/v1/transfers/search \
--header 'Authorization: Basic <encoded-value>'
{
"results": [
{
"id": "t_001",
"external_id": "custom_id_001",
"kind": "cash_in",
"status": "executing",
"network_transaction_id": "37tQVLSyCY1X6iSFzrDwThnBuUWNbp84vby5BiKqUxC1VSN4XFyLGkNq843UFMZ27kXPzx4xnR8RExZPmDAsNJf4",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"source_total": {
"amount": "1.45",
"currency_code": "solana/SOL"
},
"source_total_usd": {
"amount": "1.45",
"currency_code": "solana/SOL"
},
"source_subtotal": {
"amount": "1.45",
"currency_code": "solana/SOL"
},
"source_subtotal_usd": {
"amount": "1.45",
"currency_code": "solana/SOL"
},
"destination_total": {
"amount": "1.45",
"currency_code": "solana/SOL"
},
"destination_total_usd": {
"amount": "1.45",
"currency_code": "solana/SOL"
},
"wallet_address": "3n2C45yBiNapKh6EdDekesZccAFdwTatu46Eyw1UnKx2",
"payment_method": "debit",
"meso_fee": {
"amount": "1.45",
"currency_code": "solana/SOL"
},
"meso_fee_usd": {
"amount": "1.45",
"currency_code": "solana/SOL"
},
"network_fee": {
"amount": "1.45",
"currency_code": "solana/SOL"
},
"network_fee_usd": {
"amount": "1.45",
"currency_code": "solana/SOL"
}
}
],
"page_info": {
"end_cursor": "<string>",
"has_next_page": true
}
}
Authorizations
Use partnerId
and secretKey
as the username and password respectively.
The client must send these credentials in the Authorization header, encoded in Base64.
The format for the header is Authorization: Basic {credentials}
, where "credentials" is
the Base64 encoding of "partnerId:secretKey"
.
Query Parameters
An external identifier that was provided at transfer time.
A filter which limits the results based on the created_at
time of the transfer. This value should be provided with in a format of operator:timestamp
.
Available operators:
gt
: Returns any values greater than the provided valuegte
: Returns any values greater than or equal to the provided valuelt
: Returns any values less than the provided valuegte
: Returns any values less than or equal to the provided value
The timestamp is a RFC 3339 timestamp.
This filter can be passed multiple times with different operators to create ranges:
created_at=gte:2024-09-01T00:00:00Z&created_at=lt:2024-10-01T00:00:00Z
The maximum number of results that will be returned.
1 <= x <= 20
The value to use for the the next page of results. Typically, this is the end_cursor
from the previous result set.
Response
The unique Meso identifier for the transfer.
A value representing whether the transfer was for cash in (on-ramping from fiat to crypto) or cash out (off-ramping from crypto to fiat).
Currently, only cash_in
is supported.
cash_in
, cash_out
The status of the transfer.
executing
, approved
, declined
, complete
An RFC 3339 timestamp representing when the transfer was created.
Example: 2017-07-21T17:32:28Z
See Open API data types for more.
An RFC 3339 timestamp representing when the transfer was last updated.
Example: 2017-07-21T17:32:28Z
See Open API data types for more.
Details of the overall total amount (of crypto or fiat depending on the kind
) used to fund the transfer including fees.
A stringified number representing a crypto or fiat currency amount. This value may include minor units, the value of which will change depending on the currency.
Examples: 25
, 0.12
, 0.246810
, 5000.00
The currency code for the given value.
Fiat currencies:
fiat/USD
fiat/EUR
Crypto:
Crypto values are expressed as <chain>/<symbol>
.
bitcoin/BTC
ethereum/ETH
ethereum/USDC
solana/SOL
solana/USDC
arbitrum-one/ETH
arbitrum-one/USDC
base/ETH
base/USDC
polygon/MATIC
polygon/USDC
optimism/ETH
optimism/USDC
USD value of the amount used to fund the transfer including fees.
A stringified number representing a crypto or fiat currency amount. This value may include minor units, the value of which will change depending on the currency.
Examples: 25
, 0.12
, 0.246810
, 5000.00
The currency code for the given value.
Fiat currencies:
fiat/USD
fiat/EUR
Crypto:
Crypto values are expressed as <chain>/<symbol>
.
bitcoin/BTC
ethereum/ETH
ethereum/USDC
solana/SOL
solana/USDC
arbitrum-one/ETH
arbitrum-one/USDC
base/ETH
base/USDC
polygon/MATIC
polygon/USDC
optimism/ETH
optimism/USDC
Details of the overall total amount (of crypto or fiat depending on the kind
) used to fund the transfer excluding fees.
A stringified number representing a crypto or fiat currency amount. This value may include minor units, the value of which will change depending on the currency.
Examples: 25
, 0.12
, 0.246810
, 5000.00
The currency code for the given value.
Fiat currencies:
fiat/USD
fiat/EUR
Crypto:
Crypto values are expressed as <chain>/<symbol>
.
bitcoin/BTC
ethereum/ETH
ethereum/USDC
solana/SOL
solana/USDC
arbitrum-one/ETH
arbitrum-one/USDC
base/ETH
base/USDC
polygon/MATIC
polygon/USDC
optimism/ETH
optimism/USDC
USD value of the amount used to fund the transfer, excluding fee.
A stringified number representing a crypto or fiat currency amount. This value may include minor units, the value of which will change depending on the currency.
Examples: 25
, 0.12
, 0.246810
, 5000.00
The currency code for the given value.
Fiat currencies:
fiat/USD
fiat/EUR
Crypto:
Crypto values are expressed as <chain>/<symbol>
.
bitcoin/BTC
ethereum/ETH
ethereum/USDC
solana/SOL
solana/USDC
arbitrum-one/ETH
arbitrum-one/USDC
base/ETH
base/USDC
polygon/MATIC
polygon/USDC
optimism/ETH
optimism/USDC
Details of the overall total amount (of crypto or fiat depending on the kind
) transferred including fees.
A stringified number representing a crypto or fiat currency amount. This value may include minor units, the value of which will change depending on the currency.
Examples: 25
, 0.12
, 0.246810
, 5000.00
The currency code for the given value.
Fiat currencies:
fiat/USD
fiat/EUR
Crypto:
Crypto values are expressed as <chain>/<symbol>
.
bitcoin/BTC
ethereum/ETH
ethereum/USDC
solana/SOL
solana/USDC
arbitrum-one/ETH
arbitrum-one/USDC
base/ETH
base/USDC
polygon/MATIC
polygon/USDC
optimism/ETH
optimism/USDC
USD value of the overall total amount transferred including fees.
A stringified number representing a crypto or fiat currency amount. This value may include minor units, the value of which will change depending on the currency.
Examples: 25
, 0.12
, 0.246810
, 5000.00
The currency code for the given value.
Fiat currencies:
fiat/USD
fiat/EUR
Crypto:
Crypto values are expressed as <chain>/<symbol>
.
bitcoin/BTC
ethereum/ETH
ethereum/USDC
solana/SOL
solana/USDC
arbitrum-one/ETH
arbitrum-one/USDC
base/ETH
base/USDC
polygon/MATIC
polygon/USDC
optimism/ETH
optimism/USDC
The type of the payment method used for the transfer.
debit
, apple_pay
A custom identifier provided at the time the transfer was created.
Note: external_id
is only available for transfers created using the Standalone integration.
The blockchain specific transaction identifier. This is useful for referencing the transfer on a blockchain explorer.
Note: network_transaction_id
will only be present if the transfer is complete
.
The wallet address used for the transfer.
Details of the Meso-fee included in the transfer (if applicable).
A stringified number representing a crypto or fiat currency amount. This value may include minor units, the value of which will change depending on the currency.
Examples: 25
, 0.12
, 0.246810
, 5000.00
The currency code for the given value.
Fiat currencies:
fiat/USD
fiat/EUR
Crypto:
Crypto values are expressed as <chain>/<symbol>
.
bitcoin/BTC
ethereum/ETH
ethereum/USDC
solana/SOL
solana/USDC
arbitrum-one/ETH
arbitrum-one/USDC
base/ETH
base/USDC
polygon/MATIC
polygon/USDC
optimism/ETH
optimism/USDC
USD value of the Meso-fee included in the transfer (if applicable).
A stringified number representing a crypto or fiat currency amount. This value may include minor units, the value of which will change depending on the currency.
Examples: 25
, 0.12
, 0.246810
, 5000.00
The currency code for the given value.
Fiat currencies:
fiat/USD
fiat/EUR
Crypto:
Crypto values are expressed as <chain>/<symbol>
.
bitcoin/BTC
ethereum/ETH
ethereum/USDC
solana/SOL
solana/USDC
arbitrum-one/ETH
arbitrum-one/USDC
base/ETH
base/USDC
polygon/MATIC
polygon/USDC
optimism/ETH
optimism/USDC
Details of the on-chain fees included in the transfer (if applicable).
A stringified number representing a crypto or fiat currency amount. This value may include minor units, the value of which will change depending on the currency.
Examples: 25
, 0.12
, 0.246810
, 5000.00
The currency code for the given value.
Fiat currencies:
fiat/USD
fiat/EUR
Crypto:
Crypto values are expressed as <chain>/<symbol>
.
bitcoin/BTC
ethereum/ETH
ethereum/USDC
solana/SOL
solana/USDC
arbitrum-one/ETH
arbitrum-one/USDC
base/ETH
base/USDC
polygon/MATIC
polygon/USDC
optimism/ETH
optimism/USDC
USD value of the on-chain fees included in the transfer (if applicable).
A stringified number representing a crypto or fiat currency amount. This value may include minor units, the value of which will change depending on the currency.
Examples: 25
, 0.12
, 0.246810
, 5000.00
The currency code for the given value.
Fiat currencies:
fiat/USD
fiat/EUR
Crypto:
Crypto values are expressed as <chain>/<symbol>
.
bitcoin/BTC
ethereum/ETH
ethereum/USDC
solana/SOL
solana/USDC
arbitrum-one/ETH
arbitrum-one/USDC
base/ETH
base/USDC
polygon/MATIC
polygon/USDC
optimism/ETH
optimism/USDC
curl --request GET \
--url https://api.sandbox.meso.network/v1/transfers/search \
--header 'Authorization: Basic <encoded-value>'
{
"results": [
{
"id": "t_001",
"external_id": "custom_id_001",
"kind": "cash_in",
"status": "executing",
"network_transaction_id": "37tQVLSyCY1X6iSFzrDwThnBuUWNbp84vby5BiKqUxC1VSN4XFyLGkNq843UFMZ27kXPzx4xnR8RExZPmDAsNJf4",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"source_total": {
"amount": "1.45",
"currency_code": "solana/SOL"
},
"source_total_usd": {
"amount": "1.45",
"currency_code": "solana/SOL"
},
"source_subtotal": {
"amount": "1.45",
"currency_code": "solana/SOL"
},
"source_subtotal_usd": {
"amount": "1.45",
"currency_code": "solana/SOL"
},
"destination_total": {
"amount": "1.45",
"currency_code": "solana/SOL"
},
"destination_total_usd": {
"amount": "1.45",
"currency_code": "solana/SOL"
},
"wallet_address": "3n2C45yBiNapKh6EdDekesZccAFdwTatu46Eyw1UnKx2",
"payment_method": "debit",
"meso_fee": {
"amount": "1.45",
"currency_code": "solana/SOL"
},
"meso_fee_usd": {
"amount": "1.45",
"currency_code": "solana/SOL"
},
"network_fee": {
"amount": "1.45",
"currency_code": "solana/SOL"
},
"network_fee_usd": {
"amount": "1.45",
"currency_code": "solana/SOL"
}
}
],
"page_info": {
"end_cursor": "<string>",
"has_next_page": true
}
}