Skip to main content
GET
/
v2
/
transfers
/
{transfer_id}
Get a Transfer
curl --request GET \
  --url https://api.dots.dev/api/v2/transfers/{transfer_id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123,
  "external_data": {
    "account_id": "<string>",
    "external_id": "<string>"
  },
  "transactions": [
    {
      "id": 123,
      "amount": 123,
      "created": "2023-11-07T05:31:56Z",
      "source_name": "<string>",
      "destination_name": "<string>",
      "metadata": "<string>"
    }
  ],
  "metadata": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://pearsdb.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
transfer_id
string<uuid>
required

Id of the transfer to fetch

Response

200 - application/json

OK

The transfer object.

​
id
string<uuid>
​
created
string<date-time>
​
user_id
string<uuid>
​
status
enum<string>
Available options:
created,
pending,
failed,
completed,
flagged
​
type
enum<string>
Available options:
refill,
payout,
balance
​
amount
number
​
external_data
object
​
transactions
object[]
​
metadata

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.