P2P Linkdrop API Dev Portal

P2P Linkdrop API

Endpointhttps://escrow-api.linkdrop.io

Get fee

GET

https://escrow-api.linkdrop.io

/v3/:chain/fee

Return fees.

Get fee › path Parameters

chain

string · enum · required

Name of the chain

Enum values:

base

polygon

arbitrum

optimism

avalanche

Get fee › query Parameters

amount

string · required

The amount to transfer (string)

sender

string · required

The sender's information (string)

expiration

number · required

The expiration time (number)

token_type

string · required

The type of token (string)

transfer_id

string · required

The transfer ID (string)

token_address

string · required

The token address (string)

Get fee › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get fee › Responses

Successful response

success

boolean · required

amount

string · required

fee_token

string · required

fee_amount

string · required

total_amount

string · required

fee_authorization

string · required

min_transfer_amount

string · required

max_transfer_amount

string · required

min_transfer_amount_usd

string · required

max_transfer_amount_usd

string · required

pending_txs

number · required

Number of Linkdrop transactions stuck in the mempool

pending_blocks

number · required

Number of blocks the oldest pending transaction has been stuck in the mempool

pending_tx_submitted_at

number · required

UNIX timestamp when the oldest pending transaction was submitted for inclusion in the blockchain

pending_tx_submitted_bn

number · required

Block number when the transaction was submitted for inclusion in the blockchain

GET/v3/:chain/fee

curl --request GET \
  --url 'https://escrow-api.linkdrop.io/v3/:chain/fee?amount=%3Cstring%3E&sender=%3Cstring%3E&expiration=%3Cnumber%3E&token_type=%3Cstring%3E&transfer_id=%3Cstring%3E&token_address=%3Cstring%3E' \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "success": true,
  "amount": "1000",
  "fee_token": "0x6ff00b13b00d743ac03f9201417e2c4fd8883753",
  "fee_amount": "0",
  "total_amount": "1000",
  "fee_authorization": "0x6ff00b13b00d743ac03f9201417e2c4fd888375300e0e3a73e7d4226a34d834c98efec24987d84e9",
  "min_transfer_amount": "1000",
  "max_transfer_amount": "1000000",
  "min_transfer_amount_usd": "0.1",
  "max_transfer_amount_usd": "500",
  "pending_txs": 3,
  "pending_blocks": 5,
  "pending_tx_submitted_at": 1702924800,
  "pending_tx_submitted_bn": 15000000
}

json

application/json

Get limits

GET

https://escrow-api.linkdrop.io

/v3/:chain/limits

Get transfer limits for a token

Get limits › path Parameters

chain

string · enum · required

Name of the chain

Enum values:

base

polygon

arbitrum

optimism

avalanche

Get limits › query Parameters

token_address

string · required

Address of the token

token_type

string · enum · required

Type of the token

Enum values:

ERC20

NATIVE

Get limits › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get limits › Responses

Successful response

success

boolean · required

max_transfer_amount

string · required

min_transfer_amount

string · required

min_transfer_amount_usd

string · required

max_transfer_amount_usd

string · required

GET/v3/:chain/limits

curl --request GET \
  --url 'https://escrow-api.linkdrop.io/v3/:chain/limits?token_address=%3Cstring%3E&token_type=%3Cstring%3E' \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "success": true,
  "max_transfer_amount": "23000000000",
  "min_transfer_amount": "1300",
  "min_transfer_amount_usd": "0.1",
  "max_transfer_amount_usd": "500"
}

json

application/json

Deposit

POST

https://escrow-api.linkdrop.io

/v3/:chain/deposit

Endpoint for depositing tokens.

Deposit › path Parameters

chain

string · enum · required

Name of the chain

Enum values:

base

polygon

arbitrum

optimism

avalanche

Deposit › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Deposit › Request Body

sender

string · required

Address of sender

token

string · required

Address of token contract

token_type

