Collections
Give a user permanent deposit addresses and pay their stablecoin deposits out as NGN.
A collection gives one of your users permanent deposit addresses. Every USDT or USDC deposit converts to NGN and pays out to the bank account you choose. You need a test API key. There is no quote or order to create per payment.
Add a payout account
Register the bank account that receives the NGN. Pulse verifies it and returns the registered name.
curl https://engine-api.pilot.pulseshiga.io/v1/recipients \
-H "X-API-Key: <your key>" \
-H "Content-Type: application/json" \
-d '{
"type": "bank_account",
"is_default": true,
"bank_account": { "bank_code": "058", "account_number": "0123456789" }
}'Check data.bank_account.account_name before you use the account. Store data.id.
Create a collection
Set reference to your own ID for the user. Repeating it returns the same
collection.
curl https://engine-api.pilot.pulseshiga.io/v1/collections \
-H "X-API-Key: <your key>" \
-H "Content-Type: application/json" \
-d '{
"reference": "user-48213",
"recipient_id": "0199d1a4-…",
"customer": { "name": "Ada Obi", "email": "ada@example.com" }
}'Show the user every entry in data.deposit_addresses, with the networks each one
lists. The addresses never change.
Simulate a deposit
Test addresses cannot receive real crypto, so simulate one.
curl https://engine-api.pilot.pulseshiga.io/v1/collections/deposits/simulate \
-H "X-API-Key: <your key>" \
-H "Content-Type: application/json" \
-d '{
"address": "0x64e6e8b84beb0ba8ab43a09d4b8a48aa23ecc394",
"asset": "USDT",
"network": "POLYGON",
"amount": "250"
}'See Testing for the held outcomes.
Track the deposit
Each deposit becomes an offramp order. Consume webhooks: they carry your
collection reference, so you can match the deposit to your user. Stop at
order.completed, or handle order.held.
To list a collection's deposits, filter orders by collection_id:
curl "https://engine-api.pilot.pulseshiga.io/v1/orders?collection_id=0199d1b7-…" \
-H "X-API-Key: <your key>"See Collections for deposit limits, held deposits, and managing collections.