Skip to main content

Postman Collection

Download the ready-made Postman collection to test the IB Partner API without any manual setup.

⬇ Download Postman Collection


What's included

The collection comes pre-configured with four variables so you can get started immediately:

VariableDefault valueDescription
baseUrlhttps://your-domain.comYour API base URL
apiKeyib_live_your_api_key_hereYour Partner API key
userIda1b2c3d4-0000-0000-0000-000000000000The user ID to look up
referenceIda1b2c3d4-0000-0000-0000-000000000000The deposit reference ID to check

How to use

  1. Download the collection file above.
  2. Open Postman → click Import → select the file.
  3. Go to Variables and update the variables with your real values:
    • baseUrl → your actual domain
    • apiKey → your Partner API key
    • userId → a real user ID to check
    • referenceId → a real deposit reference ID to check
  4. Run the Get User Status or Check Deposit request.

Included requests

Get User Status

Checks whether a user belongs to your IB.

  • Method: GET
  • URL: {{baseUrl}}/api/ib/user-status?user_id={{userId}}
  • Header: Authorization: Bearer {{apiKey}}

Check Deposit

Checks whether a child user's deposit has been executed and retrieves its amount.

  • Method: GET
  • URL: {{baseUrl}}/api/ib/deposit-check?reference_id={{referenceId}}
  • Header: Authorization: Bearer {{apiKey}}