string · enum · required

ERC20 or NATIVE

Enum values:

ERC20

NATIVE

escrow

string · required

Escrow contract address

transfer_id

string · required

Transfer ID

expiration

number · required

Expiration timestamp

amount

string · required

Deposit amount

tx_hash

string · required

Transaction hash

total_amount

string · required

Deposit amount including fees

fee_amount

string · required

Deposit fee amount

fee_authorization

string · required

Deposit fee authorization

fee_token

string · required

Fee token

transaction_type

string · enum · required

Type of transaction. 'tx' by default

Enum values:

userOp

encrypted_sender_message

string

Encrypted message, added by the sender

Deposit › Responses

Successful response

success

boolean · required

Indicates if the operation was successful

POST/v3/:chain/deposit

curl --request POST \
  --url https://escrow-api.linkdrop.io/v3/:chain/deposit \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sender": "0x51a58a68d51178cb6f95e4f3a1f8ab0b778ad7c7",
  "token": "0x442c159a466670ba40fdd1d198c1a9b84305c2a9",
  "token_type": "ERC20",
  "escrow": "0xfcf6edc2b74d83bcc40956561b1ad50ec776f4da",
  "transfer_id": "0xd82706d6728b09ad9b2afda341869923d41c6104",
  "expiration": 1708074180,
  "amount": "1000",
  "tx_hash": "0x5d93686dabcc655166d6cf4b8061e8be6aba108397361d00a0faa01d5a47a6e8297f2c2288150e46",
  "total_amount": "1000",
  "fee_amount": "0",
  "fee_authorization": "0xd522215e048dd77b54cd86b576f9e6a9bdf5a6798f20000b22fa861b24be11a72da1c9bad7c287d0",
  "fee_token": "0xcb7e4c708c31ee3f73ba33ba9ffd02afdf659cc0",
  "encrypted_sender_message": "cb7e4c708c31ee3f73ba33ba9ffd02afdf659cc0",
  "transaction_type": "tx"
}
'

shell

Example Request Body

{
  "sender": "0x51a58a68d51178cb6f95e4f3a1f8ab0b778ad7c7",
  "token": "0x442c159a466670ba40fdd1d198c1a9b84305c2a9",
  "token_type": "ERC20",
  "escrow": "0xfcf6edc2b74d83bcc40956561b1ad50ec776f4da",
  "transfer_id": "0xd82706d6728b09ad9b2afda341869923d41c6104",
  "expiration": 1708074180,
  "amount": "1000",
  "tx_hash": "0x5d93686dabcc655166d6cf4b8061e8be6aba108397361d00a0faa01d5a47a6e8297f2c2288150e46",
  "total_amount": "1000",
  "fee_amount": "0",
  "fee_authorization": "0xd522215e048dd77b54cd86b576f9e6a9bdf5a6798f20000b22fa861b24be11a72da1c9bad7c287d0",
  "fee_token": "0xcb7e4c708c31ee3f73ba33ba9ffd02afdf659cc0",
  "encrypted_sender_message": "cb7e4c708c31ee3f73ba33ba9ffd02afdf659cc0",
  "transaction_type": "tx"
}

json

Example Responses

{
  "success": true
}

json

application/json

Deposit with authorization

POST

https://escrow-api.linkdrop.io

/v3/:chain/deposit-with-authorization

Deposit tokens with authorization

Deposit with authorization › path Parameters

chain

string · enum · required

Name of the chain

Enum values:

base

polygon

arbitrum

optimism

avalanche

Deposit with authorization › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Deposit with authorization › Request Body

sender

string · required

Address of the sender

token

string · required

Address of the token contract

token_type

string · enum · required

Type of token - ERC20 or NATIVE

Enum values:

ERC20

NATIVE

escrow

string · required

Address of the escrow contract

transfer_id

string · required

Transfer ID

expiration

number · required

Timestamp indicating expiration of deposit

amount

string · required

