Deposit

Get address for receive funds

Get an address for receive cryptocurrency from someone

POST https://api.legranpay.io/v1/merchant/deposits/take

Headers

Name
Type
Description

X-MERCHANT-KEY*

String

You merchant key

X-MERCHANT-SIGNATURE*

String

You merchant secret key

Request Body

Name
Type
Description

foreignId*

String

Unique name to identify the issuer of the transactions.

For example: USER_991

currency*

String

Example: USDT

blockchain*

String

Unique name of blockchain. Check currency section for more information.

For example: POLYGON_MUMBAI

Success example
{
    "error": false,
    "data": {
        "currency": "USDT",
        "address": "0xb6f30d1ead83551fba23f03da5b1a37f1390f7a8",
        "tag": ""
    }
}
Failed example
{
    "error": true,
    "code": 1003,
    "message": "Invalid merchant or / and currency or / and blockchain"
}

Address object

Attribute
Type
Description

currency

String

Currency unique code

address

String

Wallet address

tag

Number (Optional)

Some currencies require the attribute tag

Possible errors

  • 500

  • 1003

  • 1016

Ping address

The ping call is very important because it is used to monitor a wallet, waiting to receive deposits during the next 30 minutes. Once the 30 minutes have passed or after first deposit, if you want to continue monitoring, you must repeat the call.

POST https://api.legranpay.io/v1/merchant/deposits/ping

Headers

Name
Type
Description

X-MERCHANT-KEY*

String

You merchant key

X-MERCHANT-SIGNATURE*

String

You merchant secret key

Request Body

Name
Type
Description

foreignId*

String

Unique name to identify the issuer of the transactions.

For example: USER_991

currency*

String

Example: USDT

blockchain*

String

Unique name of blockchain. Check currency section for more information.

For example: POLYGON_MUMBAI

Success example
{
    "error": false,
    "data": 1686661775 // Now timestamp (UTC)
}
Failed example
{
    "error": true,
    "code": 1004,
    "message": "Wallet not found"
}

Possible errors

  • 500

  • 1004

  • 1016

Last updated