Collections

Simulate a deposit

POST
/v1/collections/deposits/simulate

Simulate a deposit to one of your collection addresses, in the test environment only. Pulse runs the same checks as a live deposit and sends the same webhooks. The amount decides the outcome: below the minimum, the deposit is held.

The live environment returns 404.

Authorization

ApiKeyAuth
X-API-Key<token>

The API key identifies your business. Requests do not include a business ID.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/collections/deposits/simulate" \  -H "Content-Type: application/json" \  -d '{    "address": "0x64e6e8b84beb0ba8ab43a09d4b8a48aa23ecc394",    "asset": "USDT",    "network": "POLYGON",    "amount": "250"  }'
{  "status": true,  "data": {    "deposit_id": "0199d2c2-91f0-7b44-a6e3-0c8d5f2b7e19",    "collection_id": "0199d1b7-2a4c-7e58-b1d3-6f9a0c2e4b81",    "address": "0x64e6e8b84beb0ba8ab43a09d4b8a48aa23ecc394",    "asset": "USDT",    "network": "POLYGON",    "amount": "250",    "transaction_hash": "0x5e1d3c7a9b2f4e6d8a0c1b3e5f7a9d2c4e6b8a0d1f3c5e7a9b2d4f6e8a0c1b3e",    "from_address": "0x1f2e3d4c5b6a7f8e9d0c1b2a3f4e5d6c7b8a9f0e"  }}