Transfer amount

authorization

string · required

Deposit authorization

authorization_selector

string · enum · required

Authorization selector

Enum values:

0xe1560fd3

0xef55bec6

total_amount

string · required

Deposit amount including fees

fee_amount

string · required

Deposit fee amount

fee_authorization

string · required

Deposit fee authorization

encrypted_sender_message

string

Encrypted message, added by the sender

Deposit with authorization › Responses

Successful transfer initiation

success

boolean · required

Indicates if the transfer was successful

tx_hash

string · required

Transaction hash of the initiated transfer

POST/v3/:chain/deposit-with-authorization

curl --request POST \
  --url https://escrow-api.linkdrop.io/v3/:chain/deposit-with-authorization \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sender": "0x51a58a68d51178cb6f95e4f3a1f8ab0b778ad7c7",
  "token": "0x9e761dd3560ea87bd93d299165eea6f339351cfc",
  "token_type": "ERC20",
  "escrow": "0xb8a1463a728d582e870fe629fef00d5f549c0385",
  "transfer_id": "0x8214d9b3b4a46eb80c46db51498134b282fdf7f1",
  "expiration": 1708074180,
  "amount": "1000",
  "authorization": "0x1c8aaac29345291cd71c41ea191dcd3d48f9b8e48809429e7aff9fb9a6dc1517b48a4cf95f12cfc7",
  "authorization_selector": "0xe1560fd3",
  "total_amount": "1000",
  "fee_amount": "0",
  "fee_authorization": "0xd522215e048dd77b54cd86b576f9e6a9bdf5a6798f20000b22fa861b24be11a72da1c9bad7c287d0",
  "encrypted_sender_message": "cb7e4c708c31ee3f73ba33ba9ffd02afdf659cc0"
}
'

shell

Example Request Body

{
  "sender": "0x51a58a68d51178cb6f95e4f3a1f8ab0b778ad7c7",
  "token": "0x9e761dd3560ea87bd93d299165eea6f339351cfc",
  "token_type": "ERC20",
  "escrow": "0xb8a1463a728d582e870fe629fef00d5f549c0385",
  "transfer_id": "0x8214d9b3b4a46eb80c46db51498134b282fdf7f1",
  "expiration": 1708074180,
  "amount": "1000",
  "authorization": "0x1c8aaac29345291cd71c41ea191dcd3d48f9b8e48809429e7aff9fb9a6dc1517b48a4cf95f12cfc7",
  "authorization_selector": "0xe1560fd3",
  "total_amount": "1000",
  "fee_amount": "0",
  "fee_authorization": "0xd522215e048dd77b54cd86b576f9e6a9bdf5a6798f20000b22fa861b24be11a72da1c9bad7c287d0",
  "encrypted_sender_message": "cb7e4c708c31ee3f73ba33ba9ffd02afdf659cc0"
}

json

Example Responses

{
  "success": true,
  "tx_hash": "0x808bf674252fcb0c5def3580c71a62b1f306e32887b2a14a232bc5ebd3dc2c2bf6c27125f640e082"
}

json

application/json

Redeem

POST

https://escrow-api.linkdrop.io

/v3/:chain/redeem

Redeem tokens

Redeem › path Parameters

chain

string · enum · required

Name of the chain

Enum values:

base

polygon

arbitrum

optimism

avalanche

Redeem › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Redeem › Request Body

receiver

string · required

Address of receiver

sender

string · required

Address of sender

escrow

string · required

Escrow contract address

transfer_id

string · required

Transfer ID

receiver_sig

string · required

Receiver's signature

token

string · required

Address of token contract

Redeem › Responses

Redeem successful

success

boolean · required

Indicates if the transfer was successful

tx_hash

string · required

Hash of the transaction

POST/v3/:chain/redeem

