Authorization

The Bulkpe API uses API keys to authenticate requests. You can view and manage your API keys in the Bulkpe Dashboard.

You can find your token key from your Bulkpe Web Dashboard -> Settings -> Developer Controls -> Copy API Key.

How to use the token

You need to pass the API Token in the headers with the key as 'Authorization' and the value as 'Bearer' (prefix) followed by your token.

Example:

If you receive the "You Don't Have Access" error, it means you are incorrectly or not passing the bearer token in the headers or if you have enabled IP whitelisting and you're calling the API from Non-Whitelisted IP. Please ensure that you are passing the token properly and calling the API from whitelsited IP (if enabled). You can refer to our Postman collection or the sample below for guidance:

Sample API Call

curl --location 'https://api.bulkpe.in/client/initiatepayout' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer aWSVQNytFlaQY87tnoB2dvdvdvdvddcvdvdvdvdvdvvdvdvvdvdvr9alnHA==' \ --data-raw '{ "amount": 1, "payment_mode": "UPI", "reference_id": "Internal1714458729", "transcation_note": "Payment", "upi": "rich@ybl", "beneficiaryName": "Richard" }'

Explanation:

--location: Specifies the URL of the API endpoint.
--header 'Content-Type: application/json': Specifies the content type of the request as JSON.
--header 'Authorization: Bearer aWSVQNytFlaQY87tnoB2dvdvdvdvddcvdvdvdvdvdvvdvdvvdvdvr9alnHA==': Passes the bearer token in the Authorization header. This token authorizes your request to access the API.
--data-raw: Specifies the data to be sent in the request body as raw JSON. In this example, we are initiating a payout with specific details like amount, payment mode, reference ID, transaction note, UPI ID, and beneficiary name.

Ensure that you replace the bearer token

(aWSVQNytFlaQY87tnoB2dvdvdvdvddcvdvdvdvdvdvvdvdvvdvdvr9alnHA==) with your actual bearer token for authentication.

Getting IP blacklisted?

If you encounter the following error message, it means that your IP address has been blocked. Here's why it happens and how you can resolve it:

Error message:

{ "message": "Your IP is blocked, please contact [email protected]" }

Our system blocks an IP address when it makes more than 3 bad requests, regardless of whether it's whitelisted. Bad authentication tokens and requests from non-whitelisted IPs are considered bad requests.

To remove your IP address from the blacklist, please send your IP address from your Bulkpe registered email to [email protected].

☝️

Are you testing via Postman Web?

If you're testing with Postman's web version and encounter this issue, please switch to using the Postman Local application (available for Windows or Mac).

Refer to this page to learn how to resolve the issue - LINK

Whitelist your IP addresses

We highly recommend you whitelist your IP addresses from the Developer Controls from the settings tab of your Bulkpe Web Dashboard. Bulkpe supports whitelisting multiple IP addresses.

Production Base URL

https://api.bulkpe.in/