curl --request POST \
  --url https://escrow-api.linkdrop.io/v3/:chain/redeem \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "receiver": "0x9135117490f360a7c4d34cfdf64133af642def13",
  "sender": "0x9a07a8ab25798b60b425eca2feebfa09d6f6a426",
  "escrow": "0x5201e0854452be2407a81f1e35b371666edb787b",
  "transfer_id": "31a4164d40f275880f60232f24cbd1d00616ea76",
  "receiver_sig": "0x1f352047cf8c78be1707422918f7965f560c907c9a07a8ab25798b60b425eca2feebfa09d6f6a4269135117490f360a7c4d34cfdf64133af642def13",
  "token": "0xcb7e4c708c31ee3f73ba33ba9ffd02afdf659cc0"
}
'

shell

Example Request Body

{
  "receiver": "0x9135117490f360a7c4d34cfdf64133af642def13",
  "sender": "0x9a07a8ab25798b60b425eca2feebfa09d6f6a426",
  "escrow": "0x5201e0854452be2407a81f1e35b371666edb787b",
  "transfer_id": "31a4164d40f275880f60232f24cbd1d00616ea76",
  "receiver_sig": "0x1f352047cf8c78be1707422918f7965f560c907c9a07a8ab25798b60b425eca2feebfa09d6f6a4269135117490f360a7c4d34cfdf64133af642def13",
  "token": "0xcb7e4c708c31ee3f73ba33ba9ffd02afdf659cc0"
}

json

Example Responses

{
  "success": true,
  "tx_hash": "0xc8779c8102df08008619dc3744ac13426b743debb774696ffc8074ca0f391a79ce05735080d6f14d"
}

json

application/json

Redeem recovered

POST

https://escrow-api.linkdrop.io

/v3/:chain/redeem-recovered

Redeems tokens from recovered link.

Redeem recovered › path Parameters

chain

string · enum · required

Name of the chain

Enum values:

base

polygon

arbitrum

optimism

avalanche

Redeem recovered › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Redeem recovered › Request Body

receiver

string · required

Address of the receiver

sender

string · required

Address of the sender

escrow

string · required

Escrow contract address

transfer_id

string · required

Transfer ID

receiver_sig

string · required

Receiver's signature

sender_sig

string · required

Sender's signature

token

string · required

Address of token contract

Redeem recovered › Responses

Transaction submitted successfully

success

boolean · required

Indicates if the transaction was successful

tx_hash

string · required

Transaction hash

POST/v3/:chain/redeem-recovered

curl --request POST \
  --url https://escrow-api.linkdrop.io/v3/:chain/redeem-recovered \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "receiver": "0xa834b97e683cff4d0ef406037a500b5f97547dae",
  "sender": "0xd66f7a3fae8d1c20fe08155991510d9b0003832b",
  "escrow": "0xc25070972d71662a3e2d28490b7a0d016e1e0fab",
  "transfer_id": "0xe52b273170b91fb25c540e91fa25f2abed504812",
  "receiver_sig": "0x59fe681d9593935854a2d9da1742eaac9dafcddee13dfc88d35896014037ab3d1c58072663d3e9888f49f5429251779cfe1959bdaa9a56e1bd01e3b67123456789",
  "sender_sig": "0x3c69d6fa851a87a5d69b3ec8d186c9a72164024688d51271ccbe0c0a873419a42ca8a6cd7a839408b05fd8e8c8d5e4d550b4a762b5314270d2bb39136123456789",
  "token": "0xf5dc97ff4c583d73b1ec44f08dc7106be01f3bc0"
}
'

shell

Example Request Body

{
  "receiver": "0xa834b97e683cff4d0ef406037a500b5f97547dae",
  "sender": "0xd66f7a3fae8d1c20fe08155991510d9b0003832b",
  "escrow": "0xc25070972d71662a3e2d28490b7a0d016e1e0fab",
  "transfer_id": "0xe52b273170b91fb25c540e91fa25f2abed504812",
  "receiver_sig": "0x59fe681d9593935854a2d9da1742eaac9dafcddee13dfc88d35896014037ab3d1c58072663d3e9888f49f5429251779cfe1959bdaa9a56e1bd01e3b67123456789",
  "sender_sig": "0x3c69d6fa851a87a5d69b3ec8d186c9a72164024688d51271ccbe0c0a873419a42ca8a6cd7a839408b05fd8e8c8d5e4d550b4a762b5314270d2bb39136123456789",
  "token": "0xf5dc97ff4c583d73b1ec44f08dc7106be01f3bc0"
}

json

Example Responses

{
  "success": true,
  "tx_hash": "0x430d7788ac92e3f8009f5164e2ba5a67724e1c9ec93fd9827042d20123456789"
}

json

application/json

Get payment status by transfer id

GET

https://escrow-api.linkdrop.io

/v3/:chain/payment-status/transfer/:transfer_id

Get payment status by transfer id.

Get payment status by transfer id › path Parameters

chain

string · enum · required

Name of the chain

Enum values:

base

polygon

arbitrum

optimism

avalanche

transfer_id

string · required

ID of the transfer

Get payment status by transfer id › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get payment status by transfer id › Responses

Successful response

success

boolean · required

object · required

GET/v3/:chain/payment-status/transfer/:transfer_id

curl --request GET \
  --url https://escrow-api.linkdrop.io/v3/:chain/payment-status/transfer/:transfer_id \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "success": true,
  "claim_link": {
    "transfer_id": "0xe52b273170b91fb25c540e91fa25f2abed504812",
    "amount": "100",
    "fee_amount": "0",
    "total_amount": "100",
    "token": "0xc25070972d71662a3e2d28490b7a0d016e1e0fab",
    "fee_token": "0xd66f7a3fae8d1c20fe08155991510d9b0003832b",
    "chain_id": "137",
    "sender": "0xa834b97e683cff4d0ef406037a500b5f97547dae",
    "expiration": 1645099200,
    "token_type": "ERC20",
    "escrow": "0xdfaa19821c37ca0c7caedf735d24ff9e75f3d10c",
    "version": "3",
    "status": "deposited",
    "encrypted_sender_message": "cb7e4c708c31ee3f73ba33ba9ffd02afdf659cc0",
    "operations": [
      {
        "type": "deposit",
        "timestamp": "1645099200",
        "tx_hash": "0x247be3043de2ed139cd50a826b92b73af0618650dfaa19821c37ca0c7caedf735d24ff9e75f3d10c",
        "status": "completed",
        "receiver": "0xa834b97e683cff4d0ef406037a500b5f97547dae"
      }
    ]
  }
}

json

application/json

Get payment status by tx hash

GET

https://escrow-api.linkdrop.io

/v3/:chain/payment-status/transaction/:tx_hash

Retrieves information about a claim using the provided transaction hash

Get payment status by tx hash › path Parameters

chain

string · enum · required

Name of the chain

Enum values:

base

polygon

arbitrum

optimism

avalanche

tx_hash

string · required

Transaction hash

Get payment status by tx hash › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get payment status by tx hash › Responses

Successful operation

success

boolean · required

object · required

GET/v3/:chain/payment-status/transaction/:tx_hash

curl --request GET \
  --url https://escrow-api.linkdrop.io/v3/:chain/payment-status/transaction/:tx_hash \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "success": true,
  "claim_link": {
    "transfer_id": "0xc25070972d71662a3e2d28490b7a0d016e1e0fab",
    "amount": "100",
    "fee_amount": "0",
    "total_amount": "100",
    "fee_token": "0xd66f7a3fae8d1c20fe08155991510d9b0003832b",
    "token": "0xa834b97e683cff4d0ef406037a500b5f97547dae",
    "chain_id": "137",
    "sender": "0xdfaa19821c37ca0c7caedf735d24ff9e75f3d10c",
    "expiration": 4925669300,
    "token_type": "ERC20",
    "escrow": "0xa834b97e683cff4d0ef406037a500b5f97547dae",
    "version": "3",
    "status": "deposited",
    "encrypted_sender_message": "cb7e4c708c31ee3f73ba33ba9ffd02afdf659cc0",
    "operations": [
      {
        "type": "deposit",
        "timestamp": "4925669300",
        "tx_hash": "0x430d7788ac92e3f8009f5164e2ba5a67724e1c9ec93fd9827042d20123456789",
        "status": "completed",
        "receiver": "0xc25070972d71662a3e2d28490b7a0d016e1e0fab"
      }
    ]
  }
}

json

application/json

Get payment status by user operation hash

GET

https://escrow-api.linkdrop.io

/v3/:chain/payment-status/user-operation/:user_op_hash

Retrieves information about a claim using the provided user operation hash

Get payment status by user operation hash › path Parameters

chain

string · enum · required

Name of the chain

Enum values:

base

polygon

arbitrum

optimism

avalanche

user_op_hash

string · required

User operation hash

Get payment status by user operation hash › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get payment status by user operation hash › Responses

Successful operation

success

boolean · required

object · required

GET/v3/:chain/payment-status/user-operation/:user_op_hash

curl --request GET \
  --url https://escrow-api.linkdrop.io/v3/:chain/payment-status/user-operation/:user_op_hash \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "success": true,
  "claim_link": {
    "transfer_id": "0xc25070972d71662a3e2d28490b7a0d016e1e0fab",
    "amount": "100",
    "fee_amount": "0",
    "total_amount": "100",
    "fee_token": "0xd66f7a3fae8d1c20fe08155991510d9b0003832b",
    "token": "0xa834b97e683cff4d0ef406037a500b5f97547dae",
    "chain_id": "137",
    "sender": "0xdfaa19821c37ca0c7caedf735d24ff9e75f3d10c",
    "expiration": 4925669300,
    "token_type": "ERC20",
    "escrow": "0xa834b97e683cff4d0ef406037a500b5f97547dae",
    "version": "3",
    "status": "deposited",
    "encrypted_sender_message": "cb7e4c708c31ee3f73ba33ba9ffd02afdf659cc0",
    "operations": [
      {
        "type": "deposit",
        "timestamp": "4925669300",
        "tx_hash": "0x430d7788ac92e3f8009f5164e2ba5a67724e1c9ec93fd9827042d20123456789",
        "status": "completed",
        "receiver": "0xc25070972d71662a3e2d28490b7a0d016e1e0fab"
      }
    ]
  }
}

json

application/json

Get sender history

GET

https://escrow-api.linkdrop.io

/v3/:chain/payment-status/sender/:sender/get-sender-history

Get sender history by sender address

Get sender history › path Parameters

chain

string · enum · required

Chain name

Enum values:

base

polygon

arbitrum

optimism

avalanche

sender

string · required

Sender's ID

Get sender history › query Parameters

only_active

boolean

Filter by active status

offset

integer

Offset for pagination

limit

integer

Limit for pagination

Get sender history › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get sender history › Responses

Successful response

success

boolean · required

Flag indicating the success of the request.

object · required

object[] · required

GET/v3/:chain/payment-status/sender/:sender/get-sender-history

curl --request GET \
  --url https://escrow-api.linkdrop.io/v3/:chain/payment-status/sender/:sender/get-sender-history \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "success": true,
  "result_set": {
    "total": 100,
    "count": 10,
    "offset": 0
  },
  "claim_links": [
    {
      "transfer_id": "0xa834b97e683cff4d0ef406037a500b5f97547dae",
      "amount": "10",
      "fee_amount": "0",
      "total_amount": "10",
      "fee_token": "0xa834b97e683cff4d0ef406037a500b5f97547dae",
      "token": "0xd66f7a3fae8d1c20fe08155991510d9b0003832b",
      "chain_id": 137,
      "sender": "0xc25070972d71662a3e2d28490b7a0d016e1e0fab",
      "expiration": 1672723490,
      "token_type": "ERC20",
      "escrow": "0xc25070972d71662a3e2d28490b7a0d016e1e0fab",
      "version": "3",
      "status": "deposited",
      "operations": [
        {
          "type": "deposit",
          "timestamp": "2024-02-21T12:00:00Z",
          "tx_hash": "0x430d7788ac92e3f8009f5164e2ba5a67724e1c9ec93fd9827042d20123456789",
          "status": "completed",
          "receiver": "0xe52b273170b91fb25c540e91fa25f2abed504812"
        }
      ]
    }
  ]
}

json

application/json

Get dashboard link status

GET

https://escrow-api.linkdrop.io

/:server/payment-status/transfer/:transfer_id

Retrieve transfer data for claim links generated via Linkdrop dashboard.

Get dashboard link status › path Parameters

server

string · enum · required

Name of the server

Enum values:

dashboard

transfer_id

string · required

Transfer ID

Get dashboard link status › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get dashboard link status › Responses

Successful response

success

boolean · required

object · required

GET/:server/payment-status/transfer/:transfer_id

curl --request GET \
  --url https://escrow-api.linkdrop.io/:server/payment-status/transfer/:transfer_id \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "success": true,
  "claim_link": {
    "transfer_id": "0xe52b273170b91fb25c540e91fa25f2abed504812",
    "amount": "100",
    "fee_amount": "0",
    "total_amount": "100",
    "token": "0xc25070972d71662a3e2d28490b7a0d016e1e0fab",
    "fee_token": "0xd66f7a3fae8d1c20fe08155991510d9b0003832b",
    "chain_id": "137",
    "sender": "0xa834b97e683cff4d0ef406037a500b5f97547dae",
    "expiration": 1645099200,
    "token_type": "ERC20",
    "escrow": "0xdfaa19821c37ca0c7caedf735d24ff9e75f3d10c",
    "version": "3",
    "status": "deposited",
    "operations": [
      {
        "type": "deposit",
        "timestamp": "1645099200",
        "tx_hash": "0x247be3043de2ed139cd50a826b92b73af0618650dfaa19821c37ca0c7caedf735d24ff9e75f3d10c",
        "status": "completed",
        "receiver": "0xa834b97e683cff4d0ef406037a500b5f97547dae"
      }
    ]
  }
}

json

application/json

Redeem dashboard link

POST

https://escrow-api.linkdrop.io

/:server/redeem

Redeem tokens for links generated via Linkdrop Dashboard.

Redeem dashboard link › path Parameters

server

string · enum · required

Name of the chain

Enum values:

dashboard

Redeem dashboard link › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Redeem dashboard link › Request Body

receiver

string · required

Address of receiver

sender

string · required

Address of sender

escrow

string · required

Escrow contract address

transfer_id

string · required

Transfer ID

receiver_sig

string · required

Receiver's signature

token

string · required

Address of token contract

Redeem dashboard link › Responses

Redeem successful

success

boolean · required

Indicates if the transfer was successful

tx_hash

string · required

Hash of the transaction

POST/:server/redeem

curl --request POST \
  --url https://escrow-api.linkdrop.io/:server/redeem \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "receiver": "0x9135117490f360a7c4d34cfdf64133af642def13",
  "sender": "0x9a07a8ab25798b60b425eca2feebfa09d6f6a426",
  "escrow": "0x5201e0854452be2407a81f1e35b371666edb787b",
  "transfer_id": "31a4164d40f275880f60232f24cbd1d00616ea76",
  "receiver_sig": "0x1f352047cf8c78be1707422918f7965f560c907c9a07a8ab25798b60b425eca2feebfa09d6f6a4269135117490f360a7c4d34cfdf64133af642def13",
  "token": "0xcb7e4c708c31ee3f73ba33ba9ffd02afdf659cc0"
}
'

shell

Example Request Body

{
  "receiver": "0x9135117490f360a7c4d34cfdf64133af642def13",
  "sender": "0x9a07a8ab25798b60b425eca2feebfa09d6f6a426",
  "escrow": "0x5201e0854452be2407a81f1e35b371666edb787b",
  "transfer_id": "31a4164d40f275880f60232f24cbd1d00616ea76",
  "receiver_sig": "0x1f352047cf8c78be1707422918f7965f560c907c9a07a8ab25798b60b425eca2feebfa09d6f6a4269135117490f360a7c4d34cfdf64133af642def13",
  "token": "0xcb7e4c708c31ee3f73ba33ba9ffd02afdf659cc0"
}

json

Example Responses

{
  "success": true,
  "tx_hash": "0xc8779c8102df08008619dc3744ac13426b743debb774696ffc8074ca0f391a79ce05735080d6f14d"
}

json

application/json

Get redeemed deposits report

GET

https://escrow-api.linkdrop.io

/v3/:chain/report/redeemed-deposits

Retrieve info about redeemed deposits.

Get redeemed deposits report › path Parameters

chain

string · enum · required

Chain name

Enum values:

base

polygon

arbitrum

optimism

avalanche

Get redeemed deposits report › query Parameters

redeem_blocknumber_from

number

Filter deposits that have been redeemed and are greater than the specified block number.

offset

integer

Offset for pagination. 0 by default

limit

integer

Limit for pagination. 100 by default

Get redeemed deposits report › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get redeemed deposits report › Responses

Successful response

success

boolean · required

Flag indicating the success of the request.

object · required

object[] · required

GET/v3/:chain/report/redeemed-deposits

curl --request GET \
  --url https://escrow-api.linkdrop.io/v3/:chain/report/redeemed-deposits \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "success": true,
  "result_set": {
    "total": 100,
    "count": 10,
    "offset": 0
  },
  "redeemed_deposits": [
    {
      "sender": "0xe7f2fa3df0d9b2ef3e2f76a8558b175986a20e2f",
      "deposit_tx": "0x48e12d8c3ed08afee522e6865190f36d7357441958f8f263330bf95f3e4f8084",
      "deposit_timestamp": "2024-08-25T15:00:00Z",
      "amount": "10000000000000000",
      "token": "0x0000000000000000000000000000000000000000",
      "token_type": "NATIVE",
      "receiver": "0xe7f2fa3df0d9b2ef3e2f76a8558b175986a20e2f",
      "redeem_tx": "0x3669c3719b20b71e112a4a8a67377e51d1b8ca6b6d13169e4d44aaa6675d8775",
      "redeem_tx_blocknumber": 43560515,
      "redeem_timestamp": "2024-08-25T15:00:00Z",
      "amount_formatted": "0.01",
      "token_symbol": "USDC"
    }
  ]
}

json

application/json

Get links count by sender

GET

https://escrow-api.linkdrop.io

/v3/:chain/report/sender/:sender/links-count

Returns counts retrieved based on status, token, and sender.

Get links count by sender › path Parameters

chain

string · enum · required

Chain name

Enum values:

base

polygon

arbitrum

optimism

avalanche

sender

string · required

Sender address

Get links count by sender › query Parameters

token

string

Token address

Get links count by sender › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get links count by sender › Responses

Successful response

success

boolean · required

Flag indicating the success of the request.

deposited

number · required

Count of deposited links.

redeemed

number · required

Count of redeemed links.

refunded

number · required

Count of refunded links.

total

number · required

Total number of results.

GET/v3/:chain/report/sender/:sender/links-count

curl --request GET \
  --url https://escrow-api.linkdrop.io/v3/:chain/report/sender/:sender/links-count \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "success": true,
  "deposited": 10,
  "redeemed": 5,
  "refunded": 2,
  "total": 17
}

json

application/json